ed81e31e09
- add users policy - correct readonly handle on crud - crud readonly callback support - crud readonly for belongsTo and belongsToMany
508 lines
17 KiB
PHP
508 lines
17 KiB
PHP
<?php
|
|
|
|
namespace App\Traits;
|
|
|
|
use App\Enums\CrudAction;
|
|
use App\Enums\CrudType;
|
|
use App\Exceptions\CrudException;
|
|
use App\Http\Requests\CrudRequest;
|
|
use Illuminate\Database\Eloquent\Relations\Relation;
|
|
use Illuminate\Support\Facades\DB;
|
|
use Illuminate\Support\Str;
|
|
use Kwaadpepper\Enum\BaseEnum;
|
|
|
|
trait IsCrudModel
|
|
{
|
|
|
|
protected static $editableProperties = [];
|
|
|
|
private static $schemaCrud = [
|
|
'label' => null,
|
|
'placeholder' => '',
|
|
'type' => null,
|
|
'enum' => null,
|
|
'nullable' => false,
|
|
'readonly' => false,
|
|
'disabled' => false,
|
|
'required' => false,
|
|
'validate' => [],
|
|
'rules' => [],
|
|
'actions' => [],
|
|
'belongsTo' => null,
|
|
'belongsToMany' => null,
|
|
'getAttribute' => null,
|
|
'setAttribute' => null
|
|
];
|
|
|
|
// OVERLOAD MODEL FUNCTION
|
|
public function __get($key)
|
|
{
|
|
if (
|
|
isset(static::$editableProperties[$key]['getAttribute']) and
|
|
is_callable(static::$editableProperties[$key]['getAttribute'])
|
|
) {
|
|
return static::$editableProperties[$key]['getAttribute']();
|
|
}
|
|
return parent::__get($key);
|
|
}
|
|
|
|
// OVERLOAD MODEL FUNCTION
|
|
public function __set($key, $value)
|
|
{
|
|
if (
|
|
isset(static::$editableProperties[$key]['setAttribute']) and
|
|
is_callable(static::$editableProperties[$key]['setAttribute'])
|
|
) {
|
|
return static::$editableProperties[$key]['setAttribute']($value);
|
|
}
|
|
return parent::__set($key, $value);
|
|
}
|
|
|
|
// OVERLOAD MODEL FUNCTION
|
|
public function fill(array $attributes)
|
|
{
|
|
foreach ($attributes as $k => $attribute) {
|
|
if (
|
|
isset(static::$editableProperties[$k]['setAttribute']) and
|
|
is_callable(static::$editableProperties[$k]['setAttribute'])
|
|
) {
|
|
$this->{$k} = $attribute;
|
|
}
|
|
}
|
|
parent::fill($attributes);
|
|
}
|
|
|
|
public function saveRelations(CrudRequest $request)
|
|
{
|
|
$validated = $request->validated();
|
|
$props = self::getEditableProperties();
|
|
foreach ($props as $k => $prop) {
|
|
if ($prop['belongsToMany'] and \is_array($validated[$k])) {
|
|
$this->{$k}()->sync($validated[$k]);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Has this model Has many relations with delete restrict ?
|
|
*
|
|
* @return bool|string
|
|
*/
|
|
public function gotHasManyRelationWithRestrictOnDelete()
|
|
{
|
|
$sm = DB::getDoctrineSchemaManager();
|
|
foreach (self::getRelationships() as $relation => $type) {
|
|
if ($type[0] === 'HasMany') {
|
|
$table = (new $type[1]())->getTable();
|
|
/** @var \Doctrine\DBAL\Schema\ForeignKeyConstraint $foreignKey */
|
|
foreach ($sm->listTableForeignKeys($table) as $foreignKey) {
|
|
// /vendor/doctrine/dbal/src/Schema/ForeignKeyConstraint.php onEvent()
|
|
if ($foreignKey->onDelete() === 'CASCADE') {
|
|
// allow only CASCADE action, otherwise it would break the app
|
|
continue;
|
|
}
|
|
return class_basename($type[1]);
|
|
}
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get the crud label
|
|
*/
|
|
public function getCrudLabelAttribute()
|
|
{
|
|
return $this->{$this->crudLabelColumn};
|
|
}
|
|
|
|
/**
|
|
* Get the crud value
|
|
*/
|
|
public function getCrudValueAttribute()
|
|
{
|
|
if (is_null($this->crudValueColumn)) {
|
|
throw new CrudException(sprintf(
|
|
'[\'belongsTo\'] model `%s` must have `crudValueColumn` property',
|
|
get_class($this),
|
|
CrudAction::class
|
|
));
|
|
}
|
|
return $this->{$this->crudValueColumn};
|
|
}
|
|
|
|
/**
|
|
* Get the crud label column
|
|
*/
|
|
public function getCrudLabelColumnAttribute()
|
|
{
|
|
if (is_null($this->crudLabelColumn)) {
|
|
throw new CrudException(sprintf(
|
|
'[\'belongsTo\'] model `%s` must have `crudLabelColumn` property',
|
|
get_class($this),
|
|
CrudAction::class
|
|
));
|
|
}
|
|
return $this->crudLabelColumn;
|
|
}
|
|
|
|
/**
|
|
* Get the crud value column
|
|
*/
|
|
public function getCrudValueColumnAttribute()
|
|
{
|
|
return $this->crudValueColumn;
|
|
}
|
|
|
|
/**
|
|
* Get the model validation rules
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function getRules(): array
|
|
{
|
|
return collect(static::$editableProperties)->mapWithKeys(function ($item, $key) {
|
|
$item = \array_merge(self::$schemaCrud, $item);
|
|
$defaultRules = [];
|
|
if (!$item['nullable']) {
|
|
$defaultRules[] = 'required';
|
|
} elseif ($item['required']) {
|
|
$defaultRules[] = 'required';
|
|
} elseif ($item['readonly']) {
|
|
$defaultRules[] = 'prohibited';
|
|
}
|
|
switch ($item['type']) {
|
|
case CrudType::boolean():
|
|
$defaultRules[] = 'boolean';
|
|
break;
|
|
case CrudType::email():
|
|
$defaultRules[] = 'email:rfc,dns';
|
|
break;
|
|
case CrudType::belongsTo():
|
|
$defaultRules[] = 'integer';
|
|
$defaultRules[] = 'min:0';
|
|
break;
|
|
case CrudType::int():
|
|
$defaultRules[] = 'integer';
|
|
break;
|
|
case CrudType::belongsToMany():
|
|
$defaultRules[] = 'array';
|
|
break;
|
|
case CrudType::password():
|
|
// phpcs:ignore Generic.Files.LineLength.TooLong
|
|
$defaultRules[] = "regex:/^(?=.*[A-Z])(?=.*[²&~\"#'\{\(\[\-|`_\\^@\)\°=+\}¨^\$£¤%?,;.:\/!§*<>])(?=.*[0-9].*)(?=.*[a-z]).{8,}$/";
|
|
break;
|
|
case CrudType::text():
|
|
case CrudType::string():
|
|
default:
|
|
$defaultRules[] = 'string';
|
|
break;
|
|
}
|
|
return [$key => array_merge($defaultRules, $item['validate'] ?? self::$schemaCrud['validate'])];
|
|
})->all();
|
|
}
|
|
|
|
/**
|
|
* Get the model Name
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getModelName(): string
|
|
{
|
|
return class_basename(get_class($this));
|
|
}
|
|
|
|
/**
|
|
* Get the Editable Properties
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function getEditableProperties(): array
|
|
{
|
|
static::assertEditablePropertiesIsCorrect();
|
|
return static::$editableProperties;
|
|
}
|
|
|
|
/**
|
|
* Assert self::$editableProperties is in a correct format
|
|
*
|
|
* 'string' => CrudType::value()
|
|
*
|
|
* @return void
|
|
* @throws Exception
|
|
*/
|
|
private static function assertEditablePropertiesIsCorrect(): void
|
|
{
|
|
if (empty(static::$editableProperties)) {
|
|
throw new CrudException('$editableProperties must be defined in ' . __CLASS__);
|
|
}
|
|
foreach (static::$editableProperties as $name => &$prop) {
|
|
if (!is_string($name)) {
|
|
throw new CrudException(sprintf(
|
|
'editableProperties array value must be an array given: %s',
|
|
print_r($prop, true) // phpcs:ignore Squiz.PHP.DiscouragedFunctions.Found
|
|
));
|
|
}
|
|
if (!is_array($prop)) {
|
|
throw new CrudException(sprintf(
|
|
'editableProperties array value must be an array given: %s',
|
|
print_r($prop, true) // phpcs:ignore Squiz.PHP.DiscouragedFunctions.Found
|
|
));
|
|
}
|
|
$prop = \array_merge(self::$schemaCrud, $prop);
|
|
|
|
// Auto label
|
|
$prop['label'] = $prop['label'] ?? ucfirst($name);
|
|
self::assertLabelIscorrect($prop);
|
|
self::assertPlaceholderIscorrect($prop);
|
|
self::assertTypeIscorrect($prop);
|
|
// Email auto rule
|
|
switch ($prop['type']) {
|
|
case CrudType::email():
|
|
$prop['validate'] = is_array($prop['validate']) ? $prop['rules'] : [];
|
|
$prop['validate'][] = 'email:rfc,dns';
|
|
break;
|
|
}
|
|
self::assertNullableIscorrect($prop);
|
|
self::assertReadonlyIscorrect($prop);
|
|
self::assertDisabledIscorrect($prop);
|
|
self::assertValidateIscorrect($prop);
|
|
self::assertRulesArecorrect($prop);
|
|
self::assertActionsArecorrect($prop);
|
|
self::assertBelongsToIsCorrect($prop);
|
|
self::assertEnumIscorrect($prop);
|
|
self::assertGetAttributeIscorrect($prop);
|
|
self::assertSetAttributeIscorrect($prop);
|
|
self::assertBelongsToManyIsCorrect($prop);
|
|
}
|
|
}
|
|
|
|
private static function assertLabelIscorrect(array $prop): void
|
|
{
|
|
if (!isset($prop['label']) or !is_string($prop['label'])) {
|
|
throw new CrudException('$editableProperties[\'label\'] array value must be a string');
|
|
}
|
|
}
|
|
|
|
private static function assertPlaceholderIscorrect(array $prop): void
|
|
{
|
|
if (!isset($prop['placeholder']) or !is_string($prop['placeholder'])) {
|
|
throw new CrudException('$editableProperties[\'placeholder\'] array value must be a string');
|
|
}
|
|
}
|
|
|
|
private static function assertTypeIscorrect(array $prop): void
|
|
{
|
|
if (!isset($prop['type']) or !is_object($prop['type']) or get_class($prop['type']) !== CrudType::class) {
|
|
throw new CrudException('$editableProperties[\'type\'] value must be a CrudType enum');
|
|
}
|
|
}
|
|
|
|
private static function assertNullableIscorrect(array $prop): void
|
|
{
|
|
if (!isset($prop['nullable']) or !is_bool($prop['nullable'])) {
|
|
throw new CrudException('$editableProperties[\'nullable\'] array value must be a boolean');
|
|
}
|
|
}
|
|
|
|
private static function assertReadonlyIscorrect(array $prop): void
|
|
{
|
|
if (
|
|
!isset($prop['readonly']) or
|
|
(!is_bool($prop['readonly']) and !\is_callable($prop['readonly']))
|
|
) {
|
|
throw new CrudException('$editableProperties[\'readonly\'] array value must be a boolean or a function returnning a boolean');
|
|
}
|
|
}
|
|
|
|
private static function assertDisabledIscorrect(array $prop): void
|
|
{
|
|
if (!isset($prop['disabled']) or !is_bool($prop['disabled'])) {
|
|
throw new CrudException('$editableProperties[\'disabled\'] array value must be a boolean');
|
|
}
|
|
}
|
|
|
|
private static function assertRequiredIscorrect(array $prop): void
|
|
{
|
|
if (!isset($prop['required']) or !is_bool($prop['required'])) {
|
|
throw new CrudException('$editableProperties[\'required\'] array value must be a boolean');
|
|
}
|
|
}
|
|
|
|
private static function assertValidateIscorrect(array $prop): void
|
|
{
|
|
if (!isset($prop['validate']) or !\is_array($prop['validate'])) {
|
|
throw new CrudException('$editableProperties[\'validate\'] array value must be an array');
|
|
}
|
|
}
|
|
|
|
private static function assertGetAttributeIscorrect(array $prop): void
|
|
{
|
|
if (!is_null($prop['getAttribute']) and !is_callable($prop['getAttribute'])) {
|
|
throw new CrudException('$editableProperties[\'getAttribute\'] array value must be callable');
|
|
}
|
|
}
|
|
|
|
private static function assertSetAttributeIscorrect(array $prop): void
|
|
{
|
|
if (!is_null($prop['setAttribute']) and !is_callable($prop['setAttribute'])) {
|
|
throw new CrudException('$editableProperties[\'setAttribute\'] array value must be callable');
|
|
}
|
|
}
|
|
|
|
private static function assertRulesArecorrect(array $prop): void
|
|
{
|
|
$allowedRules = [
|
|
'min' => function ($v) {
|
|
return \is_numeric($v);
|
|
},
|
|
'max' => function ($v) {
|
|
return \is_numeric($v);
|
|
},
|
|
'step' => function ($v) {
|
|
return \is_numeric($v);
|
|
},
|
|
];
|
|
if (!isset($prop['rules']) or !\is_array($prop['rules'])) {
|
|
throw new CrudException('$editableProperties[\'rules\'] array value must be an array');
|
|
}
|
|
if (count(array_diff_key($prop['rules'], $allowedRules))) {
|
|
throw new CrudException(sprintf(
|
|
'$editableProperties[\'rules\'] array contains unallowed rule, allowed are : %s',
|
|
implode(',', array_keys($allowedRules))
|
|
));
|
|
}
|
|
foreach ($allowedRules as $k => $f) {
|
|
if (array_key_exists($k, $prop['rules']) and !$f($prop['rules'][$k])) {
|
|
throw new CrudException(sprintf(
|
|
'$editableProperties[\'rules\'] rule `%s` does not validate with value `%s`',
|
|
$k,
|
|
$prop['rules'][$k]
|
|
));
|
|
}
|
|
}
|
|
}
|
|
|
|
private static function assertActionsArecorrect(array $prop): void
|
|
{
|
|
if (!isset($prop['actions']) or !\is_array($prop['actions'])) {
|
|
throw new CrudException('$editableProperties[\'actions\'] array value must be an array');
|
|
}
|
|
foreach ($prop['actions'] as $action) {
|
|
if (!is_object($action) or get_class($action) !== CrudAction::class) {
|
|
throw new CrudException(sprintf(
|
|
'$editableProperties[\'actions\'] array value must contain `%s` objects',
|
|
CrudAction::class
|
|
));
|
|
}
|
|
}
|
|
}
|
|
|
|
private static function assertEnumIscorrect(array $prop): void
|
|
{
|
|
if (
|
|
$prop['type']->equals(CrudType::enum()) and (is_null($prop['enum']) or
|
|
!\is_subclass_of($prop['enum'], BaseEnum::class))
|
|
) {
|
|
throw new CrudException(sprintf(
|
|
'$editableProperties[\'enum\'] array value must be an enum `%s`',
|
|
BaseEnum::class
|
|
));
|
|
}
|
|
}
|
|
|
|
private static function assertBelongsToIsCorrect(array $prop): void
|
|
{
|
|
if (is_null($prop['belongsTo'])) {
|
|
return;
|
|
}
|
|
if (
|
|
$prop['type']->equals(CrudType::belongsTo()) and
|
|
(!\is_string($prop['belongsTo']) or
|
|
!\class_exists($prop['belongsTo']) or
|
|
is_a($prop['belongsTo'], Model::class, true) or
|
|
!in_array(IsCrudModel::class, class_uses_recursive($prop['belongsTo'])))
|
|
) {
|
|
throw new CrudException(sprintf(
|
|
'$editableProperties[\'belongsTo\'] array value must be a CrudModel given: `%s`',
|
|
$prop['belongsTo']
|
|
));
|
|
}
|
|
}
|
|
|
|
private static function assertBelongsToManyIsCorrect(array $prop): void
|
|
{
|
|
if (is_null($prop['belongsToMany'])) {
|
|
return;
|
|
}
|
|
if (
|
|
$prop['type']->equals(CrudType::belongsToMany()) and
|
|
(!\is_string($prop['belongsToMany']) or
|
|
!\class_exists($prop['belongsToMany']) or
|
|
is_a($prop['belongsToMany'], Model::class, true) or
|
|
!in_array(IsCrudModel::class, class_uses_recursive($prop['belongsToMany'])))
|
|
) {
|
|
throw new CrudException(sprintf(
|
|
'$editableProperties[\'belongsToMany\'] array value must be a CrudModel given: `%s`',
|
|
$prop['belongsToMany']
|
|
));
|
|
}
|
|
if (
|
|
$prop['type']->equals(CrudType::belongsToMany()) and
|
|
(!\is_string($prop['belongsToManyLabel']))
|
|
) {
|
|
throw new CrudException(sprintf(
|
|
'$editableProperties[\'belongsToManyLabel\'] must be string using belongsToMany, given: `%s`',
|
|
$prop['belongsToMany']
|
|
));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get eloquent relationships
|
|
*
|
|
* @url https://laracasts.com/discuss/channels/eloquent/get-all-model-relationships
|
|
*
|
|
* @return array
|
|
*/
|
|
private static function getRelationships()
|
|
{
|
|
$instance = new static();
|
|
|
|
// Get public methods declared without parameters and non inherited
|
|
$class = get_class($instance);
|
|
$allMethods = (new \ReflectionClass($class))->getMethods(\ReflectionMethod::IS_PUBLIC);
|
|
$methods = array_filter(
|
|
$allMethods,
|
|
function ($method) use ($class) {
|
|
return $method->class === $class
|
|
&& !$method->getParameters() // relationships have no parameters
|
|
&& $method->getName() !== 'getRelationships' // prevent infinite recursion
|
|
&& $method->getName() !== 'gotHasManyRelationWithRestrictOnDelete'; // prevent infinite recursion
|
|
}
|
|
);
|
|
|
|
DB::beginTransaction();
|
|
|
|
$relations = [];
|
|
foreach ($methods as $method) {
|
|
try {
|
|
$methodName = $method->getName();
|
|
$methodReturn = $instance->$methodName();
|
|
if (!$methodReturn instanceof Relation) {
|
|
continue;
|
|
}
|
|
} catch (\Throwable $th) {
|
|
continue;
|
|
}
|
|
|
|
$type = (new \ReflectionClass($methodReturn))->getShortName();
|
|
$model = get_class($methodReturn->getRelated());
|
|
$relations[$methodName] = [$type, $model];
|
|
}
|
|
|
|
DB::rollBack();
|
|
|
|
return $relations;
|
|
}
|
|
}
|