2 Commits

Author SHA1 Message Date
81ad81f7bf v1.1.0 2022-09-09 10:33:54 -04:00
12065b376b v2.0.0 2022-09-08 21:43:02 -04:00
6 changed files with 65 additions and 535 deletions

View File

@ -1,20 +1,20 @@
<?php
namespace ProVM\Alias;
use ProVM\Concept\Model\Repository;
use ProVM\Concept\Model\Factory;
use ProVM\Concept\Model as ModelInterface;
abstract class Model implements ModelInterface
{
protected Repository $repository;
public function setRepository(Repository $repository): ModelInterface
protected Factory $factory;
public function setFactory(Factory $factory): ModelInterface
{
$this->repository = $repository;
$this->factory = $factory;
return $this;
}
public function getRepository(): Repository
public function getFactory(): Factory
{
return $this->repository;
return $this->factory;
}
protected int $id;
public function setId(int $id): ModelInterface
@ -50,7 +50,7 @@ abstract class Model implements ModelInterface
public function save(): void
{
if ($this->isDirty()) {
$this->getRepository()->save($this);
$this->getFactory()->get(get_class($this))->save($this);
}
}
public function edit(array $data): void
@ -61,29 +61,4 @@ abstract class Model implements ModelInterface
}
$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(preg_replace('/(?<!^)[A-Z]/', '_$0', str_replace('get', '', $method->getName())));
if (!isset($this->{$p})) {
continue;
}
$output[$p] = $this->{$method->getName()}();
}
return $output;
}
}

View File

