theking2 / db-fw Goto Github PK

1.0 1.0 0.0 265 KB

PHP 72.89% CSS 2.99% HTML 11.39% JavaScript 12.73%

db-fw's Introduction

Projects application and api

Configuration

Database configuration in /classes/DB/Database.php

Discovery

Visiting /discover will get all the tables and views in the configured database and create php files in /discover/src. these should be moved to the /classes folder in the proper namespace. If new entities or views are added make sure to add them to api/index.php to enable access

API

The api is accessible using a redirect to /api/index.php, parameter . With the .htaccess when accessing a non existing file or folder it will redirect the path to `/api/index.php``

Request methods allowed: GET, POST, PUT, DELETE, OPTIONS

The api has the following endpoints: GET: /api/index.php/<endpoint>[/\<id>]

returns a list of all entries in the database or a single object

GET: /api/index.php/\<endpoint>?\<query>

query is a key=value pair wildcards allowed, e.g. ?Name=foo or ?Name=foo&Age=42 or ?Name=foo*
returns a list of all entries in the database or a single object
Payload ignored

POST: /api/index.php/<endpoint>[/\<id>]

creates a new entry in the database
Payload should contain complete object

PUT: /api/index.php/<endpoint>

updates an existing entry in the database
Payload can contain a partial object

DELETE: /api/index.php/<endpoint>[/\<id>]

deletes an entry from the database
payload ignored

Payload: JSON Response: JSON array or JSON object or JSON object or error message

db-fw's People

Contributors

Stargazers

Watchers

db-fw's Issues

Bug on doPut test

Uncaught Error: Object of class DateTime could not be converted to string in D:\Projekten\dw-fw\classes\DB\PersistTrait.php:553

NULL values are converted to 0 for float

The should throw an error

better error handling in API

Enhance 500 error message with information from exceptions. Most error are due to typos in fields or filter.

Add PHP Doc for created classes

For ease of programming add php doc for all properties.

Do not convert DateTime values

The setter now accepts null and string (when set from sql results) but it could also be a \DateTime in which case nothing has to be converted.

add getJson createFromJson to PersistInterface

These are part of contract

Decode url search parameters

split persisten trait

one for CRUD (freeze/thaw/update/delete)
and one for iteratator findFirst/-Next, Where and Iterator functions.

Allow password types

These should be converted with password_hash(). Add a function to do password_verify(). When searching for a user/pass combination.

Hash function is a class variable.

for diagnostic data create one createResponse method

Containing a int backed enum with all possible 400-599 responses.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Status

https://github.com/symfony/http-foundation/blob/6.2/Response.php

Add trait to format JSON

create a json string of the current record. preferable als second trait.

Add rest for search function

doGet /test/Name='Aaa'

as $Name = "*Aaa"

add simple rest api get

Multi column keys

Keys currently are single columns.

Vacation fields not consistent in VacationView

{
"ID":1,
"VacationType":"Kompensation",
"StudentID":4,
"Fullname":"Juliette Boulatova",
"FromDate":"2022-07-03 10:21:37",
"toDate":"2022-07-07 10:21:37"}

add config file

Database connection
Default namespace for discovered classes

change Start/End to dateFrom dateTo

in reservation, vacation and tasks?
needs database change

float is not recognized

Problem is the regexp. /(.)((.))/

persist abstract class

make persist an abstract class
implement the db dependent imp as trait DBPersist

error in constructor

[08-Apr-2022 07:01:34 UTC] PHP Fatal error: Uncaught Error: Call to a member function setFetchMode() on bool in D:\Projekte\pm\classes\DB\PersistTrait.php:161
Stack trace:
#0 D:\Projekte\pm\classes\DB\PersistTrait.php(562): NeueMedien\test->thaw(1)
#1 D:\Projekte\pm\api\index.php(139): NeueMedien\test->__construct(1)
#2 D:\Projekte\pm\api\index.php(25): NeueMedien\doDelete(Array)
#3 {main}
thrown in D:\Projekte\pm\classes\DB\PersistTrait.php on line 161

list of allowed routes.

Flexible REST parameters

https://www.moesif.com/blog/technical/api-design/REST-API-Design-Filtering-Sorting-and-Pagination/

student?name=[like]*a*&lg=[gte]2021

[eq] or none = exact match
[gt] greater
[gte] greater or equal
[lt] lower
[lte] lower or equal
[like] like with * als joker

help text missing on admin_show_overview.php

<div id="help-text">
<h1>ADMIN - Hilfe<span id="help-text-close"></span></h1>
<p>Hilfe Text für Admin Report</p>
</div>

Feature add Time to DateTime

Currently on Y-m-d is supported; add Y-m-d H:m:s support

test for freeze

freeze is not finished yet