mirror of
https://codeberg.org/vlw/scaffold.git
synced 2026-01-11 22:16:00 +01:00
feat: add database controller for manipulating entity data
This commit is contained in:
parent
d9fca6d4e1
commit
2c2bc87041
2 changed files with 126 additions and 10 deletions
115
src/Database/Controller.php
Normal file
115
src/Database/Controller.php
Normal file
|
|
@ -0,0 +1,115 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace vlw\Scaffold\Database;
|
||||||
|
|
||||||
|
use ReflectionClass;
|
||||||
|
use ReflectionProperty;
|
||||||
|
use ReflectionNamedType;
|
||||||
|
use ReflectionUnionType;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Modify database entity values using an instanced database Model
|
||||||
|
*/
|
||||||
|
class Controller {
|
||||||
|
/**
|
||||||
|
* Returns an array of allowed property types
|
||||||
|
*
|
||||||
|
* @param ReflectionNamedType|ReflectionUnionType A \ReflectionType instance to retrieve types from
|
||||||
|
* @return array<string> An array containing the allowed property types (literals and classes)
|
||||||
|
*/
|
||||||
|
private static function get_types(ReflectionNamedType|ReflectionUnionType $type): array {
|
||||||
|
$types = [];
|
||||||
|
|
||||||
|
// Property value is nullable
|
||||||
|
if ($type->allowsNull()) {
|
||||||
|
$types[] = "null";
|
||||||
|
}
|
||||||
|
|
||||||
|
// Property only accepts one type
|
||||||
|
if ($type instanceof ReflectionNamedType) {
|
||||||
|
// Add type name to output and trim shorthand nullable from name if present
|
||||||
|
$types[] = ltrim($type->getName(), "?");
|
||||||
|
return $types;
|
||||||
|
}
|
||||||
|
|
||||||
|
return array_merge($types, $type->getTypes());
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a new instance of a class-like object
|
||||||
|
*
|
||||||
|
* @param string Namespaced class name to instance
|
||||||
|
* @param array<mixed> Arguments to pass to the class constructor
|
||||||
|
* @return object Instanced class
|
||||||
|
*/
|
||||||
|
private static function instance_class(string $class_name, array $args): object {
|
||||||
|
$class = new ReflectionClass($class_name);
|
||||||
|
|
||||||
|
// Return new instance of Enum from case name
|
||||||
|
if ($class->isEnum()) {
|
||||||
|
return $class_name::fromName(...$args);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $class->newInstance(...$args);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Instance a new Controller for a given database Model
|
||||||
|
*
|
||||||
|
* @param Model An instance of a database Model entity
|
||||||
|
*/
|
||||||
|
public function __construct(private readonly Model $model) {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Update a database entity by passing an assoc array of column => value
|
||||||
|
*
|
||||||
|
* @param array<array> Associative array of column keys and column values to update
|
||||||
|
* @return void
|
||||||
|
*/
|
||||||
|
public function update(array $values): void {
|
||||||
|
foreach($values as $key => $value) {
|
||||||
|
// Bail out if we're trying to update a column that has not been implemented
|
||||||
|
// by the passed database Model
|
||||||
|
if (!in_array($key, $this->model->columns)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
$property = new ReflectionProperty($this->model, $key);
|
||||||
|
$types = self::get_types($property->getSettableType());
|
||||||
|
|
||||||
|
// Value is definitely a primitive
|
||||||
|
if (!is_string($value)) {
|
||||||
|
// Property does not accept this primitive as value, bail out
|
||||||
|
if (!in_array(gettype($value), $types)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set primitve value and move on
|
||||||
|
$this->model->{$key} = $value;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Returns the name of the first class object
|
||||||
|
$class_name = array_find($types, fn(string $type): bool => class_exists($type));
|
||||||
|
|
||||||
|
// No class object found, string value must be literal
|
||||||
|
if (!$class_name) {
|
||||||
|
// Property does not accept string literals as value, bail out
|
||||||
|
if (!in_array("string", $types)) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set string literal value and move on
|
||||||
|
$this->model->{$key} = $value;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Wrap single value in an array (as one constructor argument)
|
||||||
|
if (!is_array($value)) {
|
||||||
|
$value = [$value];
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->model->{$key} = self::instance_class($class_name, $value);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -10,7 +10,8 @@
|
||||||
* Abstract reading, creating, and updating of database entities.
|
* Abstract reading, creating, and updating of database entities.
|
||||||
*/
|
*/
|
||||||
abstract class Model {
|
abstract class Model {
|
||||||
const DATE_FORMAT = Database::DATE_FORMAT;
|
public const DATE_FORMAT = Database::DATE_FORMAT;
|
||||||
|
public const DATETIME_FORMAT = Database::DATETIME_FORMAT;
|
||||||
|
|
||||||
abstract public string $id { get; }
|
abstract public string $id { get; }
|
||||||
|
|
||||||
|
|
@ -21,7 +22,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Insert values into a database table
|
* Insert values into a database table
|
||||||
*
|
*
|
||||||
* @param string $table The target database table
|
* @param string $table The target database table
|
||||||
*/
|
*/
|
||||||
protected static function create(string $table, array $values): bool {
|
protected static function create(string $table, array $values): bool {
|
||||||
|
|
@ -30,22 +31,22 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a new Model to retrieve a specific entity
|
* Create a new Model to retrieve a specific entity
|
||||||
*
|
*
|
||||||
* @param string $table Target table where the entity is stored
|
* @param string $table Target table where the entity is stored
|
||||||
* @param array<string> $columns An array of strings for each target database column
|
* @param array<string> $columns An array of strings for each target database column
|
||||||
* @param array<array> $where vlw/MySQL->where() to locate the target entity
|
* @param array<array> $where vlw/MySQL->where() to locate the target entity
|
||||||
*/
|
*/
|
||||||
public function __construct(
|
public function __construct(
|
||||||
private readonly string $table,
|
public readonly string $table,
|
||||||
private readonly array $columns,
|
public readonly array $columns,
|
||||||
private readonly array $where
|
public readonly array $where
|
||||||
) {
|
) {
|
||||||
$this->db = new Database();
|
$this->db = new Database();
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch and store column values for instanced row
|
* Fetch and store column values for instanced row
|
||||||
*
|
*
|
||||||
* @return ?array<array> The column and value of each target database column
|
* @return ?array<array> The column and value of each target database column
|
||||||
*/
|
*/
|
||||||
private ?array $row {
|
private ?array $row {
|
||||||
|
|
@ -69,7 +70,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns true if instanced target ebity exists
|
* Returns true if instanced target ebity exists
|
||||||
*
|
*
|
||||||
* @return bool Entity exists
|
* @return bool Entity exists
|
||||||
*/
|
*/
|
||||||
public function isset(): bool {
|
public function isset(): bool {
|
||||||
|
|
@ -83,7 +84,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get current row column value
|
* Get current row column value
|
||||||
*
|
*
|
||||||
* @param string $key Target column
|
* @param string $key Target column
|
||||||
* @return mixed Value of target column
|
* @return mixed Value of target column
|
||||||
*/
|
*/
|
||||||
|
|
@ -93,7 +94,7 @@
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Update current row column with value
|
* Update current row column with value
|
||||||
*
|
*
|
||||||
* @param string $key Target column to update
|
* @param string $key Target column to update
|
||||||
* @param mixed $value New value of target column
|
* @param mixed $value New value of target column
|
||||||
* @return bool Update was successful
|
* @return bool Update was successful
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue