Specification::applyTo() - Code Metrics - Inspection of "Added basic fields validation" - hiqdev/hiapi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 85994b...9d10cb )

by Dmitry

created 2017-06-07 18:25 UTC

Specification::applyTo() A

↳ Parent: Specification

Complexity

Conditions	3
Paths	4

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	12
ccs	0
cts	7
cp	0
rs	9.4285
cc	3
eloc	6
nc	4
nop	1
crap	12

<?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)

    {
        $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) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            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);
    }
}


1			<?php
2
3			namespace hiapi\query;
4
5			use hiapi\validators\FieldValidationException;
6			use hiapi\validators\FieldValidator;
7			use hiapi\validators\FieldValidatorFactory;
8			use yii\base\InvalidParamException;
9			use yii\db\QueryTrait;
10
11			class Specification
12			{
13			use QueryTrait;
14
15			public $requestedRelations = [];
16
17			/**
18			* @var FieldValidatorFactory
19			*/
20			private $fieldValidatorFactory;
21
22			function __construct(FieldValidatorFactory $fieldValidatorFactory)
			0 ignored issues – show Best Practice introduced 2017-06-07 18:27 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
23			{
24			$this->fieldValidatorFactory = $fieldValidatorFactory;
25			}
26
27			public function requestRelation($name)
28			{
29			$this->requestedRelations[$name] = true; // todo: specification for relation
30			}
31
32			/**
33			* @param Query $query
34			* @return Query
35			*/
36			public function applyTo($query)
37			{
38			if ($this->where) {
39			$this->applyWhereTo($query);
40			}
41
42			if ($this->limit) {
43			$query->limit($this->limit);
44			}
45
46			return $query;
47			}
48
49			/**
50			* @param Query $query
51			* @throws FieldValidationException
52			*/
53			public function applyWhereTo($query)
54			{
55			$conditions = [];
56
57			foreach ($this->where as $key => $condition) {
			0 ignored issues – show Bug introduced 2017-06-07 18:27 UTC by Report Bug Copy Issue Report The expression `$this->where` of type `string\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
58			foreach ($query->getFields() as $field) {
59			if (is_array($condition)) {
60			throw new InvalidParamException('Condition ' . json_encode($condition) . ' is not supported yet.');
61			}
62
63			if ($field->nameEquals($key)) {
64			if (!$this->fieldValidatorFactory->createFor($field, 'eq')->validate($condition)) {
65			throw new FieldValidationException('Value ' . $condition . ' is not valid');
66			}
67
68			$conditions[$field->getSql()] = $condition;
69			}
70			}
71			}
72
73			$query->andWhere($conditions);
74			}
75			}
76

hiqdev / hiapi

Push — master ( 85994b...9d10cb )

Specification::applyTo() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like