Rinvex\Repository\Traits\Criteriable

Complexity

Total Complexity

30

Size/Duplication

Total Lines	260
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	getCriterionName()	0	8	3
B	addCriterion()	0	15	7
A	pushCriterion()	0	6	1
A	removeCriterion()	0	6	1
A	removeCriteria()	0	8	1
A	pushCriteria()	0	8	1
A	flushCriteria()	0	5	1
A	setDefaultCriteria()	0	8	2
A	getDefaultCriteria()	0	4	1
A	getCriteria()	0	8	3
A	skipCriteria()	0	6	1
A	skipDefaultCriteria()	0	6	1
A	hasCriterion()	0	4	1
A	getCriterion()	0	6	2
A	applyCriteria()	0	12	4

<?php

namespace Rinvex\Repository\Traits;

use Closure;
use Rinvex\Repository\Contracts\CriterionContract;
use Rinvex\Repository\Contracts\RepositoryContract;

trait Criteriable
{
    /**
     * List of repository criteria.
     *
     * @var array
     */
    protected $criteria = [];

    /**
     * List of default repository criteria.
     *
     * @var array
     */
    protected $defaultCriteria = [];

    /**
     * Skip criteria flag.
     * If setted to true criteria will not be apply to the query.
     *
     * @var bool
     */
    protected $skipCriteria = false;

    /**
     * Skip default criteria flag.
     * If setted to true default criteria will not be added to the criteria list.
     *
     * @var bool
     */
    protected $skipDefaultCriteria = false;

    /**
     * Return name for the criterion.
     * If as criterion in parameter passed string we assume that is criterion class name.
     *
     * @param CriterionContract|Closure|string $criteria
     *
     * @return string
     */
    public function getCriterionName($criteria)
    {
        if ($criteria instanceof Closure) {
            return spl_object_hash($criteria);
        }

        return is_object($criteria) ? get_class($criteria) : $criteria;
    }

    /**
     * Add criterion to the specific list.
     * low-level implementation of adding criterion to the list.
     *
     * @param Closure|CriterionContract $criterion
     * @param string                    $list
     *
     * @return $this
     */
    protected function addCriterion($criterion, $list)
    {
        if (property_exists($this, $list) &&
            ($criterion instanceof Closure ||
                $criterion instanceof CriterionContract ||
                (is_string($criterion) &&
                    class_exists($criterion) &&
                    ($criterion = new $criterion()) instanceof CriterionContract
                ))
        ) {
            $this->$list[$this->getCriterionName($criterion)] = $criterion;
        }

        return $this;
    }

    /**
     * Push criterion to the criteria list.
     *
     * @param CriterionContract|Closure $criterion
     *
     * @return $this
     */
    public function pushCriterion($criterion)
    {
        $this->addCriterion($criterion, 'criteria');

        return $this;
    }

    /**
     * Remove provided criterion from criteria list.
     *
     * @param CriterionContract|Closure|string $criterion
     *
     * @return $this
     */
    public function removeCriterion($criterion)
    {
        unset($this->criteria[$this->getCriterionName($criterion)]);

        return $this;
    }

    /**
     * Remove provided criteria from criteria list.
     *
     * @param array $criteria
     *
     * @return RepositoryContract

Should the return type not be Criteriable?

     */
    public function removeCriteria(array $criteria)
    {
        array_walk($criteria, function ($criterion) {
            $this->removeCriterion($criterion);
        });

        return $this;
    }

    /**
     * Push array of criteria to the criteria list.
     *
     * @param array $criteria
     *
     * @return $this
     */
    public function pushCriteria(array $criteria)
    {
        array_walk($criteria, function ($criterion) {
            $this->pushCriterion($criterion);
        });

        return $this;
    }

    /**
     * Flush criteria list.
     *
     * @return $this
     */
    public function flushCriteria()
    {
        $this->criteria = [];
        return $this;
    }

    /**
     * Set default criteria list.
     *
     * @param array $criteria
     *
     * @return $this
     */
    public function setDefaultCriteria(array $criteria)
    {
        foreach ($criteria as $criterion) {
            $this->addCriterion($criterion, 'defaultCriteria');
        }

        return $this;
    }

    /**
     * Return default criteria list.
     *
     * @return array
     */
    public function getDefaultCriteria()
    {
        return $this->defaultCriteria;
    }

    /**
     * Return current list of criteria.
     *
     * @return array
     */
    public function getCriteria()
    {
        if ($this->skipCriteria) {
            return [];
        }

        return $this->skipDefaultCriteria ? $this->criteria : array_merge($this->getDefaultCriteria(), $this->criteria);
    }

    /**
     * Set skipCriteria flag.
     *
     * @param bool|true $flag
     *
     * @return $this
     */
    public function skipCriteria($flag = true)
    {
        $this->skipCriteria = $flag;

It seems like $flag can also be of type object<Rinvex\Repository\Traits\true>. However, the property $skipCriteria is declared as type boolean. Maybe add an additional type check?

        return $this;
    }

    /**
     * Set skipDefaultCriteria flag.
     *
     * @param bool|true $flag
     *
     * @return $this
     */
    public function skipDefaultCriteria($flag = true)
    {
        $this->skipDefaultCriteria = $flag;

It seems like $flag can also be of type object<Rinvex\Repository\Traits\true>. However, the property $skipDefaultCriteria is declared as type boolean. Maybe add an additional type check?

        return $this;
    }

    /**
     * Check if a given criterion name now in the criteria list.
     *
     * @param CriterionContract|Closure|string $criterion
     *
     * @return bool
     */
    public function hasCriterion($criterion)
    {
        return isset($this->getCriteria()[$this->getCriterionName($criterion)]);
    }

    /**
     * Return criterion object or closure from criteria list by name.
     *
     * @param $criterion
     *
     * @return CriterionContract|Closure|null
     */
    public function getCriterion($criterion)
    {
        if ($this->hasCriterion($criterion)) {
            return $this->getCriteria()[$this->getCriterionName($criterion)];
        }
    }

    /**
     * Apply criteria list to the given query.
     *
     * @param $query
     * @param $repository
     *
     * @return mixed
     */
    public function applyCriteria($query, $repository)
    {
        foreach ($this->getCriteria() as $criterion) {
            if ($criterion instanceof CriterionContract) {
                $query = $criterion->apply($query, $repository);
            } elseif ($criterion instanceof Closure) {
                $query = $criterion($query, $repository);
            }
        }

        return $query;
    }
}