Spiral\ORM\RecordEntity

Complexity

Total Complexity

97

Size/Duplication

Total Lines	912
Duplicated Lines	7.79 %

Coupling/Cohesion

Components	2
Dependencies	11

Importance

Changes	5
Bugs	0	Features	0

34 Methods

Rating	Name	Duplication	Size	Complexity
B	relation()	0	29	4
D	hasUpdates()	13	27	9
A	flushUpdates()	0	10	3
A	isValid()	0	6	2
A	getErrors()	0	4	1
A	__isset()	0	8	2
A	__unset()	0	4	1
A	__get()	0	9	2
A	__set()	0	11	2
A	__call()	0	9	2
A	__debugInfo()	0	15	2
A	sourceTable()	0	6	1
A	stateCriteria()	0	9	2
A	container()	0	8	2
C	compileUpdates()	9	32	8
B	validate()	24	24	4
A	create()	12	12	1
A	loadedState()	0	6	1
A	ormSchema()	0	4	1
A	isEmbedded()	0	6	1
B	solidUpdate()	8	18	5
B	validateRelations()	0	13	5
B	__construct()	0	32	5
B	setContext()	0	23	5
A	solidState()	0	14	3
A	isSolid()	0	4	1
A	recordRole()	0	4	1
A	primaryKey()	0	6	2
A	isLoaded()	0	4	2
A	isDeleted()	0	4	1
A	getPivot()	0	4	1
A	setFields()	0	20	4
B	setField()	5	21	6
B	getField()	0	16	5

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */
namespace Spiral\ORM;

use Spiral\Core\Exceptions\SugarException;
use Spiral\Core\Traits\SaturateTrait;
use Spiral\Database\Entities\Table;
use Spiral\Models\AccessorInterface;
use Spiral\Models\EntityInterface;
use Spiral\Models\Events\EntityEvent;
use Spiral\Models\Exceptions\AccessorExceptionInterface;
use Spiral\Models\SchematicEntity;
use Spiral\ORM\Exceptions\RecordException;
use Spiral\ORM\Exceptions\RelationException;
use Spiral\Validation\ValidatesInterface;

/**
 * Record is base data entity for ORM component, it used to describe related table schema,
 * filters, validations and relations to other records. You can count Record class as ActiveRecord
 * pattern. ORM component will automatically analyze existed Documents and create cached version of
 * their schema.
 *
 * @TODO: Add ability to set primary key manually, for example fpr uuid like fields.
 */
class RecordEntity extends SchematicEntity implements RecordInterface
{
    /**
     * Static container fallback.
     */
    use SaturateTrait;

    /**
     * Field format declares how entity must process magic setters and getters. Available values:
     * camelCase, tableize.
     */
    const FIELD_FORMAT = 'tableize';

    /**
     * We are going to inherit parent validation rules, this will let spiral translator know about
     * it and merge i18n messages.
     *
     * @see TranslatorTrait
     */
    const I18N_INHERIT_MESSAGES = true;

    /**
     * ORM records are be divided by two sections: active and passive records. When record is active
     * ORM allowed to modify associated record table using declared schema and created relations.
     *
     * Passive records (ACTIVE_SCHEMA = false) however can only read table schema from database and
     * forbidden to do any schema modification either by record or by relations.
     *
     * You can use ACTIVE_SCHEMA = false in cases where you need to create an ActiveRecord for
     * existed table.
     *
     * @see RecordSchema
     * @see \Spiral\ORM\Entities\SchemaBuilder
     */
    const ACTIVE_SCHEMA = true;

    /**
     * Indication that record were deleted.
     */
    const DELETED = 900;

    /**
     * Default ORM relation types, see ORM configuration and documentation for more information,
     * i had to remove 200 lines of comments to make record little bit smaller.
     *
     * @see RelationSchemaInterface
     * @see RelationSchema
     */
    const HAS_ONE      = 101;
    const HAS_MANY     = 102;
    const BELONGS_TO   = 103;
    const MANY_TO_MANY = 104;

    /**
     * Morphed relation types are usually created by inversion or equivalent of primary relation
     * types.
     *
     * @see RelationSchemaInterface
     * @see RelationSchema
     * @see MorphedRelation
     */
    const BELONGS_TO_MORPHED = 108;
    const MANY_TO_MORPHED    = 109;

