Lagdo\DbAdmin\Driver\Entity\TableFieldEntity

Complexity

Total Complexity

22

Size/Duplication

Total Lines	296
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	updateStatus()	0	4	2
A	edited()	0	8	4
A	make()	0	16	6
A	toArray()	0	7	2
A	equals()	0	8	3
A	update()	0	6	3
A	fromArray()	0	7	2

<?php

namespace Lagdo\DbAdmin\Driver\Entity;

class TableFieldEntity
{
    /**
     * The field name
     *
     * @var string
     */
    public $name = '';

    /**
     * The field type
     *
     * @var string
     */
    public $type = '';

    /**
     * The field full type
     *
     * @var string
     */
    public $fullType = '';

    /**
     * The field sign
     *
     * @var string
     */
    public $unsigned = '';

    /**
     * The field length
     *
     * @var integer
     */
    public $length = 0;

    /**
     * If the field has a default value
     *
     * @var boolean
     */
    public $hasDefault = false;

    /**
     * The field default value
     *
     * @var mixed
     */
    public $default = null;

    /**
     * If the field is null
     *
     * @var boolean
     */
    public $null = false;

    /**
     * If the field is auto increment
     *
     * @var boolean
     */
    public $autoIncrement = false;

    /**
     * The action on update
     *
     * @var string
     */
    public $onUpdate = '';

    /**
     * The action on delete
     *
     * @var string
     */
    public $onDelete = '';

    /**
     * The field collation
     *
     * @var string
     */
    public $collation = '';

    /**
     * The field privileges
     *
     * @var array
     */
    public $privileges = [];

    /**
     * The field comment
     *
     * @var string
     */
    public $comment = '';

    /**
     * If the field is primary key
     *
     * @var boolean
     */
    public $primary = false;

    /**
     * If the field is generated
     *
     * @var boolean
     */
    public $generated = false;

    /**
     * The field types
     *
     * @var array
     */
    public $types = [];

    /**
     * If the field length is required
     *
     * @var boolean
     */
    public $lengthRequired = false;

    /**
     * If the field collation is hidden
     *
     * @var boolean
     */
    public $collationHidden = true;

    /**
     * If the field sign id idden
     *
     * @var boolean
     */
    public $unsignedHidden = false;

    /**
     * If the field on update trigger is hidden
     *
     * @var boolean
     */
    public $onUpdateHidden = true;

    /**
     * If the field on delete trigger is hidden
     *
     * @var boolean
     */
    public $onDeleteHidden = true;

    /**
     * The field status when the table is edited
     *
     * @var string
     */
    public $editStatus = 'unchanged';

    /**
     * The field position in the edit form
     *
     * @var string
     */
    public $editPosition = 0;

    /**
     * The entity attributes
     *
     * @var array
     */
    private static $attrs = ['name', 'type', 'fullType', 'primary', 'null', 'length',
        'unsigned', 'hasDefault', 'default', 'autoIncrement', 'collation', 'comment',
        'collationHidden', 'unsignedHidden', 'onUpdateHidden', 'onDeleteHidden',
        'generated', 'lengthRequired', 'onUpdate', 'onDelete', 'editStatus', 'editPosition'];

    /**
     * The entity attributes
     *
     * @var array
     */
    private static $fields = ['name', 'type', 'primary', 'autoIncrement', 'unsigned',
        'length', 'comment', 'collation', 'generated', 'lengthRequired', 'onUpdate',
        'onDelete', 'collationHidden', 'unsignedHidden', 'onUpdateHidden', 'onDeleteHidden'];

    /**
     * Create an entity from database data
     *
     * @param array $field
     *
     * @return TableFieldEntity
     */
    public static function make(array $field): self
    {
        $entity = new static();
        $entity->null = isset($field['null']);
        if (!empty($field['default'])) {
            $entity->hasDefault = true;
        }
        foreach (self::$attrs as $attr) {
            if ($attr !== 'null' && $attr !== 'hasDefault') {
                // Attributes are set only when present.
                if (isset($field[$attr])) {
                    $entity->$attr = $field[$attr];
                }
            }
        }
        return $entity;
    }

    /**
     * Create an entity from js app data
     *
     * @param array $field
     *
     * @return TableFieldEntity
     */
    public static function fromArray(array $field): self
    {
        $entity = new static();
        foreach (self::$attrs as $attr) {
            $entity->$attr = $field[$attr];
        }
        return $entity;
    }

    /**
     * @return array
     */
    public function toArray(): array
    {
        $array = [];
        foreach (self::$attrs as $attr) {
            $array[$attr] = $this->$attr;
        }
        return $array;
    }

    /**
     * @param array $values
     *
     * @return TableFieldEntity
     */
    public function update(array $values): self
    {
        foreach (self::$fields as $attr) {
            isset($values[$attr]) && $this->$attr = $values[$attr];
        }
        return $this;
    }

    /**
     * @param array $values
     *
     * @return bool
     */
    public function edited(array $values): bool
    {
        foreach (self::$fields as $attr) {
            if (isset($values[$attr]) && $this->$attr != $values[$attr]) {
                return true;
            }
        }
        return false;
    }

    /**
     * @param array $values
     *
     * @return TableFieldEntity
     */
    public function updateStatus(array $values): self
    {
        $this->editStatus = $this->edited($values) ? 'edited' : 'unchanged';
        return $this;
    }

    /**
     * Check if the values in two fields are equals
     *
     * @param TableFieldEntity $field
     *
     * @return bool
     */
    public function equals(TableFieldEntity $field)
    {
        foreach (self::$fields as $attr) {
            if ($field->$attr != $this->$attr) {
                return false;
            }
        }
        return true;
    }
}