mirror of
https://github.com/Karaka-Management/phpOMS.git
synced 2026-01-11 17:58:41 +00:00
481 lines
11 KiB
PHP
481 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* Karaka
|
|
*
|
|
* PHP Version 8.0
|
|
*
|
|
* @package phpOMS\DataStorage\Database\Mapper
|
|
* @copyright Dennis Eichhorn
|
|
* @license OMS License 1.0
|
|
* @version 1.0.0
|
|
* @link https://karaka.app
|
|
*/
|
|
declare(strict_types=1);
|
|
|
|
namespace phpOMS\DataStorage\Database\Mapper;
|
|
|
|
use phpOMS\DataStorage\Database\Connection\ConnectionAbstract;
|
|
use phpOMS\DataStorage\Database\Query\Builder;
|
|
|
|
/**
|
|
* Mapper factory.
|
|
*
|
|
* @package phpOMS\DataStorage\Database\Mapper
|
|
* @license OMS License 1.0
|
|
* @link https://karaka.app
|
|
* @since 1.0.0
|
|
*/
|
|
class DataMapperFactory
|
|
{
|
|
/**
|
|
* Datetime format of the database datetime
|
|
*
|
|
* This is only for the datetime stored in the database not the generated query.
|
|
* For the query check the datetime in Grammar:$datetimeFormat
|
|
*
|
|
* @var string
|
|
* @since 1.0.0
|
|
*/
|
|
public static string $datetimeFormat = 'Y-m-d H:i:s';
|
|
|
|
/**
|
|
* Primary field name.
|
|
*
|
|
* @var string
|
|
* @since 1.0.0
|
|
*/
|
|
public const PRIMARYFIELD = '';
|
|
|
|
/**
|
|
* Autoincrement primary field.
|
|
*
|
|
* @var bool
|
|
* @since 1.0.0
|
|
*/
|
|
public const AUTOINCREMENT = true;
|
|
|
|
/**
|
|
* Primary field name.
|
|
*
|
|
* @var string
|
|
* @since 1.0.0
|
|
*/
|
|
public const CREATED_AT = '';
|
|
|
|
/**
|
|
* Columns.
|
|
*
|
|
* @var array<string, array{name:string, type:string, internal:string, autocomplete?:bool, readonly?:bool, writeonly?:bool, annotations?:array}>
|
|
* @since 1.0.0
|
|
*/
|
|
public const COLUMNS = [];
|
|
|
|
/**
|
|
* Has many relation.
|
|
*
|
|
* @var array<string, array>
|
|
* @since 1.0.0
|
|
*/
|
|
public const HAS_MANY = [];
|
|
|
|
/**
|
|
* Relations.
|
|
*
|
|
* Relation is defined in current mapper
|
|
*
|
|
* @var array<string, array{mapper:string, external:string, by?:string, column?:string, conditional?:bool}>
|
|
* @since 1.0.0
|
|
*/
|
|
public const OWNS_ONE = [];
|
|
|
|
/**
|
|
* Belongs to.
|
|
*
|
|
* @var array<string, array{mapper:string, external:string}>
|
|
* @since 1.0.0
|
|
*/
|
|
public const BELONGS_TO = [];
|
|
|
|
/**
|
|
* Table.
|
|
*
|
|
* @var string
|
|
* @since 1.0.0
|
|
*/
|
|
public const TABLE = '';
|
|
|
|
/**
|
|
* Parent column.
|
|
*
|
|
* @var string
|
|
* @since 1.0.0
|
|
*/
|
|
public const PARENT = '';
|
|
|
|
/**
|
|
* Model to use by the mapper.
|
|
*
|
|
* @var string
|
|
* @since 1.0.0
|
|
*/
|
|
public const MODEL = '';
|
|
|
|
/**
|
|
* Database connection.
|
|
*
|
|
* @var ConnectionAbstract
|
|
* @since 1.0.0
|
|
*/
|
|
protected static ConnectionAbstract $db;
|
|
|
|
/**
|
|
* Initialized objects for cross reference to reduce initialization costs
|
|
*
|
|
* @var array[]
|
|
* @since 1.0.0
|
|
*/
|
|
protected static array $initObjects = [];
|
|
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @since 1.0.0
|
|
* @codeCoverageIgnore
|
|
*/
|
|
final private function __construct()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Clone.
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
* @codeCoverageIgnore
|
|
*/
|
|
private function __clone()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Set default database connection
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return class-string<self>
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function db(ConnectionAbstract $db) : string
|
|
{
|
|
self::$db = $db;
|
|
|
|
return static::class;
|
|
}
|
|
|
|
/**
|
|
* Create read mapper
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return ReadMapper
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function reader(ConnectionAbstract $db = null) : ReadMapper
|
|
{
|
|
return new ReadMapper(new static(), $db ?? self::$db);
|
|
}
|
|
|
|
/**
|
|
* Create read mapper
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return ReadMapper
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function get(ConnectionAbstract $db = null) : ReadMapper
|
|
{
|
|
return (new ReadMapper(new static(), $db ?? self::$db))->get();
|
|
}
|
|
|
|
/**
|
|
* Create read mapper
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return ReadMapper
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function getRaw(ConnectionAbstract $db = null) : ReadMapper
|
|
{
|
|
return (new ReadMapper(new static(), $db ?? self::$db))->getRaw();
|
|
}
|
|
|
|
/**
|
|
* Create read mapper
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return ReadMapper
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function getRandom(ConnectionAbstract $db = null) : ReadMapper
|
|
{
|
|
return (new ReadMapper(new static(), $db ?? self::$db))->getRandom();
|
|
}
|
|
|
|
/**
|
|
* Create read mapper
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return ReadMapper
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function count(ConnectionAbstract $db = null) : ReadMapper
|
|
{
|
|
return (new ReadMapper(new static(), $db ?? self::$db))->count();
|
|
}
|
|
|
|
/**
|
|
* Create read mapper
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return Builder
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function getQuery(ConnectionAbstract $db = null) : Builder
|
|
{
|
|
return (new ReadMapper(new static(), $db ?? self::$db))->getQuery();
|
|
}
|
|
|
|
/**
|
|
* Create read mapper
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return ReadMapper
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function getAll(ConnectionAbstract $db = null) : ReadMapper
|
|
{
|
|
return (new ReadMapper(new static(), $db ?? self::$db))->getAll();
|
|
}
|
|
|
|
/**
|
|
* Create write mapper
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return WriteMapper
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function writer(ConnectionAbstract $db = null) : WriteMapper
|
|
{
|
|
return new WriteMapper(new static(), $db ?? self::$db);
|
|
}
|
|
|
|
/**
|
|
* Create write mapper
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return WriteMapper
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function create(ConnectionAbstract $db = null) : WriteMapper
|
|
{
|
|
return (new WriteMapper(new static(), $db ?? self::$db))->create();
|
|
}
|
|
|
|
/**
|
|
* Create update mapper
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return UpdateMapper
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function updater(ConnectionAbstract $db = null) : UpdateMapper
|
|
{
|
|
return new UpdateMapper(new static(), $db ?? self::$db);
|
|
}
|
|
|
|
/**
|
|
* Create update mapper
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return UpdateMapper
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function update(ConnectionAbstract $db = null) : UpdateMapper
|
|
{
|
|
return (new UpdateMapper(new static(), $db ?? self::$db))->update();
|
|
}
|
|
|
|
/**
|
|
* Create delete mapper
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return DeleteMapper
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function remover(ConnectionAbstract $db = null) : DeleteMapper
|
|
{
|
|
return new DeleteMapper(new static(), $db ?? self::$db);
|
|
}
|
|
|
|
/**
|
|
* Create delete mapper
|
|
*
|
|
* @param ConnectionAbstract $db Database connection
|
|
*
|
|
* @return DeleteMapper
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function delete(ConnectionAbstract $db = null) : DeleteMapper
|
|
{
|
|
return (new DeleteMapper(new static(), $db ?? self::$db))->delete();
|
|
}
|
|
|
|
/**
|
|
* Test if object is null object
|
|
*
|
|
* @param mixed $obj Object to check
|
|
*
|
|
* @return bool
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function isNullModel(mixed $obj) : bool
|
|
{
|
|
return \is_object($obj) && \strpos(\get_class($obj), '\Null') !== false;
|
|
}
|
|
|
|
/**
|
|
* Creates the current null object
|
|
*
|
|
* @param mixed $id Model id
|
|
*
|
|
* @return mixed
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function createNullModel(mixed $id = null) : mixed
|
|
{
|
|
$class = empty(static::MODEL) ? \substr(static::class, 0, -6) : static::MODEL;
|
|
$parts = \explode('\\', $class);
|
|
$name = $parts[$c = (\count($parts) - 1)];
|
|
$parts[$c] = 'Null' . $name;
|
|
$class = \implode('\\', $parts);
|
|
|
|
return $id !== null ? new $class($id) : new $class();
|
|
}
|
|
|
|
/**
|
|
* Create the empty base model
|
|
*
|
|
* @return object
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function createBaseModel() : object
|
|
{
|
|
$class = empty(static::MODEL) ? \substr(static::class, 0, -6) : static::MODEL;
|
|
|
|
return new $class();
|
|
}
|
|
|
|
/**
|
|
* Get id of object
|
|
*
|
|
* @param object $obj Model to create
|
|
* @param \ReflectionClass $refClass Reflection class
|
|
* @param string $member Member name for the id, if it is not the primary key
|
|
*
|
|
* @return mixed
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function getObjectId(object $obj, \ReflectionClass $refClass = null, string $member = null) : mixed
|
|
{
|
|
$refClass ??= new \ReflectionClass($obj);
|
|
$propertyName = $member ?? static::COLUMNS[static::PRIMARYFIELD]['internal'];
|
|
$refProp = $refClass->getProperty($propertyName);
|
|
|
|
if (!$refProp->isPublic()) {
|
|
$refProp->setAccessible(true);
|
|
$objectId = $refProp->getValue($obj);
|
|
$refProp->setAccessible(false);
|
|
} else {
|
|
$objectId = $obj->{$propertyName};
|
|
}
|
|
|
|
return $objectId;
|
|
}
|
|
|
|
/**
|
|
* Set id to model
|
|
*
|
|
* @param \ReflectionClass $refClass Reflection class
|
|
* @param object $obj Object to create
|
|
* @param mixed $objId Id to set
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function setObjectId(\ReflectionClass $refClass, object $obj, mixed $objId) : void
|
|
{
|
|
$propertyName = static::COLUMNS[static::PRIMARYFIELD]['internal'];
|
|
$refProp = $refClass->getProperty($propertyName);
|
|
|
|
\settype($objId, static::COLUMNS[static::PRIMARYFIELD]['type']);
|
|
if (!$refProp->isPublic()) {
|
|
$refProp->setAccessible(true);
|
|
$refProp->setValue($obj, $objId);
|
|
$refProp->setAccessible(false);
|
|
} else {
|
|
$obj->{$propertyName} = $objId;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Find database column name by member name
|
|
*
|
|
* @param string $name member name
|
|
*
|
|
* @return null|string
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public static function getColumnByMember(string $name) : ?string
|
|
{
|
|
foreach (static::COLUMNS as $cName => $column) {
|
|
if ($column['internal'] === $name) {
|
|
return $cName;
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
}
|