Spiral\Models\AbstractEntity

Complexity

Total Complexity

57

Size/Duplication

Total Lines	330
Duplicated Lines	0 %

Test Coverage

Coverage

98.02%

Importance

Changes

0

27 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	setValue()	0	3	1
A	offsetSet()	0	3	1
A	isNullable()	0	3	1
A	offsetUnset()	0	3	1
A	createValue()	0	14	3
A	__unset()	0	3	1
A	getFields()	0	8	2
A	offsetExists()	0	3	1
A	__set()	0	3	1
A	flushFields()	0	3	1
A	setMutated()	0	12	3
A	jsonSerialize()	0	3	1
A	getKeys()	0	3	1
A	getMutated()	0	14	4
A	__destruct()	0	3	1
A	getValue()	0	8	3
A	thoughValue()	0	14	3
B	setFields()	0	17	7
A	__get()	0	3	1
A	hasField()	0	7	3
A	setField()	0	28	6
A	__isset()	0	3	1
A	toArray()	0	3	1
A	getIterator()	0	3	1
A	getField()	0	18	6
A	offsetGet()	0	3	1

<?php

declare(strict_types=1);

namespace Spiral\Models;

use Spiral\Models\Exception\AccessException;
use Spiral\Models\Exception\AccessExceptionInterface;
use Spiral\Models\Exception\EntityException;

/**
 * AbstractEntity with ability to define field mutators and access
 *
 * @implements \IteratorAggregate<string, mixed>
 */
abstract class AbstractEntity implements EntityInterface, ValueInterface, \IteratorAggregate
{
    public function __construct(
        private array $fields = []
    ) {
    }

    /**
     * Destruct data entity.
     */
    public function __destruct()
    {
        $this->flushFields();
    }

    public function __isset(string $offset): bool
    {
        return $this->hasField($offset);
    }

    public function __get(string $offset): mixed
    {
        return $this->getField($offset);
    }

    public function __set(string $offset, mixed $value): void
    {
        $this->setField($offset, $value);
    }

    public function __unset(string $offset): void
    {
        unset($this->fields[$offset]);
    }

    public function hasField(string $name): bool
    {
        if (!\array_key_exists($name, $this->fields)) {
            return false;
        }

        return $this->fields[$name] !== null || $this->isNullable($name);
    }

    /**
     * @param bool $filter If false, associated field setter or accessor will be ignored.
     *
     * @throws AccessException
     */
    public function setField(string $name, mixed $value, bool $filter = true): self
    {
        if ($value instanceof ValueInterface) {
            //In case of non scalar values filters must be bypassed (check accessor compatibility?)
            $this->fields[$name] = clone $value;

            return $this;
        }

        if (!$filter || (\is_null($value) && $this->isNullable($name))) {
            //Bypassing all filters
            $this->fields[$name] = $value;

            return $this;
        }

        //Checking if field have accessor
        $accessor = $this->getMutator($name, ModelSchema::MUTATOR_ACCESSOR);

        if ($accessor !== null) {
            //Setting value thought associated accessor
            $this->thoughValue($accessor, $name, $value);
        } else {
            //Setting value thought setter filter (if any)
            $this->setMutated($name, $value);
        }

        return $this;
    }

    /**
     * @param bool $filter If false, associated field getter will be ignored.
     *
     * @throws AccessException
     */
    public function getField(string $name, mixed $default = null, bool $filter = true): mixed
    {
        $value = $this->hasField($name) ? $this->fields[$name] : $default;

        if ($value instanceof ValueInterface || (\is_null($value) && $this->isNullable($name))) {
            //Direct access to value when value is accessor or null and declared as nullable
            return $value;
        }

        //Checking if field have accessor (decorator)
        $accessor = $this->getMutator($name, ModelSchema::MUTATOR_ACCESSOR);

        if (!empty($accessor)) {
            return $this->fields[$name] = $this->createValue($accessor, $name, $value);
        }

        //Getting value though getter
        return $this->getMutated($name, $filter, $value);
    }

    /**
     * @param bool $all Fill all fields including non fillable.
     *
     * @throws AccessException
     *
     * @see   $secured
     * @see   isFillable()
     * @see   $fillable
     */
    public function setFields(iterable $fields = [], bool $all = false): self
    {
        if (!\is_array($fields) && !$fields instanceof \Traversable) {
            return $this;
        }

        foreach ($fields as $name => $value) {
            if ($all || $this->isFillable($name)) {
                try {
                    $this->setField($name, $value, true);
                } catch (AccessExceptionInterface) {
                    // We are suppressing field setting exceptions
                }
            }
        }

        return $this;
    }

