Spiral\Models\StaticDateEntity

Complexity

Total Complexity

12

Size/Duplication

Total Lines	140
Duplicated Lines	15 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	publicFields()	21	21	4
A	isFillable()	0	12	3
B	getMutator()	0	21	5

<?php
/**
 * components
 *
 * @author    Wolfy-J
 */
namespace Spiral\Models;

use Spiral\Models\Exceptions\EntityException;
use Spiral\Models\Prototypes\AbstractEntity;

/**
 * This is analog of DataEntity based on constant arrays to define mutator and accessors.
 *
 * @see DataEntity
 */
class StaticDateEntity extends AbstractEntity
{
    /**
     * List of fields must be hidden from publicFields() method.
     *
     * @see publicFields()
     *
     * @var array
     */
    const HIDDEN = [];

    /**
     * Set of fields allowed to be filled using setFields() method.
     *
     * @see setFields()
     *
     * @var array
     */
    const FILLABLE = [];

    /**
     * List of fields not allowed to be filled by setFields() method. Replace with and empty array
     * to allow all fields.
     *
     * By default all entity fields are settable! Opposite behaviour has to be described in entity
     * child implementations.
     *
     * @see setFields()
     *
     * @var array|string
     */
    const SECURED = [];

    /**
     * @see setField()
     *
     * @var array
     */
    const SETTERS = [];

    /**
     * @see getField()
     *
     * @var array
     */
    const GETTERS = [];

    /**
     * Accessor used to mock field data and filter every request thought itself.
     *
     * @see getField()
     * @see setField()
     *
     * @var array
     */
    const ACCESSORS = [];

    /**
     * {@inheritdoc}
     *
     * Include every composition public data into result.
     */
    public function publicFields(): array

This method seems to be duplicated in your project.

    {
        $result = [];

        foreach ($this->getKeys() as $field => $value) {
            if (in_array($field, static::HIDDEN)) {
                //We might need to use isset in future, for performance
                continue;
            }

            $value = $this->getField($field);

            if ($value instanceof PublishableInterface) {
                $result[$field] = $value->publicFields();
            } else {
                $result[$field] = $value;
            }
        }

        return $result;
    }

    /**
     * Check if field can be set using setFields() method.
     *
     * @see   setField()
     * @see   $fillable
     * @see   $secured
     *
     * @param string $field
     *
     * @return bool
     */
    protected function isFillable(string $field): bool
    {
        if (!empty(static::FILLABLE)) {
            return in_array($field, static::FILLABLE);
        }

        if (static::SECURED === '*') {
            return false;
        }

        return !in_array($field, static::SECURED);
    }

    /**
     * Check and return name of mutator (getter, setter, accessor) associated with specific field.
     *
     * @param string $field
     * @param string $mutator Mutator type (setter, getter, accessor).
     *
     * @return mixed|null
     *
     * @throws EntityException
     */
    protected function getMutator(string $field, string $mutator)
    {
        $target = [];
        switch ($mutator) {
            case self::MUTATOR_ACCESSOR:
                $target = static::ACCESSORS;
                break;
            case self::MUTATOR_GETTER:
                $target = static::GETTERS;
                break;
            case self::MUTATOR_SETTER:
                $target = static::SETTERS;
                break;
        }

        if (isset($target[$field])) {
            return $target[$field];
        }

        return null;
    }
}