@ -18,83 +18,46 @@ abstract class Repository implements RepositoryInterface
}
protected Connection $connection;
protected QueryBuilder $builder;
protected Factory $factory;
protected string $model;
protected string $table;
protected array $columns;
protected array $required_columns;
protected array $optional_columns;
protected array $properties;
public function getConnection(): Connection
{
return $this->connection;
}
public function getQueryBuilder(): QueryBuilder
{
return $this->builder;
}
public function getFactory(): Factory
{
return $this->factory;
}
public function getModel(): string
{
return $this->model;
}
public function getTable(): string
{
return $this->table;
}
public function getColumns(): array
{
return $this->columns ?? array_merge($this->getRequiredColumns(), $this->getOptionalColumns());
}
public function getRequiredColumns(): array
{
if (isset($this->optional_columns) and !isset($this->required_columns)) {
return array_diff($this->getColumns(), $this->getOptionalColumns());
}
return $this->required_columns ?? $this->getColumns();
}
public function getOptionalColumns(): array
{
if (isset($this->required_columns) and !isset($this->optional_columns)) {
return array_diff($this->getColumns(), $this->getRequiredColumns());
}
return $this->optional_columns ?? [];
}
public function getProperties(): array
{
return $this->properties ?? $this->getColumns();
}
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 setModel(string $model_class): RepositoryInterface
public function getFactory(): Factory
{
$this->model = $model_class;
return $this;
return $this->factory;
}
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) {
@ -102,232 +65,49 @@ abstract class Repository implements RepositoryInterface
}
return $this;
}
public function setRequiredColumns(array $columns): RepositoryInterface
{
foreach ($columns as $item) {
$this->addRequiredColumn($item);
}
return $this;
}
public function setOptionalColumns(array $columns): RepositoryInterface
{
foreach ($columns as $item) {
$this->addOptionalColumn($item);
}
return $this;
}
public function setProperties(array $properties): RepositoryInterface
{
foreach ($properties as $property) {
$this->addProperty($property);
}
return $this;
}
public function addColumn(string $column): RepositoryInterface
{
$this->columns []= $column;
return $this;
}
public function addRequiredColumn(string $column): RepositoryInterface
public function getColumns(): array
{
$this->required_columns []= $column;
return $this;
}
public function addOptionalColumn(string $column): RepositoryInterface
{
$this->optional_columns []= $column;
return $this;
}
public function addProperty(string $property): RepositoryInterface
{
$this->properties []= $property;
return $this;
return $this->columns;
}
public function getNewModel(): Model
{
$class = $this->getModel();
return (new $class())
->setRepository($this);
}
public function getMethod(string $property, bool $get = true): string
{
$m = str_replace(' ', '', ucwords(str_replace('_', ' ', $property)));
if ($get) {
return "get{$m}";
}
return "set{$m}";
}
public function getProperty(string $method): string
{
$parts = preg_split('/(?=[A-Z])/', $method);
if (in_array(strtolower($parts[0]), ['get', 'set'])) {
array_shift($parts);
}
return strtolower(implode('_', $parts));
}
protected function compareProp(string $property, ?array $data = null): bool
{
if ($data === null) {
return in_array($property, $this->getRequiredColumns());
}
return in_array($property, $this->getOptionalColumns()) and key_exists($property, $data);
}
protected function compareProperty(string $property, ?array $data = null, ?string &$tmp_property = null): bool
{
$tmp_property = $property;
if ($this->compareProp($tmp_property, $data)) {
return true;
}
$tmp_property = "{$property}_id";
return $this->compareProp($tmp_property, $data);
}
protected function validateDefaultProperty(mixed $value): bool
{
$defaults = [
0,
'',
null
];
return in_array($value, $defaults);
}
protected function editModel(Model $model, string $getter, string $setter, mixed $value, bool $optional = false): Model
{
try {
$val = $model->{$getter}();
if ($optional and $this->validateDefaultProperty($val)) {
$model->{$setter}($value);
}
} catch (\Error|\Exception $e) {
$model->{$setter}($value);
}
return $model;
}
public function mapModel(Model $model, array $data): Model
{
/**
* Default Model map
* It is assumed that the Model properties are named like the table columns
*/
foreach ($this->getProperties() as $property) {
$getter = $this->getMethod($property);
$setter = $this->getMethod($property, false);
if ($this->compareProperty($property, tmp_property: $tmp)) {
$model = $this->editModel($model, $getter, $setter, $data[$tmp]);
continue;
}
if (!method_exists($model, $setter)) {
continue;
}
if ($this->compareProperty($property, $data, $tmp)) {
$model = $this->editModel($model, $getter, $setter, $data[$tmp], true);
}
try {
$value = $model->{$getter}();
if ($this->validateDefaultProperty($value)) {
error_log("Notice: {$property} has default value in " . get_called_class());
}
} catch (\Error | \Exception $e) {
error_log("Warning: Missing {$property} in data for " . get_called_class() . "::fillData");
}
}
return $model;
}
public function mapTable(Model $model, array $data): array
{
/**
* Default table map
* It is assumed that the table columns are named the same as the Model properties
*/
foreach ($this->getRequiredColumns() as $column) {
$m = $this->getMethod($column);
if (!method_exists($model, $m)) {
error_log("Warning: Missing getter for {$column} in " . get_called_class() . "::mapArray");
continue;
}
if (!isset($data[$column])) {
$data[$column] = $model->{$m}();
}
}
foreach ($this->getOptionalColumns() as $column) {
$m = $this->getMethod($column);
if (!method_exists($model, $m)) {
continue;
}
if (!isset($data[$column])) {
$data[$column] = $model->{$m}();
}
}
return $data;
}
public function load(array $data): Model
{
return $this->mapModel($this->getNewModel()
->setId($data['id']), $data);
}
public function save(Model $model): void
{
if (!$model->isDirty() and !$model->isNew()) {
return;
}
if (!$model->isNew()) {
$this->update($model);
return;
$cols = [];
$values = [];
foreach ($this->getColumns() as $column) {
$m = 'get' . ucwords($column);
$cols []= '?';
$values []= $model->{$m}();
}
$values = array_replace(array_flip($this->getColumns()), $this->mapTable($model, []));
$cols = array_fill(0, count($values), '?');
$query = $this->getQueryBuilder()->insert($this->getTable())->columns($this->getColumns())->values($cols);
$this->getConnection()->execute($query, array_values($values));
}
public function update(Model $model): void
{
if (!$model->isDirty() and !$model->isNew()) {
return;
}
$values = $this->mapTable($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 = ?']);
$this->getConnection()->execute($query, $values);
}
public function create(array $data): Model
{
return $this->mapModel($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;
}
$m = 'set' . ucwords($col);
$model->{$m}($data[$col]);
}
}
return $model;
}
public function delete(Model $model): void
{
$query = $this->getQueryBuilder()->delete($this->getTable())->where(['id = ?']);
$this->getConnection()->execute($query, [$model->getId()]);
}
public function fetchById(int $id): Model
{
$query = $this->getQueryBuilder()
->select()
->from($this->getTable())
->where(['id = ?'])
->where([['id', '?']])
->limit(1);
return $this->load($this->getConnection()->execute($query, [$id])->getFirstAsArray());
return $this->load($this->getConnection()->execute($query, [$id])->getAsArray()[0]);
}
public function fetchAll(): array
{

View File

@ -1,13 +1,12 @@
<?php
namespace ProVM\Concept;
use JsonSerializable;
use ProVM\Concept\Model\Repository;
use ProVM\Concept\Model\Factory;
interface Model extends JsonSerializable
interface Model
{
public function setRepository(Repository $factory): Model;
public function getRepository(): Repository;
public function setFactory(Factory $factory): Model;
public function getFactory(): Factory;
public function setId(int $id): Model;
public function getId(): int;
public function setNew(): Model;
@ -16,5 +15,4 @@ interface Model extends JsonSerializable
public function isDirty(): bool;
public function save(): void;
public function edit(array $data): void;
public function delete(): void;
}

View File

@ -1,48 +1,13 @@
<?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;
public function setNamespace(string $namespace): Factory;
public function getNamespace(): string;
public function get(string $repository_name): Repository;
}

View File

