12 Commits

Author SHA1 Message Date
4e7ff1e508 Updated 2024-04-22 13:31:05 -04:00
7a88398379 Simplified Model 2022-12-22 19:48:23 -03:00
7848d973a6 Reorder 2022-12-22 19:48:05 -03:00
d2c5c1180b Don't assume columns. 2022-12-22 19:42:20 -03:00
e4cec2e2f2 trigger_error -> error_log 2022-10-11 12:17:30 -03:00
8a03d9e675 Reorder and cleanup of Repository 2022-10-11 11:39:25 -03:00
100df73916 Remove Mapping, simplifying Repository 2022-10-10 22:19:09 -03:00
5c1f424c76 Added Mapping functionality 2022-10-10 21:47:48 -03:00
fe67519682 Added column = property handling for mapping 2022-10-10 17:32:34 -03:00
0a9bed1735 Fixes 2022-10-10 16:46:44 -03:00
422d9a6dbd Improve mapping 2022-10-10 16:36:47 -03:00
23c56f9511 Change ResultSet::getFirst definition 2022-09-12 21:49:11 -03:00
9 changed files with 325 additions and 306 deletions

View File

@ -6,16 +6,6 @@ use ProVM\Concept\Model as ModelInterface;
abstract class Model implements ModelInterface
{
protected Repository $repository;
public function setRepository(Repository $repository): ModelInterface
{
$this->repository = $repository;
return $this;
}
public function getRepository(): Repository
{
return $this->repository;
}
protected int $id;
public function setId(int $id): ModelInterface
{
@ -26,64 +16,4 @@ abstract class Model implements ModelInterface
{
return $this->id;
}
protected bool $new;
public function setNew(): ModelInterface
{
$this->new = true;
return $this;
}
public function isNew(): bool
{
return $this->new ?? false;
}
protected bool $dirty;
public function setDirty(): ModelInterface
{
$this->dirty = true;
return $this;
}
public function isDirty(): bool
{
return $this->dirty ?? $this->isNew();
}
public function save(): void
{
if ($this->isDirty()) {
$this->getRepository()->save($this);
}
}
public function edit(array $data): void
{
foreach ($data as $key => $val) {
$m = 'set' . ucwords($key);
$this->{$m}($val);
}
$this->isDirty();
}
public function delete(): void
{
$this->getRepository()->delete($this);
}
public function jsonSerialize(): mixed
{
$obj = new \ReflectionObject($this);
$methods = $obj->getMethods();
$output = [];
foreach ($methods as $method) {
if (!str_contains($method->getName(), 'get')) {
continue;
}
if ($method->getName() === 'getRepository') {
continue;
}
$p = strtolower(str_replace('get', '', $method->getName()));
if (!isset($this->{$p})) {
continue;
}
$output[$p] = $this->{$method->getName()}();
}
return $output;
}
}

View File

@ -1,243 +1,138 @@
<?php
namespace ProVM\Alias\Model;
use PDOException;
use ProVM\Concept\Database\Connection;
use ProVM\Concept\Database\QueryBuilder;
use ProVM\Concept\Model;
use ProVM\Concept\Model\Factory;
use ProVM\Concept\Model\Repository as RepositoryInterface;
use ProVM\Exception\BlankResult;
abstract class Repository implements RepositoryInterface
{
public function __construct(Connection $connection, QueryBuilder $builder, Factory $factory)
{
$this->setConnection($connection)
->setQueryBuilder($builder)
->setFactory($factory)
->setup();
}
public function __construct(protected Connection $connection, protected QueryBuilder $builder, protected Factory $factory)
{}
protected string $model;
protected Connection $connection;
public function setConnection(Connection $connection): Repository
{
$this->connection = $connection;
return $this;
}
public function getConnection(): Connection
{
return $this->connection;
}
protected QueryBuilder $builder;
public function setQueryBuilder(QueryBuilder $builder): RepositoryInterface
{
$this->builder = $builder;
return $this;
}
public function getQueryBuilder(): QueryBuilder
{
return $this->builder;
}
protected Factory $factory;
public function setFactory(Factory $factory): RepositoryInterface
{
$this->factory = $factory;
return $this;
}
public function getFactory(): Factory
{
return $this->factory;
}
protected string $model;
public function setModel(string $model_class): RepositoryInterface
{
$this->model = $model_class;
return $this;
}
public function getModel(): string
{
return $this->model;
}
public function getNewModel(): Model
{
$class = $this->getModel();
return (new $class())
->setRepository($this);
}
protected string $table;
public function setTable(string $table): RepositoryInterface
{
$this->table = $table;
return $this;
}
public function getTable(): string
{
return $this->table;
}
protected array $columns;
public function setColumns(array $columns): RepositoryInterface
{
foreach ($columns as $column) {
$this->addColumn($column);
}
return $this;
}
public function addColumn(string $column): RepositoryInterface
{
$this->columns []= $column;
return $this;
}
public function getColumns(): array
{
return $this->columns;
}
protected array $required;
public function setRequired(array $columns): RepositoryInterface
{
foreach ($columns as $item) {
$this->addRequired($item);
}
return $this;
}
public function addRequired(string $column): RepositoryInterface
{
$this->required []= $column;
return $this;
}
public function getRequired(): array
{
if (isset($this->optional) and !isset($this->required)) {
return array_diff($this->getColumns(), $this->getOptional());
}
return $this->required ?? $this->getColumns();
}
protected array $optional;
public function setOptional(array $columns): RepositoryInterface
{
foreach ($columns as $item) {
$this->addColumn($item);
}
return $this;
}
public function addOptional(string $column): RepositoryInterface
{
$this->optional []= $column;
return $this;
}
public function getOptional(): array
{
if (isset($this->required) and !isset($this->optional)) {
return array_diff($this->getColumns(), $this->getRequired());
}
return $this->optional ?? [];
}
public function getMethod(string $column, bool $get = true): string
public function save(Model &$model): void
{
$m = str_replace(' ', '', ucwords(str_replace('_', ' ', $column)));
if ($get) {
return "get{$m}";
try {
$old = $this->defaultFind($model);
$this->update($model, $old);
} catch (BlankResult $e) {
$this->insert($model);
$model->setId($this->getConnection()->getPDO()->lastInsertId());
}
return "set{$m}";
}
public function getProperty(string $method): string
public function update(Model $model, Model $old): void
{
$parts = preg_split('/(?=[A-Z])/', $method);
if (in_array(strtolower($parts[0]), ['get', 'set'])) {
array_shift($parts);
}
return strtolower(implode('_', $parts));
}
public function fillData(Model $model, array $data): Model
{
foreach ($this->getRequired() as $column) {
$m = $this->getMethod($column, false);
if (!method_exists($model, $m)) {
continue;
}
$model->{$m}($data[$column]);
}
foreach ($this->getOptional() as $column) {
if (!isset($data[$column])) {
continue;
}
$m = $this->getMethod($column, false);
if (!method_exists($model, $m)) {
continue;
}
$model->{$m}($data[$column]);
}
return $model;
}
public function mapArray(Model $model, array $data): array
{
foreach ($this->getColumns() as $column) {
if (isset($data[$column])) {
continue;
}
$m = $this->getMethod($column);
if (!method_exists($model, $m)) {
continue;
}
$val = $model->{$m}();
$data[$column] = $val;
}
return $data;
}
public function load(array $data): Model
{
return $this->fillData($this->getNewModel()
->setId($data['id']), $data);
}
public function save(Model $model): void
{
if (!$model->isDirty() and !$model->isNew()) {
$mapper = $this->getMapper();
$model_values = $mapper->mapModelToTable($model);
$old_values = $mapper->mapModelToTable($old);
$differences = array_diff_assoc($old_values, $model_values);
$columns = array_map(function($key) {
return "`{$key}` = ?";
}, array_keys($differences));
$values = array_values($differences);
if (count($columns) === 0) {
return;
}
if (!$model->isNew()) {
$this->update($model);
return;
}
$values = $this->mapArray($model, []);
$cols = array_fill(0, count($values), '?');
$query = $this->getQueryBuilder()->insert($this->getTable())->columns($this->getColumns())->values($cols);
$this->getConnection()->execute($query, $values);
}
public function update(Model $model): void
{
if (!$model->isDirty() and !$model->isNew()) {
return;
}
$values = $this->mapArray($model, []);
$cols = array_map(function($column) {
return "{$column} = ?";
}, $values);
$values = array_values($values);
$values []= $model->getId();
$query = $this->getQueryBuilder()->update($this->getTable())->set($cols)->where(['id = ?']);
$values []= $old->{$this->idProperty()}();
$query = $this->getQueryBuilder()->update($this->getTable())->set($columns)->where(["{$this->idField()}} = ?"]);
$this->getConnection()->execute($query, $values);
}
public function create(array $data): Model
{
return $this->fillData($this->getNewModel()
->setNew(), $data);
}
public function edit(Model $model, array $data): Model
{
foreach ($this->getColumns() as $col) {
if (isset($data[$col])) {
$m = $this->getMethod($col, false);
if (!method_exists($model, $m)) {
continue;
}
$model->{$m}($data[$col]);
}
try {
return $this->defaultSearch($data);
} catch (PDOException | BlankResult $e) {
$data[$this->idField()] = 0;
return $this->load($data);
}
return $model;
}
public function delete(Model $model): void
{
$query = $this->getQueryBuilder()->delete($this->getTable())->where(['id = ?']);
$this->getConnection()->execute($query, [$model->getId()]);
$query = $this->getQueryBuilder()->delete($this->getTable())->where(["{$this->idField()} = ?"]);
$this->getConnection()->execute($query, [$model->{$this->idProperty()}()]);
$this->resetIndex();
$this->optimize();
}
protected function idProperty(): string
{
return 'getId';
}
protected function idField(): string
{
return 'id';
}
protected function insert(Model $model): void
{
$mapper = $this->getMapper();
$fields = $mapper->getColumns();
$fields_string = array_map(function($field) {
return "`{$field}`";
}, $fields);
$fields_questions = array_fill(0, count($fields), '?');
$query = $this->getQueryBuilder()->insert($this->getTable())->columns($fields_string)->values($fields_questions);
$values = array_values($mapper->mapModelToTable($model));
$this->getConnection()->execute($query, $values);
}
protected function resetIndex(): void
{
$query = "ALTER TABLE `{$this->getTable()}` AUTO_INCREMENT = 1";
$this->getConnection()->query($query);
}
protected function optimize(): void
{
$query = "OPTIMIZE TABLE `{$this->getTable()}`";
$this->getConnection()->query($query);
}
protected function fetchOne(string $query, ?array $values = null): Model
{
if ($values !== null) {
$rs = $this->getConnection()->prepare($query);
$rs->execute($values);
} else {
$rs = $this->getConnection()->query($query);
}
$row = $rs->getFirstAsArray();
if (!$row) {
throw new BlankResult();
}
return $this->load($row);
}
protected function fetchMany(string $query, ?array $values = null): array
{
if ($values !== null) {
$rs = $this->getConnection()->prepare($query);
$rs->execute($values);
} else {
$rs = $this->getConnection()->query($query);
}
$rows = $rs->getAsArray();
if (!$rows) {
throw new BlankResult();
}
return array_map([$this, 'load'], $rows);
}
public function fetchById(int $id): Model
@ -247,13 +142,22 @@ abstract class Repository implements RepositoryInterface
->from($this->getTable())
->where(['id = ?'])
->limit(1);
return $this->load($this->getConnection()->execute($query, [$id])->getAsArray()[0]);
return $this->fetchOne($query, [$id]);
}
public function fetchAll(): array
{
$query = $this->getQueryBuilder()
->select()
->from($this->getTable());
return array_map([$this, 'load'], $this->getConnection()->query($query)->getAsArray());
return $this->fetchMany($query);
}
abstract protected function getMapper(): Model\Mapper;
abstract protected function fieldsForUpdate(): array;
abstract protected function fieldsForInsert(): array;
abstract protected function valuesForUpdate(Model $model): array;
abstract protected function valuesForInsert(Model $model): array;
abstract protected function defaultFind(Model $model): Model;
abstract protected function defaultSearch(array $data): Model;
}

View File

@ -2,19 +2,9 @@
namespace ProVM\Concept;
use JsonSerializable;
use ProVM\Concept\Model\Repository;
interface Model extends JsonSerializable
{
public function setRepository(Repository $factory): Model;
public function getRepository(): Repository;
public function setId(int $id): Model;
public function getId(): int;
public function setNew(): Model;
public function isNew(): bool;
public function setDirty(): Model;
public function isDirty(): bool;
public function save(): void;
public function edit(array $data): void;
public function delete(): void;
}

View File

@ -1,11 +1,48 @@
<?php
namespace ProVM\Concept\Model;
use ProVM\Concept\Model;
use Psr\Container\ContainerInterface;
interface Factory
{
/**
* @param ContainerInterface $container
* @return Factory
*/
public function setContainer(ContainerInterface $container): Factory;
/**
* @return ContainerInterface
*/
public function getContainer(): ContainerInterface;
/**
* Get Repository by class
* @param string $repository_class
* @return Repository
*/
public function get(string $repository_class): Repository;
/**
* Get Repository by Model class
* @param string $model_class
* @return Repository
*/
public function getByModel(string $model_class): Repository;
/**
* Fetch Model by Id
* @param string $model_class
* @param int $id
* @return Model
*/
public function fetchById(string $model_class, int $id): Model;
/**
* Fetch all Models
* @param string $model_class
* @return array
*/
public function fetchAll(string $model_class): array;
}

View File

@ -0,0 +1,11 @@
<?php
namespace ProVM\Concept\Model;
use ProVM\Concept;
interface Mapper
{
public function getColumns(): array;
public function mapModelToTable(Concept\Model $model): array;
public function mapTableToModel(array $data, Concept\Model $model): Concept\Model;
}

View File

@ -7,37 +7,67 @@ use ProVM\Concept\Model;
interface Repository
{
public function setConnection(Connection $connection): Repository;
/**
* @return Connection
*/
public function getConnection(): Connection;
public function setQueryBuilder(QueryBuilder $builder): Repository;
/**
* @return QueryBuilder
*/
public function getQueryBuilder(): QueryBuilder;
public function setFactory(Factory $factory): Repository;
/**
* @return Factory
*/
public function getFactory(): Factory;
public function setModel(string $model_class): Repository;
/**
* @return string
*/
public function getModel(): string;
public function getNewModel(): Model;
public function setup(): Repository;
public function setTable(string $table): Repository;
/**
* @return string
*/
public function getTable(): string;
public function setColumns(array $columns): Repository;
public function addColumn(string $column): Repository;
public function getColumns(): array;
public function setRequired(array $columns): Repository;
public function addRequired(string $column): Repository;
public function getRequired(): array;
public function setOptional(array $columns): Repository;
public function addOptional(string $column): Repository;
public function getOptional(): array;
public function getMethod(string $column, bool $get = true): string;
public function getProperty(string $method): string;
public function fillData(Model $model, array $data): Model;
public function mapArray(Model $model, array $data): array;
/**
* Transform result array to Model
* @param array $data
* @return Model
*/
public function load(array $data): Model;
public function save(Model $model): void;
public function update(Model $model): void;
/**
* Save Model to table
* @param Model $model
* @return void
*/
public function save(Model &$model): void;
/**
* Update table value with Model
* @param Model $model
* @return void
*/
public function update(Model $model, Model $old): void;
/**
* Create new Model with data
* @param array $data
* @return Model
*/
public function create(array $data): Model;
public function edit(Model $model, array $data): Model;
/**
* Delete Model from table
* @param Model $model
* @return void
*/
public function delete(Model $model): void;
/**
* Fetch Model by Id
* @param int $id
* @return Model
*/
public function fetchById(int $id): Model;
/**
* Fetch all Models
* @return array
*/
public function fetchAll(): array;
}

View File

@ -2,6 +2,7 @@
namespace ProVM\Implement\Model;
use Psr\Container\ContainerInterface;
use ProVM\Concept\Model;
use ProVM\Concept\Model\Factory as FactoryInterface;
use ProVM\Concept\Model\Repository;
@ -26,4 +27,18 @@ class Factory implements FactoryInterface
{
return $this->getContainer()->get($repository_class);
}
public function getByModel(string $model_class): Repository
{
$class = str_replace('Model', 'Repository', $model_class);
return $this->get($class);
}
public function fetchById(string $model_class, int $id): Model
{
return $this->getByModel($model_class)->fetchById($id);
}
public function fetchAll(string $model_class): array
{
return $this->getByModel($model_class)->fetchAll();
}
}

View File

@ -0,0 +1,39 @@
<?php
namespace ProVM\Implement\Model;
use ProVM\Concept;
use ProVM\Implement\Model\Mapper\PropertyMap;
class Mapper implements Concept\Model\Mapper
{
protected array $map;
public function getColumns(): array
{
return array_keys($this->map);
}
public function registerColumn(string $columnName, ?PropertyMap $propertyMap = null): Mapper
{
if ($propertyMap == null) {
$this->map[$columnName] = (new PropertyMap())->setColumn($columnName);
return $this;
}
$this->map[$columnName] = $propertyMap;
return $this;
}
public function mapModelToTable(Concept\Model $model): array
{
$data = [];
foreach ($this->map as $columnName => $propertyMap) {
$data[$columnName] = $propertyMap->mapToTable($model);
}
return $data;
}
public function mapTableToModel(array $data, Concept\Model $model): Concept\Model
{
foreach ($this->map as $propertyMap) {
$propertyMap->map($model, $data);
}
return $model;
}
}

View File

@ -0,0 +1,63 @@
<?php
namespace ProVM\Implement\Model\Mapper;
use Closure;
use Exception;
use ProVM\Concept\Model;
class PropertyMap
{
protected string $column;
protected string $property;
protected Closure $callback;
protected mixed $defaultValue;
public function setProperty(string $property): PropertyMap
{
$this->property = $property;
return $this;
}
public function setColumn(string $column): PropertyMap
{
$this->column = $column;
return $this;
}
public function setCallback(Closure $callback): PropertyMap
{
$this->callback = $callback;
return $this;
}
public function setDefaultValue(mixed $defaultValue): PropertyMap
{
$this->defaultValue = $defaultValue;
return $this;
}
public function map(Model $model, array $data): Model
{
$property = $this->property ?? $this->column;
if (isset($this->callback)) {
try {
$model->{$property} = call_user_func_array($this->callback, $data);
} catch (Exception) {
if (!isset($data[$this->column])) {
$model->{$property} = $this->defaultValue;
} else {
$model->{$property} = $data[$this->column];
}
}
return $model;
}
if (!isset($data[$this->column])) {
$model->{$property} = $this->defaultValue;
} else {
$model->{$property} = $data[$this->column];
}
return $model;
}
public function mapToTable(Model $model): mixed
{
$property = $this->property ?? $this->column;
return $model->{$property} ?? $this->defaultValue;
}
}