    /**
     * Constants used to declare relations in record schema, used in normalized relation schema.
     *
     * @see RelationSchemaInterface
     */
    const OUTER_KEY         = 901; //Outer key name
    const INNER_KEY         = 902; //Inner key name
    const MORPH_KEY         = 903; //Morph key name
    const PIVOT_TABLE       = 904; //Pivot table name
    const PIVOT_COLUMNS     = 905; //Pre-defined pivot table columns
    const PIVOT_DEFAULTS    = 906; //Pre-defined pivot table default values
    const THOUGHT_INNER_KEY = 907; //Pivot table options
    const THOUGHT_OUTER_KEY = 908; //Pivot table options
    const WHERE             = 909; //Where conditions
    const WHERE_PIVOT       = 910; //Where pivot conditions

    /**
     * Additional constants used to control relation schema behaviour.
     *
     * @see Record::$schema
     * @see RelationSchemaInterface
     */
    const INVERSE           = 1001; //Relation should be inverted to parent record
    const CONSTRAINT        = 1002; //Relation should create foreign keys (default)
    const CONSTRAINT_ACTION = 1003; //Default relation foreign key delete/update action (CASCADE)
    const CREATE_PIVOT      = 1004; //Many-to-Many should create pivot table automatically (default)
    const NULLABLE          = 1005; //Relation can be nullable (default)
    const CREATE_INDEXES    = 1006; //Indication that relation is allowed to create required indexes
    const MORPHED_ALIASES   = 1007; //Aliases for morphed sub-relations

    /**
     * Relations marked as embedded will be automatically saved/validated with parent model. In
     * addition such models data can be set using setFields method (only for ONE relations).
     *
     * @see setFields()
     * @see save()
     * @see validate()
     */
    const EMBEDDED_RELATION = 1008;

    /**
     * Constants used to declare indexes in record schema.
     *
     * @see Record::$indexes
     */
    const INDEX  = 1000;            //Default index type
    const UNIQUE = 2000;            //Unique index definition

    /**
     * Errors in relations and acessors.
     *
     * @var array
     */
    private $nestedErrors = [];

    /**
     * Indicates that record data were loaded from database (not recently created).
     *
     * @var bool
     */
    private $loaded = false;

    /**
     * Schema provided by ORM component.
     *
     * @var array
     */
    private $ormSchema = [];

    /**
     * SolidState will force record data to be saved as one big update set without any generating
     * separate update statements for changed columns.
     *
     * @var bool
     */
    private $solidState = false;

    /**
     * Populated when record loaded using many-to-many connection. Property will include every
     * column of connection row in pivot table.
     *
     * @see setContext()
     * @see getPivot();
     * @var array
     */
    private $pivotData = [];

    /**
     * Record field updates (changed values).
     *
     * @var array
     */
    private $updates = [];

    /**
     * Constructed and pre-cached set of record relations. Relation will be in a form of data array
     * to be created on demand.
     *
     * @see relation()
     * @see __call()
     * @see __set()
     * @see __get()
     * @var RelationInterface[]|array
     */
    protected $relations = [];

    /**
     * Table name (without database prefix) record associated to, RecordSchema will generate table
     * name automatically using class name, however i'm strongly recommend to declare table name
     * manually as it gives more readable code.
     *
     * @var string
     */
    protected $table = null;

    /**
     * Database name/id where record table located in. By default database will be used if nothing
     * else is specified.
     *
     * @var string|null
     */
    protected $database = null;

    /**
     * Set of indexes to be created for associated record table, indexes only created when record is
     * not abstract and has active schema set to true.
     *
     * Use constants INDEX and UNIQUE to describe indexes, you can also create compound indexes:
     * protected $indexes = [
     *      [self::UNIQUE, 'email'],
     *      [self::INDEX, 'board_id'],
     *      [self::INDEX, 'board_id', 'check_id']
     * ];
     *
     * @var array
     */
    protected $indexes = [];