@ -7,212 +7,22 @@ use ProVM\Concept\Model;
interface Repository
{
/**
* @return Connection
*/
public function getConnection(): Connection;
/**
* @return QueryBuilder
*/
public function getQueryBuilder(): QueryBuilder;
/**
* @return Factory
*/
public function getFactory(): Factory;
/**
* @return string
*/
public function getModel(): string;
/**
* @return string
*/
public function getTable(): string;
/**
* Get table columns
* @return array
*/
public function getColumns(): array;
/**
* Get required columns
* @return array
*/
public function getRequiredColumns(): array;
/**
* Get optional columns
* @return array
*/
public function getOptionalColumns(): array;
/**
* Get Model properties
* @return array
*/
public function getProperties(): array;
/**
* @param Connection $connection
* @return Repository
*/
public function setConnection(Connection $connection): Repository;
/**
* @param QueryBuilder $builder
* @return Repository
*/
public function getConnection(): Connection;
public function setQueryBuilder(QueryBuilder $builder): Repository;
/**
* @param Factory $factory
* @return Repository
*/
public function getQueryBuilder(): QueryBuilder;
public function setFactory(Factory $factory): Repository;
/**
* @param string $model_class
* @return Repository
*/
public function setModel(string $model_class): Repository;
/**
* @param string $table
* @return Repository
*/
public function setTable(string $table): Repository;
/**
* Set columns in table
* @param array $columns
* @return Repository
*/
public function setColumns(array $columns): Repository;
/**
* Set required columns
* Optional
* @param array $columns
* @return Repository
*/
public function setRequiredColumns(array $columns): Repository;
/**
* Set optional columns
* @param array $columns
* @return Repository
*/
public function setOptionalColumns(array $columns): Repository;
/**
* Set Model properties
* @param array $properties
* @return Repository
*/
public function setProperties(array $properties): Repository;
/**
* @param string $column
* @return Repository
*/
public function addColumn(string $column): Repository;
/**
* @param string $column
* @return Repository
*/
public function addRequiredColumn(string $column): Repository;
/**
* @param string $column
* @return Repository
*/
public function addOptionalColumn(string $column): Repository;
/**
* @param string $property
* @param $value
* @return Repository
*/
public function addProperty(string $property): Repository;
/**
* Set up the Repository
* SHOULD CALL
* setTable
* setColumns [setRequired, setOptional]
* setProperties
* setMapping
* setModel
* @return Repository
*/
public function getFactory(): Factory;
public function setup(): Repository;
/**
* Get clean empty Model
* @return Model
*/
public function getNewModel(): Model;
/**
* Get Model method
* @param string $property
* @param bool $get
* @return string
*/
public function getMethod(string $property, bool $get = true): string;
/**
* @param string $method
* @return string
*/
public function getProperty(string $method): string;
/**
* Fill empty Model with data
* @param Model $model
* @param array $data
* @return Model
*/
public function mapModel(Model $model, array $data): Model;
/**
* Fill data array with Model values. Accepts a preset data array
* @param Model $model
* @param array $data
* @return array
*/
public function mapTable(Model $model, array $data): array;
/**
* Transform result array to Model
* @param array $data
* @return Model
*/
public function setTable(string $table): Repository;
public function getTable(): string;
public function setColumns(array $columns): Repository;
public function addColumn(string $column): Repository;
public function getColumns(): array;
public function load(array $data): Model;
/**
* 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): void;
/**
* Create new Model with data
* @param array $data
* @return Model
*/
public function create(array $data): Model;
/**
* Edit Model with data
* @param Model $model
* @param array $data
* @return 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 create(array $data): Model;
public function fetchById(int $id): Model;
/**
* Fetch all Models
* @return array
*/
public function fetchAll(): array;
}

View File

@ -1,7 +1,6 @@
<?php
namespace ProVM\Implement\Model;
use ProVM\Concept\Model;
use Psr\Container\ContainerInterface;
use ProVM\Concept\Model\Factory as FactoryInterface;
use ProVM\Concept\Model\Repository;
@ -23,22 +22,25 @@ class Factory implements FactoryInterface
{
return $this->container;
}
public function get(string $repository_class): Repository
protected string $namespace;
public function setNamespace(string $namespace): FactoryInterface
{
return $this->getContainer()->get($repository_class);
$this->namespace = $namespace;
return $this;
}
public function getByModel(string $model_class): Repository
public function getNamespace(): string
{
$class = str_replace('Model', 'Repository', $model_class);
return $this->get($class);
return $this->namespace;
}
public function fetchById(string $model_class, int $id): Model
protected function buildRepository(string $repository_name): string
{
return $this->getByModel($model_class)->fetchById($id);
return implode("\\", [
$this->getNamespace(),
$repository_name
]);
}
public function fetchAll(string $model_class): array
public function get(string $repository_name): Repository
{
return $this->getByModel($model_class)->fetchAll();
return $this->getContainer()->get($this->buildRepository($repository_name));
}
}