https://github.com/cathedralcode/db
Database Layer interfaces and classes (runtime).
https://github.com/cathedralcode/db
Last synced: 12 months ago
JSON representation
Database Layer interfaces and classes (runtime).
- Host: GitHub
- URL: https://github.com/cathedralcode/db
- Owner: CathedralCode
- License: unlicense
- Created: 2021-12-03T13:28:56.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-05-25T20:22:31.000Z (about 3 years ago)
- Last Synced: 2025-05-06T17:48:31.708Z (about 1 year ago)
- Language: PHP
- Size: 85 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
# Cathedral\Db
> $Id$ ($Date$)
Database class for use with builder and its generated code.
## Custom methods
There are a few custom methods you can create to easily modify your data before sending it to client.
- customQueryOptions
- runs prior to data access
- lets you modify where clauses
- check query string values
- customResponseOptions
- runs last, just prior to sending data
- has full access to the json response object
- getListPost
- runs after data fetched from db
- createPre
- check data before db record gets created
```php
/**
* Gets the query string parameters for pagination
*
* @param array $options
* @param array $params
*
* @return void
*/
public function customQueryOptions(&$options, $params): void {
if (isset($params['fk_champions'])) $options['where']['fk_champions'] = intval($params['fk_champions']);
}
/**
* Gets the query string parameters for pagination
*
* @param mixed $json
* @return void
*/
public function customResponseOptions(&$json): void {
/** @var JsonModel $json */
$payload = $json->getVariable('payload');
for ($i = 0; $i < \count($payload); $i++) $payload[$i]['champion'] = $this->_champions[$payload[$i]['fk_champions']];
$json->setVariable('extra', ['champions' => $this->_champions]);
$json->setVariable('payload', $payload);
}
/**
* Modify the resultset
*
* @param mixed $data
* @return void
*/
public function getListPost($data): void {
$data->buffer();
foreach($data as $d) $this->_champions[$d->Champion()->id] = $d->Champion()->name;
}
/**
* Check data before creating record
*
* @param mixed $data
* @return null|string error
*/
public function createPre(&$data): ?string {
// check data
return null;
}
```
## Auth configurations
...