    /**
     * Record relations and columns can be described in one place - record schema.
     * Attention: while defining table structure make sure that ACTIVE_SCHEMA constant is set to t
     * rue.
     *
     * Example:
     * protected $schema = [
     *      'id'        => 'primary',
     *      'name'      => 'string',
     *      'biography' => 'text'
     * ];
     *
     * You can pass additional options for some of your columns:
     * protected $schema = [
     *      'pinCode' => 'string(128)',         //String length
     *      'status'  => 'enum(active, hidden)', //Enum values
     *      'balance' => 'decimal(10, 2)'       //Decimal size and precision
     * ];
     *
     * Every created column will be stated as NOT NULL with forced default value, if you want to
     * have nullable columns, specify special data key: protected $schema = [
     *      'name'      => 'string, nullable'
     * ];
     *
     * You can easily combine table and relations definition in one schema:
     * protected $schema = [
     *
     *      //Table schema
     *      'id'          => 'bigPrimary',
     *      'name'        => 'string',
     *      'email'       => 'string',
     *      'phoneNumber' => 'string(32)',
     *
     *      //Relations
     *      'profile'     => [
     *          self::HAS_ONE => 'Records\Profile',
     *          self::INVERSE => 'user'
     *      ],
     *      'roles'       => [
     *          self::MANY_TO_MANY => 'Records\Role',
     *          self::INVERSE => 'users'
     *      ]
     * ];
     *
     * @var array
     */
    protected $schema = [];

    /**
     * Default field values.
     *
     * @var array
     */
    protected $defaults = [];

    /**
     * @invisible
     * @var ORM
     */
    protected $orm = null;

    /**
     * Due setContext() method and entity cache of ORM any custom initiation code in constructor
     * must not depends on database data.
     *
     * @see setContext
     * @param array      $data
     * @param bool|false $loaded
     * @param ORM|null   $orm
     * @param array      $ormSchema
     * @throws SugarException
     */
    public function __construct(
        array $data = [],
        $loaded = false,
        ORM $orm = null,
        array $ormSchema = []
    ) {
        $this->loaded = $loaded;

        //We can use global container as fallback if no default values were provided
        $this->orm = $this->saturate($orm, ORM::class);

        $this->ormSchema = !empty($ormSchema) ? $ormSchema : $this->orm->schema(static::class);

        if (isset($data[ORM::PIVOT_DATA])) {
            $this->pivotData = $data[ORM::PIVOT_DATA];
            unset($data[ORM::PIVOT_DATA]);
        }

        foreach (array_intersect_key($data,
            $this->ormSchema[ORM::M_RELATIONS]) as $name => $relation) {
            $this->relations[$name] = $relation;
            unset($data[$name]);
        }

        //Data is initiated as default values and non default
        parent::__construct($data + $this->ormSchema[ORM::M_COLUMNS], $this->ormSchema);

        if (!$this->isLoaded()) {
            //Non loaded records should be in solid state by default and require initial validation
            $this->solidState(true)->invalidate();
        }
    }

    /**
     * Record context must be updated in cases where single record instance can be accessed from
     * multiple places, context will not change record fields but might overwrite pivot data or
     * clarify loaded relations.
     *
     * @param array $context
     * @return $this
     */
    public function setContext(array $context)
    {
        //Mounting context pivot data
        $this->pivotData = isset($context[ORM::PIVOT_DATA]) ? $context[ORM::PIVOT_DATA] : [];

        $relations = array_intersect_key($context, $this->ormSchema[ORM::M_RELATIONS]);
        foreach ($relations as $name => $relation) {
            if (!isset($this->relations[$name]) || is_array($this->relations[$name])) {
                //Does not exists and never requested before
                $this->relations[$name] = $relation;
                continue;
            }

            //We have to reset relation state to update context
            $this->relations[$name]->reset($relation, true);
        }

        /**
         * We are not going to update record fields.
         */

        return $this;
    }

    /**
     * Change record solid state. SolidState will force record data to be saved as one big update
     * set without any generating separate update statements for changed columns.
     *
     * Attention, you have to carefully use forceUpdate flag with records without primary keys due
     * update criteria (WHERE condition) can not be easy constructed for records with primary key.
     *
     * @param bool $solidState
     * @param bool $forceUpdate Mark all fields as changed to force update later.
     * @return $this
     */
    public function solidState($solidState, $forceUpdate = false)
    {
        $this->solidState = $solidState;

        if ($forceUpdate) {
            if ($this->ormSchema[ORM::M_PRIMARY_KEY]) {
                $this->updates = $this->stateCriteria();
            } else {
                $this->updates = $this->ormSchema[ORM::M_COLUMNS];
            }
        }

        return $this;
    }