    /**
     * Every getter and accessor will be applied/constructed if filter argument set to true.
     *
     * @throws AccessException
     */
    public function getFields(bool $filter = true): array
    {
        $result = [];
        foreach (\array_keys($this->fields) as $name) {
            $result[$name] = $this->getField($name, null, $filter);
        }

        return $result;
    }

    public function offsetExists(mixed $offset): bool
    {
        return $this->__isset($offset);
    }

    public function offsetGet(mixed $offset): mixed
    {
        return $this->getField($offset);
    }

    public function offsetSet(mixed $offset, mixed $value): void
    {
        $this->setField($offset, $value);
    }

    public function offsetUnset(mixed $offset): void
    {
        $this->__unset($offset);
    }

    public function getIterator(): \Iterator
    {
        return new \ArrayIterator($this->getFields());
    }

    /**
     * AccessorInterface dependency.
     */
    public function setValue(mixed $data): self
    {
        return $this->setFields($data);
    }

    /**
     * Pack entity fields into plain array.
     *
     * @throws AccessException
     */
    public function getValue(): array
    {
        $result = [];
        foreach ($this->fields as $field => $value) {
            $result[$field] = $value instanceof ValueInterface ? $value->getValue() : $value;
        }

        return $result;
    }

    /**
     * Alias for packFields.
     */
    public function toArray(): array
    {
        return $this->getValue();
    }

    /**
     * By default use publicFields to be json serialized.
     */
    public function jsonSerialize(): array
    {
        return $this->getValue();
    }

    /**
     * @return int[]|string[]
     *
     * @psalm-return list<array-key>
     */
    protected function getKeys(): array
    {
        return \array_keys($this->fields);
    }

    /**
     * Reset every field value.
     */
    protected function flushFields(): void
    {
        $this->fields = [];
    }

    /**
     * Check if field is fillable.
     */
    abstract protected function isFillable(string $field): bool;

    /**
     * Get mutator associated with given field.
     *
     * @param string $type See MUTATOR_* constants
     */
    abstract protected function getMutator(string $field, string $type): mixed;

    /**
     * Nullable fields would not require automatic accessor creation.
     */
    protected function isNullable(string $field): bool

The parameter $field is not used and could be removed.

    {
        return false;
    }

    /**
     * Create instance of field accessor.
     *
     * @param mixed|string $type    Might be entity implementation specific.
     * @param array        $context Custom accessor context.
     *
     * @throws AccessException
     * @throws EntityException
     */
    protected function createValue(
        $type,
        string $name,
        mixed $value,
        array $context = []
    ): ValueInterface {
        if (!\is_string($type) || !\class_exists($type)) {
            throw new EntityException(
                \sprintf('Unable to create accessor for field `%s` in ', $name) . static::class
            );
        }

        // field as a context, this is the default convention
        return new $type($value, $context + ['field' => $name, 'entity' => $this]);
    }

    /**
     * Get value thought associated mutator.
     */
    private function getMutated(string $name, bool $filter, mixed $value): mixed
    {
        $getter = $this->getMutator($name, ModelSchema::MUTATOR_GETTER);

        if ($filter && !empty($getter)) {
            try {
                return \call_user_func($getter, $value);
            } catch (\Exception) {
                //Trying to filter null value, every filter must support it
                return \call_user_func($getter, null);
            }
        }

        return $value;
    }

    /**
     * Set value thought associated mutator.
     */
    private function setMutated(string $name, mixed $value): void
    {
        $setter = $this->getMutator($name, ModelSchema::MUTATOR_SETTER);

        if (!empty($setter)) {
            try {
                $this->fields[$name] = \call_user_func($setter, $value);
            } catch (\Exception) {
                //Exceptional situation, we are choosing to keep original field value
            }
        } else {
            $this->fields[$name] = $value;
        }
    }

    /**
     * Set value in/thought associated accessor.
     *
     * @param string|array $type Accessor definition (implementation specific).
     */
    private function thoughValue(array|string $type, string $name, mixed $value): void
    {
        $field = $this->fields[$name] ?? null;

        if (empty($field) || !($field instanceof ValueInterface)) {
            //New field representation
            $field = $this->createValue($type, $name, $value);

            //Save accessor with other fields
            $this->fields[$name] = $field;
        }

        //Letting accessor to set value
        $field->setValue($value);
    }
}