samsonframework\orm\Record

Complexity

Total Complexity

34

Size/Duplication

Total Lines	326
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	18	2
A	byID()	0	16	3
A	oneByColumn()	0	7	1
A	collectionByColumn()	0	7	1
A	delete()	0	7	2
A	filled()	0	4	1
A	__clone()	0	11	1
B	save()	0	29	5
A	create()	0	3	1
A	toView()	0	19	4
B	copy()	0	27	3
A	__isset()	0	4	1
A	__set()	0	4	1
A	__get()	0	4	1
A	offsetSet()	0	9	2
A	offsetGet()	0	9	2
A	offsetUnset()	0	4	1
A	offsetExists()	0	4	2

<?php declare(strict_types=1);
namespace samsonframework\orm;

use samsonframework\core\RenderInterface;

/**
 * ORM Active record class.
 *
 * @author Vitaly Iegorov <egorov@samsonos.com>
 * @author Nikita Kotenko <kotenko@samsonos.com>
 *
 * TODO: Remove render interface
 * TODO: Remove ArrayAccess interface
 * TODO: Remove activerecord pattern from entity
 */
class Record implements RenderInterface, \ArrayAccess, RecordInterface
{
    /**
     * @var array Collection of instances for caching
     * @deprecated
     */
    public static $instances = array();

    /**
     * Collection of class fields that would not be passed to module view
     * @deprecated
     */
    public static $restricted = array('attached', 'oneToOne', 'oneToMany', 'value');

    /**
     * @var array Collection of joined entities
     * @deprecated
     */
    public $joined = [];
    /**
     * @var string Entity class name
     * @deprecated
     */
    public $className;
    /**
     * @var array Related OTO records grouped by entity class name
     * @deprecated
     */
    public $oneToOne = array();
    /**
     * @var array Related OTM records grouped by entity class name
     * @deprecated
     */
    public $oneToMany = array();
    /**
     * @var bool Flag if this object has a database record
     * @deprecated
     */
    public $attached = false;

    /** @var DatabaseInterface Database layer */
    protected $database;
    /** @var TableMetadata */
    protected $metadata;
    /** @var int Identifier */
    public $id;

    /**
     * Record constructor.
     *
     * @param DatabaseInterface|null $database
     */
    public function __construct(DatabaseInterface $database = null, TableMetadata $metadata = null)
    {
        // Get database layer
        $this->database = $database;

        // TODO: !IMPORTANT THIS NEEDS TO BE REMOVED!
        // FIXME: Dependency resolving
        if (array_key_exists('__core', $GLOBALS)) {
            $this->database = $GLOBALS['__core']->getContainer()->get('database');
        }

        // Get current class name if none is passed
        $this->className = get_class($this);

The property samsonframework\orm\Record::$className has been deprecated.

        // Get table metadata
        // FIXME: Dependency resolving
        $this->metadata = $metadata ?? TableMetadata::fromClassName($this->className);

The method samsonframework\orm\TableMetadata::fromClassName() has been deprecated with message: This is temporary old approach

The property samsonframework\orm\Record::$className has been deprecated.

    }

    /**
     * Find database record by primary key value.
     * This is generic method that should be used in nested classes to find its
     * records by some its primary key value.
     *
     * @param QueryInterface $query Query object instance
     * @param string $identifier Primary key value
     * @param mixed $return Variable to return found database record
     * @return bool|null|self  Record instance or null if 3rd parameter not passed
     * @deprecated Record should not be queryable, query class ancestor must be used
     */
    public static function byID(QueryInterface $query, $identifier, &$return = null)
    {
        /** @var Field $record Cache field object */
        $return = isset(self::$instances[$identifier])

The property samsonframework\orm\Record::$instances has been deprecated.

            // Get record from cache by identifier
            ? self::$instances[$identifier]

The property samsonframework\orm\Record::$instances has been deprecated.

            // Find record by identifier
            : self::$instances[$identifier] = static::oneByColumn(

The method samsonframework\orm\Record::oneByColumn() has been deprecated with message: Record should not be queryable, query class ancestor must be used

The property samsonframework\orm\Record::$instances has been deprecated.

                $query,
                static::$_primary,
                $identifier
            );

        // Return bool or record depending on parameters passed
        return func_num_args() > 2 ? isset($return) : $return;
    }

    /**
     * Find database record by column name and its value.
     * This is generic method that should be used in nested classes to find its
     * records by some its column values.
     *
     * @param QueryInterface $query Query object instance
     * @param string $columnValue Column name for searching in calling class
     * @param string $columnName Column value
     * @return null|self  Record instance if it was found and 4th variable has NOT been passed,
     *                      NULL if record has NOT been found and 4th variable has NOT been passed
     * @deprecated Record should not be queryable, query class ancestor must be used
     */
    public static function oneByColumn(QueryInterface $query, $columnName, $columnValue)
    {
        // Perform db request and get materials
        return $query->entity(get_called_class())
            ->where($columnName, $columnValue)
            ->first();
    }

    /**
     * Find database record collection by column name and its value.
     * This is generic method that should be used in nested classes to find its
     * records by some its column values.
     *
     * @param QueryInterface $query Query object instance
     * @param string $columnName Column name for searching in calling class
     * @param mixed $columnValue Column value
     * @return self[]  Record instance if it was found and 4th variable has NOT been passed,
     *                      NULL if record has NOT been found and 4th variable has NOT been passed
     * @deprecated Record should not be queryable, query class ancestor must be used
     */
    public static function collectionByColumn(QueryInterface $query, $columnName, $columnValue)
    {
        // Perform db request and get materials
        return $query->className(get_called_class())
            ->cond($columnName, $columnValue)
            ->exec();
    }