    /**
     * Is record is solid state?
     *
     * @see solidState()
     * @return bool
     */
    public function isSolid()
    {
        return $this->solidState;
    }

    /**
     * {@inheritdoc}
     */
    public function recordRole()
    {
        return $this->ormSchema[ORM::M_ROLE_NAME];
    }

    /**
     * {@inheritdoc}
     */
    public function primaryKey()
    {
        return isset($this->fields[$this->ormSchema[ORM::M_PRIMARY_KEY]])
            ? $this->fields[$this->ormSchema[ORM::M_PRIMARY_KEY]]
            : null;
    }

    /**
     * {@inheritdoc}
     */
    public function isLoaded()
    {
        return (bool)$this->loaded && !$this->isDeleted();
    }

    /**
     * {@inheritdoc}
     */
    public function isDeleted()
    {
        return $this->loaded === self::DELETED;
    }

    /**
     * Pivot data associated with record instance, populated only in cases when record loaded using
     * Many-to-Many relation.
     *
     * @return array
     */
    public function getPivot()
    {
        return $this->pivotData;
    }

    /**
     * {@inheritdoc}
     *
     * @see   $fillable
     * @see   $secured
     * @see   isFillable()
     * @param array|\Traversable $fields
     * @param bool               $all Fill all fields including non fillable.
     * @return $this
     * @throws AccessorExceptionInterface
     * @event setFields($fields)
     */
    public function setFields($fields = [], $all = false)
    {
        parent::setFields($fields, $all);

        foreach ($fields as $name => $nested) {
            //We can fill data of embedded of relations (usually HAS ONE)
            if ($this->isEmbedded($name)) {
                //Getting relation instance
                $relation = $this->relation($name);

                //Getting related object
                $related = $relation->getRelated();
                if ($related instanceof EntityInterface) {
                    $related->setFields($nested);
                }
            }
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     *
     * Must track field updates. In addition Records will not allow to set unknown field.
     *
     * @throws RecordException
     */
    public function setField($name, $value, $filter = true)
    {
        if (!$this->hasField($name)) {
            throw new RecordException("Undefined field '{$name}' in '" . static::class . "'.");
        }

        //Original values with no filters
        $original = parent::getField($name, null, false);

It seems like you call parent on a different method (getField() instead of setField()). Are you sure this is correct? If so, you might want to change this to $this->getField().

        if ($value === null && in_array($name, $this->ormSchema[ORM::M_NULLABLE])) {
            //We must bypass setters and accessors when null value assigned to nullable column
            $this->setField($name, null, false);
        } else {
            parent::setField($name, $value, $filter);
        }

        if (!array_key_exists($name, $this->updates)) {

This code seems to be duplicated across your project.

            $this->updates[$name] = $original instanceof AccessorInterface
                ? $original->serializeData()
                : $original;
        }
    }

    /**
     * {@inheritdoc}
     *
     * Record will skip filtration for nullable fields.
     */
    public function getField($name, $default = null, $filter = true)
    {
        if (!$this) {
            throw new RecordException("Undefined field '{$name}' in '" . static::class . "'.");
        }

        $value = $this->fields[$name];
        if ($value === null && in_array($name, $this->ormSchema[ORM::M_NULLABLE])) {
            if (!isset($this->ormSchema[ORM::M_MUTATORS]['accessor'][$name])) {
                //We can skip setters for null values, but not accessors
                return $value;
            }
        }

        return parent::getField($name, $default, $filter);
    }

    /**
     * Get or create record relation by it's name and pre-loaded (optional) set of data.
     *
     * @param string $name
     * @param mixed  $data
     * @param bool   $loaded
     * @return RelationInterface
     * @throws RelationException
     * @throws RecordException
     */
    public function relation($name, $data = null, $loaded = false)
    {
        if (array_key_exists($name, $this->relations)) {
            if (!is_object($this->relations[$name])) {
                $data = $this->relations[$name];
                unset($this->relations[$name]);

                //Loaded relation
                return $this->relation($name, $data, true);
            }

            //Already created
            return $this->relations[$name];
        }


        //Constructing relation
        if (!isset($this->ormSchema[ORM::M_RELATIONS][$name])) {
            throw new RecordException(
                "Undefined relation {$name} in record " . static::class . "."
            );
        }

        $relation = $this->ormSchema[ORM::M_RELATIONS][$name];

        return $this->relations[$name] = $this->orm->relation(
            $relation[ORM::R_TYPE], $this, $relation[ORM::R_DEFINITION], $data, $loaded
        );
    }

    /**
     * {@inheritdoc}
     *
     * @param string $field Specific field name to check for updates.
     */
    public function hasUpdates($field = null)
    {
        if (empty($field)) {

This code seems to be duplicated across your project.

            if (!empty($this->updates)) {
                return true;
            }

            foreach ($this->fields as $field => $value) {
                if ($value instanceof RecordAccessorInterface && $value->hasUpdates()) {
                    return true;
                }
            }

            return false;
        }

        if (array_key_exists($field, $this->updates)) {
            return true;
        }

        $value = $this->getField($field);
        if ($value instanceof RecordAccessorInterface && $value->hasUpdates()) {
            return true;
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function flushUpdates()
    {
        $this->updates = [];

        foreach ($this->fields as $value) {
            if ($value instanceof RecordAccessorInterface) {
                $value->flushUpdates();
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    public function isValid()
    {
        $this->validate();

        return empty($this->errors) && empty($this->nestedErrors);
    }

    /**
     * {@inheritdoc}
     */
    public function getErrors($reset = false)
    {
        return parent::getErrors($reset) + $this->nestedErrors;
    }

    /**
     * {@inheritdoc}
     */
    public function __isset($name)
    {
        if (isset($this->ormSchema[ORM::M_RELATIONS][$name])) {
            return !empty($this->relation($name)->getRelated());
        }

        return parent::__isset($name);
    }

    /**
     * {@inheritdoc}
     *
     * @throws RecordException
     */
    public function __unset($offset)
    {
        throw new RecordException("Records fields can not be unsetted.");
    }

    /**
     * {@inheritdoc}
     *
     * @see relation()
     */
    public function __get($offset)
    {
        if (isset($this->ormSchema[ORM::M_RELATIONS][$offset])) {
            //Bypassing call to relation
            return $this->relation($offset)->getRelated();
        }

        return $this->getField($offset, true);
    }

    /**
     * {@inheritdoc}
     *
     * @see relation()
     */
    public function __set($offset, $value)
    {
        if (isset($this->ormSchema[ORM::M_RELATIONS][$offset])) {
            //Bypassing call to relation
            $this->relation($offset)->associate($value);

            return;
        }

        $this->setField($offset, $value, true);
    }

    /**
     * Direct access to relation by it's name.
     *
     * @see relation()
     * @param string $method
     * @param array  $arguments
     * @return RelationInterface|mixed|AccessorInterface
     */
    public function __call($method, array $arguments)
    {
        if (isset($this->ormSchema[ORM::M_RELATIONS][$method])) {
            return $this->relation($method);
        }

        //See FIELD_FORMAT constant
        return parent::__call($method, $arguments);
    }

    /**
     * @return Object
     */
    public function __debugInfo()
    {
        $info = [
            'table'     => $this->ormSchema[ORM::M_DB] . '/' . $this->ormSchema[ORM::M_TABLE],
            'pivotData' => $this->pivotData,
            'fields'    => $this->getFields(),
            'errors'    => $this->getErrors()
        ];

        if (empty($this->pivotData)) {
            unset($info['pivotData']);
        }

        return (object)$info;
    }

    /**
     * Get associated Database\Table instance.
     *
     * @see save()
     * @see delete()
     * @return Table
     */
    protected function sourceTable()
    {
        return $this->orm->database($this->ormSchema[ORM::M_DB])->table(
            $this->ormSchema[ORM::M_TABLE]
        );
    }

    /**
     * Get WHERE array to be used to perform record data update or deletion. Usually will include
     * record primary key.
     *
     * @return array
     */
    protected function stateCriteria()
    {
        if (!empty($primaryKey = $this->ormSchema()[ORM::M_PRIMARY_KEY])) {
            return [$primaryKey => $this->primaryKey()];
        }

        //We have to serialize record data
        return $this->updates + $this->serializeData();
    }

    /**
     * {@inheritdoc}
     */
    protected function container()
    {
        if (empty($this->orm)) {
            return parent::container();
        }

        return $this->orm->container();

The method container() cannot be called from this context as it is declared protected in class Spiral\Core\Component.

    }

    /**
     * Create set of fields to be sent to UPDATE statement.
     *
     * @see save()
     * @return array
     */
    protected function compileUpdates()
    {
        if (!$this->hasUpdates() && !$this->isSolid()) {
            return [];
        }

        if ($this->isSolid()) {
            return $this->solidUpdate();
        }

        $updates = [];
        foreach ($this->fields as $field => $value) {
            if ($value instanceof RecordAccessorInterface) {

This code seems to be duplicated across your project.

                if ($value->hasUpdates()) {
                    $updates[$field] = $value->compileUpdates($field);
                    continue;
                }

                //Will be handled as normal update if needed
                $value = $value->serializeData();
            }

            if (array_key_exists($field, $this->updates)) {
                $updates[$field] = $value;
            }
        }

        //Primary key should not present in update set
        unset($updates[$this->ormSchema[ORM::M_PRIMARY_KEY]]);

        return $updates;
    }

    /**
     * {@inheritdoc}
     *
     * Will validate every loaded and embedded relation.
     */
    protected function validate($reset = false)

This method seems to be duplicated in your project.

    {
        $this->nestedErrors = [];

        //Validating all compositions/accessors
        foreach ($this->fields as $field => $value) {
            //Ensuring value state
            $value = $this->getField($field);
            if (!$value instanceof ValidatesInterface) {
                continue;
            }

            if (!$value->isValid()) {
                $this->nestedErrors[$field] = $value->getErrors($reset);
            }
        }

        //We have to validate some relations before saving them
        $this->validateRelations($reset);

        parent::validate($reset);

        return empty($this->errors + $this->nestedErrors);
    }

    /**
     * {@inheritdoc}
     *
     * @see   Component::staticContainer()
     * @param array $fields Record fields to set, will be passed thought filters.
     * @param ORM   $orm    ORM component, global container will be called if not instance provided.
     * @event created()
     */
    public static function create($fields = [], ORM $orm = null)

This method seems to be duplicated in your project.

    {
        /**
         * @var RecordEntity $record
         */
        $record = new static([], false, $orm);

        //Forcing validation (empty set of fields is not valid set of fields)
        $record->setFields($fields)->dispatch('created', new EntityEvent($record));

        return $record;
    }

    /**
     * Change record loaded state.
     *
     * @param bool|mixed $loader
     * @return $this
     */
    protected function loadedState($loader)
    {
        $this->loaded = $loader;

        return $this;
    }

    /**
     * Related and cached ORM schema.
     *
     * @return array
     */
    protected function ormSchema()
    {
        return $this->ormSchema;
    }

    /**
     * Check if relation is embedded.
     *
     * @param string $relation
     * @return bool
     */
    protected function isEmbedded($relation)
    {
        return !empty(
        $this->ormSchema[ORM::M_RELATIONS][$relation][ORM::R_DEFINITION][self::EMBEDDED_RELATION]
        );
    }

    /**
     * Full structure update.
     *
     * @return array
     */
    private function solidUpdate()
    {
        $updates = [];
        foreach ($this->fields as $field => $value) {
            if ($value instanceof RecordAccessorInterface && $value->hasUpdates()) {

This code seems to be duplicated across your project.

                if ($value->hasUpdates()) {
                    $updates[$field] = $value->compileUpdates($field);
                } else {
                    $updates[$field] = $value->serializeData();
                }
                continue;
            }

            $updates[$field] = $value;
        }

        return $updates;
    }

    /**
     * Validate embedded relations.
     *
     * @param bool $reset
     */
    private function validateRelations($reset)
    {
        foreach ($this->relations as $name => $relation) {
            if (!$relation instanceof ValidatesInterface) {
                //Never constructed
                continue;
            }

            if ($this->isEmbedded($name) && !$relation->isValid()) {
                $this->nestedErrors[$name] = $relation->getErrors($reset);
            }
        }
    }
}