hiapi\query\Specification

Complexity

Total Complexity

11

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	7

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	requestRelation()	0	4	1
A	applyTo()	0	12	3
B	applyWhereTo()	0	22	6

<?php

namespace hiapi\query;

use hiapi\validators\FieldValidationException;
use hiapi\validators\FieldValidator;
use hiapi\validators\FieldValidatorFactory;
use yii\base\InvalidParamException;
use yii\db\QueryTrait;

class Specification
{
    use QueryTrait;

    public $requestedRelations = [];

    /**
     * @var FieldValidatorFactory
     */
    private $fieldValidatorFactory;

    function __construct(FieldValidatorFactory $fieldValidatorFactory)

It is generally recommended to explicitly declare the visibility for methods.

    {
        $this->fieldValidatorFactory = $fieldValidatorFactory;
    }

    public function requestRelation($name)
    {
        $this->requestedRelations[$name] = true; // todo: specification for relation
    }

    /**
     * @param Query $query
     * @return Query
     */
    public function applyTo($query)
    {
        if ($this->where) {
            $this->applyWhereTo($query);
        }

        if ($this->limit) {
            $query->limit($this->limit);
        }

        return $query;
    }

    /**
     * @param Query $query
     * @throws FieldValidationException
     */
    public function applyWhereTo($query)
    {
        $conditions = [];

        foreach ($this->where as $key => $condition) {

The expression $this->where of type string|array is not guaranteed to be traversable. How about adding an additional type check?

            foreach ($query->getFields() as $field) {
                if (is_array($condition)) {
                    throw new InvalidParamException('Condition ' . json_encode($condition) . ' is not supported yet.');
                }

                if ($field->nameEquals($key)) {
                    if (!$this->fieldValidatorFactory->createFor($field, 'eq')->validate($condition)) {
                        throw new FieldValidationException('Value ' . $condition . ' is not valid');
                    }

                    $conditions[$field->getSql()] = $condition;
                }
            }
        }

        $query->andWhere($conditions);
    }
}