    /**    @see idbRecord::delete() */
    public function delete()
    {
        // Если запись привязана к БД то удалим её оттуда
        if ($this->attached) {

The property samsonframework\orm\Record::$attached has been deprecated.

            $this->database->delete($this->className, $this);

The method delete() does not seem to exist on object<samsonframework\orm\DatabaseInterface>.

The property samsonframework\orm\Record::$className has been deprecated.

        }
    }

    /** Special method called when object has been filled with data */
    public function filled()
    {

    }

    /**
     * Обработчик клонирования записи
     * Этот метод выполняется при системном вызове функции clone
     * и выполняет создание записи в БД и привязку клонированного объекта к ней
     * @deprecated Data entites should be cloned normally
     */
    public function __clone()
    {
        // Выполним создание записи в БД
        $this->id = $this->database->create($this->className, $this);

The method create() does not seem to exist on object<samsonframework\orm\DatabaseInterface>.

The property samsonframework\orm\Record::$className has been deprecated.

        // Установим флаг что мы привязались к БД
        $this->attached = true;

The property samsonframework\orm\Record::$attached has been deprecated.

        // Сохраним запись в БД
        $this->save();
    }

    /**
     * @see idbRecord::save()
     */
    public function save()
    {
        $attributes = [];
        foreach ($this->metadata->columnAliases as $columnAlias => $columnName) {
            $attributes[$columnName] = $this->$columnAlias;
        }

        if ($this->attached) {

The property samsonframework\orm\Record::$attached has been deprecated.

            $this->database->update($this->metadata, $attributes);
        } else {
            $newIdentifier = $this->database->insert($this->metadata, $attributes);

            $rows = $this->database->fetchArray(
                'SELECT * FROM `' . $this->metadata->tableName . '` WHERE ' .
                '`' . $this->metadata->tableName . '`.`' . $this->metadata->primaryField . '` = ' . $newIdentifier
            );

            if (count($rows)) {
                foreach ($this->metadata->columnAliases as $columnAlias => $columnName) {
                    $this->$columnAlias = $rows[0][$columnName];
                }
            } else {
                throw new \InvalidArgumentException('Failed ' . get_class($this) . ' entoty creation');
            }
        }

        // Store instance in cache
        self::$instances[$this->className][$this->id] = &$this;

The property samsonframework\orm\Record::$instances has been deprecated.

The property samsonframework\orm\Record::$className has been deprecated.

    }

    /**
     * @see idbRecord::create()
     * @deprecated
     */
    public function create()
    {
    }

    /**
     * @see \samson\core\iModuleViewable::toView()
     * @deprecated
     */
    public function toView($prefix = null, array $restricted = array())
    {
        // Create resulting view data array, add identifier field
        $values = array($prefix . 'id' => $this->id);

        // Учтем поля которые не нужно превращать в массив
        $restricted = array_merge(self::$restricted, $restricted);

The property samsonframework\orm\Record::$restricted has been deprecated.

        // Пробежимся по переменным класса
        foreach (get_object_vars($this) as $var => $value) {
            // Если это не системное поле записи - запишем его значение
            if (!in_array($var, $restricted)) {
                $values[$prefix . $var] = is_string($value) ? trim($value) : $value;
            }
        }

        // Вернем массив атрибутов представляющий запись БД
        return $values;
    }

    /**
     * Create full entity copy from
     * @param mixed $object Variable to return copied object
     * @return Record New copied object
     * @deprecated Not supported yet
     */
    public function &copy(&$object = null)
    {
        // Get current entity class
        $entity = get_class($this);

        // Create object instance
        $object = new $entity(false);

        // PHP 5.2 compliant get attributes
        $attributes = array();
        eval('$attributes = ' . $entity . '::$_attributes;');

        // Iterate all object attributes
        foreach ($attributes as $attribute) {
            // If we have this attribute set
            if (isset($this[$attribute])) {
                // Store it in copied object
                $object[$attribute] = $this[$attribute];
            }
        }

        // Save object in database
        $object->save();

        // Return created copied object
        return $object;
    }

    public function __isset($name)
    {
        return $this->offsetExists($name);
    }

    public function __set($name, $value)
    {
        $this->offsetSet($name, $value);
    }

    public function __get($name)
    {
        return $this->offsetGet($name);
    }

    /**
     * @see ArrayAccess::offsetSet()
     * @throws \InvalidArgumentException
     */
    public function offsetSet($offset, $value)
    {
        if ($this->metadata->isColumnExists($offset)) {
            $fieldName = $this->metadata->getTableColumnAlias($offset);
            $this->$fieldName = $value;
        } else {
            $this->$offset = $value;
        }
    }

    /**
     * @see ArrayAccess::offsetGet()
     * @throws \InvalidArgumentException
     */
    public function offsetGet($offset)
    {
        if ($this->metadata->isColumnExists($offset)) {
            $fieldName = $this->metadata->getTableColumnAlias($offset);
            return $this->$fieldName;
        }

        return $this->$offset;
    }

    /** @see ArrayAccess::offsetUnset() */
    public function offsetUnset($offset)
    {
        unset($this->$offset);
    }

    /** @see ArrayAccess::offsetExists() */
    public function offsetExists($offset)
    {
        return property_exists($this, $offset) || $this->metadata->isColumnExists($offset);
    }
}