QueryParameters::getAllowedIncludePaths() - Code Metrics - Inspection of "Minor fix" - reva2/jsonapi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 862be0...4d4fd5 )

by Sergey

created 2016-07-25 23:13 UTC

QueryParameters::getAllowedIncludePaths() A

↳ Parent: QueryParameters

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/*
 * This file is part of the reva2/jsonapi.
 *
 * (c) OrbitScripts LLC <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */


namespace Reva2\JsonApi\Http\Query;

use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
use Symfony\Component\Validator\Context\ExecutionContextInterface;
use Reva2\JsonApi\Annotations as API;
use Symfony\Component\Validator\Constraints as Assert;

/**
 * JSON API single resource query parameters
 *
 * @package Reva2\JsonApi\Http\Query
 * @author Sergey Revenko <[email protected]>
 */
class QueryParameters implements EncodingParametersInterface
{
    const INVALID_INCLUDE_PATHS = '9f4922b8-8e8b-4847-baf2-5831adfd6813';
    const INVALID_FIELD_SET = 'ec7d2c6b-97d1-4f94-ba94-d141d985fc6f';

    /**
     * @var string[]|null
     * @API\Property(path="[include]", parser="parseIncludePaths")
     * @Assert\Type(type="array")
     * @Assert\All({@Assert\Type(type="string")})
     */
    protected $includePaths;

    /**
     * @var array[]|null
     * @API\Property(path="[fields]", parser="parseFieldSets")
     * @Assert\Type(type="array")
     * @Assert\All({@Assert\Type(type="string")})
     */
    protected $fieldSets;

    /**
     * @inheritdoc
     */
    public function getIncludePaths()
    {
        return $this->includePaths;
    }

    /**
     * Sets include paths
     *
     * @param string[]|null $paths
     * @return $this
     */
    public function setIncludePaths(array $paths = null)
    {
        $this->includePaths = $paths;

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getFieldSets()
    {
        return $this->fieldSets;
    }

    /**
     * @inheritdoc
     */
    public function getFieldSet($type)
    {
        return (isset($this->fieldSets[$type])) ? $this->fieldSets[$type] : null;

    }

    /**
     * @param \array[]|null $fieldSets
     * @return $this
     */
    public function setFieldSets(array $fieldSets = null)
    {
        $this->fieldSets = $fieldSets;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        return $this;
    }

    /**
     * @inheritdoc
     */
    public function getSortParameters()
    {
        return null;
    }

    /**
     * @inheritdoc
     */
    public function getPaginationParameters()
    {
        return null;
    }

    /**
     * @inheritdoc
     */
    public function getFilteringParameters()
    {
        return null;
    }

    /**
     * @inheritdoc
     */
    public function getUnrecognizedParameters()
    {
        return null;
    }

    /**
     * @inheritdoc
     */
    public function isEmpty()
    {
        if (empty($this->getIncludePaths()) &&
            empty($this->getFieldSets()) &&
            empty($this->getSortParameters()) &&
            empty($this->getPaginationParameters()) &&
            empty($this->getFilteringParameters())
        ) {
            return true;
        }

        return false;
    }

    /**
     * Parse value of parameter that store include paths
     * which should be included into response
     *
     * @param string|null $value
     * @return array|null
     */
    public function parseIncludePaths($value = null) {
        if (empty($value)) {
            return null;
        }

        if (!is_string($value)) {
            throw new \InvalidArgumentException('Include paths value must be a string', 400);
        }

        return explode(',', $value);
    }

    /**
     * Parse value of parameter that store fields which
     * should be included into response
     *
     * @param array|null $value
     * @return array|null
     */
    public function parseFieldSets($value = null) {
        if (empty($value)) {
            return null;
        }

        if (!is_array($value)) {
            throw new \InvalidArgumentException('Field sets value must be an array', 400);
        }

        foreach ($value as $resource => $fields) {
            $value[$resource] = explode(',', $fields);
        }

        return $value;
    }

    /**
     * Validate specified include paths
     *
     * @param ExecutionContextInterface $context
     * @Assert\Callback()
     */
    public function validateIncludePaths(ExecutionContextInterface $context)
    {
        if (!is_array($this->includePaths)) {
            return;
        }

        $invalidPaths = array_diff($this->includePaths, $this->getAllowedIncludePaths());
        if (count($invalidPaths) > 0) {

            $context
                ->buildViolation('Invalid include paths: %paths%')
                ->setParameter('%paths%', sprintf("'%s'", implode("', '", $invalidPaths)))
                ->setPlural(count($invalidPaths))
                ->setInvalidValue($invalidPaths)
                ->setCode(self::INVALID_INCLUDE_PATHS)
                ->atPath('includePaths')
                ->addViolation();
        }
    }

    /**
     * Validate specified fields sets
     *
     * @param ExecutionContextInterface $context
     * @Assert\Callback()
     */
    public function validateFieldSets(ExecutionContextInterface $context)
    {
        if (!is_array($this->fieldSets)) {
            return;
        }

        foreach ($this->fieldSets as $resource => $fields) {
            $invalidFields = array_diff($fields, $this->getAllowedFields($resource));

            if (count($invalidFields) > 0) {

                $context
                    ->buildViolation('Invalid fields: %fields%')
                    ->setParameter('%fields%', sprintf("'%s'", implode("', '", $invalidFields)))
                    ->setPlural(count($invalidFields))
                    ->setInvalidValue($invalidFields)
                    ->setCode(self::INVALID_FIELD_SET)
                    ->atPath('fieldSets.' . $resource)
                    ->addViolation();
            }
        }
    }

    /**
     * Returns list of allowed include paths
     *
     * @return string[]
     */
    protected function getAllowedIncludePaths()
    {
        return [];
    }

    /**
     * Returns list of fields available in specified resource
     *
     * @param string $resource
     * @return array[]
     */
    protected function getAllowedFields($resource)

    {
        return [];
    }
}


1			<?php
2			/*
3			* This file is part of the reva2/jsonapi.
4			*
5			* (c) OrbitScripts LLC <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11
12			namespace Reva2\JsonApi\Http\Query;
13
14			use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
15			use Symfony\Component\Validator\Context\ExecutionContextInterface;
16			use Reva2\JsonApi\Annotations as API;
17			use Symfony\Component\Validator\Constraints as Assert;
18
19			/**
20			* JSON API single resource query parameters
21			*
22			* @package Reva2\JsonApi\Http\Query
23			* @author Sergey Revenko <[email protected]>
24			*/
25			class QueryParameters implements EncodingParametersInterface
26			{
27			const INVALID_INCLUDE_PATHS = '9f4922b8-8e8b-4847-baf2-5831adfd6813';
28			const INVALID_FIELD_SET = 'ec7d2c6b-97d1-4f94-ba94-d141d985fc6f';
29
30			/**
31			* @var string[]\|null
32			* @API\Property(path="[include]", parser="parseIncludePaths")
33			* @Assert\Type(type="array")
34			* @Assert\All({@Assert\Type(type="string")})
35			*/
36			protected $includePaths;
37
38			/**
39			* @var array[]\|null
40			* @API\Property(path="[fields]", parser="parseFieldSets")
41			* @Assert\Type(type="array")
42			* @Assert\All({@Assert\Type(type="string")})
43			*/
44			protected $fieldSets;
45
46			/**
47			* @inheritdoc
48			*/
49	2		public function getIncludePaths()
50			{
51	2		return $this->includePaths;
52			}
53
54			/**
55			* Sets include paths
56			*
57			* @param string[]\|null $paths
58			* @return $this
59			*/
60	3		public function setIncludePaths(array $paths = null)
61			{
62	3		$this->includePaths = $paths;
63
64	3		return $this;
65			}
66
67			/**
68			* @inheritdoc
69			*/
70	1		public function getFieldSets()
71			{
72	1		return $this->fieldSets;
73			}
74
75			/**
76			* @inheritdoc
77			*/
78	1		public function getFieldSet($type)
79			{
80	1		return (isset($this->fieldSets[$type])) ? $this->fieldSets[$type] : null;
			1 ignored issue – show Bug Compatibility introduced 2016-07-22 14:13 UTC by Report Bug Copy Issue Report The expression `isset($this->fieldSets[$...ieldSets[$type] : null;` of type `array\|null` adds the type `array` to the return on line 80 which is incompatible with the return type declared by the interface `Neomerx\JsonApi\Contract...sInterface::getFieldSet` of type `string[]\|null`. Loading history...
81			}
82
83			/**
84			* @param \array[]\|null $fieldSets
85			* @return $this
86			*/
87	3		public function setFieldSets(array $fieldSets = null)
88			{
89	3		$this->fieldSets = $fieldSets;
			0 ignored issues – show Documentation Bug introduced 2016-07-22 14:13 UTC by Report Bug Copy Issue Report It seems like `$fieldSets` can also be of type `array<integer,object<array>>`. However, the property `$fieldSets` is declared as type `array<integer,array>\|null`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
90
91	3		return $this;
92			}
93
94			/**
95			* @inheritdoc
96			*/
97	1		public function getSortParameters()
98			{
99	1		return null;
100			}
101
102			/**
103			* @inheritdoc
104			*/
105	1		public function getPaginationParameters()
106			{
107	1		return null;
108			}
109
110			/**
111			* @inheritdoc
112			*/
113	1		public function getFilteringParameters()
114			{
115	1		return null;
116			}
117
118			/**
119			* @inheritdoc
120			*/
121			public function getUnrecognizedParameters()
122			{
123			return null;
124			}
125
126			/**
127			* @inheritdoc
128			*/
129	1		public function isEmpty()
130			{
131	1		if (empty($this->getIncludePaths()) &&
132	1		empty($this->getFieldSets()) &&
133	1		empty($this->getSortParameters()) &&
134	1		empty($this->getPaginationParameters()) &&
135	1		empty($this->getFilteringParameters())
136			) {
137	1		return true;
138			}
139
140	1		return false;
141			}
142
143			/**
144			* Parse value of parameter that store include paths
145			* which should be included into response
146			*
147			* @param string\|null $value
148			* @return array\|null
149			*/
150	2		public function parseIncludePaths($value = null) {
151	2		if (empty($value)) {
152	1		return null;
153			}
154
155	2		if (!is_string($value)) {
156	1		throw new \InvalidArgumentException('Include paths value must be a string', 400);
157			}
158
159	1		return explode(',', $value);
160			}
161
162			/**
163			* Parse value of parameter that store fields which
164			* should be included into response
165			*
166			* @param array\|null $value
167			* @return array\|null
168			*/
169	2		public function parseFieldSets($value = null) {
170	2		if (empty($value)) {
171	1		return null;
172			}
173
174	2		if (!is_array($value)) {
175	1		throw new \InvalidArgumentException('Field sets value must be an array', 400);
176			}
177
178	1		foreach ($value as $resource => $fields) {
179	1		$value[$resource] = explode(',', $fields);
180			}
181
182	1		return $value;
183			}
184
185			/**
186			* Validate specified include paths
187			*
188			* @param ExecutionContextInterface $context
189			* @Assert\Callback()
190			*/
191	1		public function validateIncludePaths(ExecutionContextInterface $context)
192			{
193	1		if (!is_array($this->includePaths)) {
194	1		return;
195			}
196
197	1		$invalidPaths = array_diff($this->includePaths, $this->getAllowedIncludePaths());
198	1	View Code Duplication	if (count($invalidPaths) > 0) {
			0 ignored issues – show Duplication introduced 2016-07-22 14:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
199			$context
200	1		->buildViolation('Invalid include paths: %paths%')
201	1		->setParameter('%paths%', sprintf("'%s'", implode("', '", $invalidPaths)))
202	1		->setPlural(count($invalidPaths))
203	1		->setInvalidValue($invalidPaths)
204	1		->setCode(self::INVALID_INCLUDE_PATHS)
205	1		->atPath('includePaths')
206	1		->addViolation();
207			}
208	1		}
209
210			/**
211			* Validate specified fields sets
212			*
213			* @param ExecutionContextInterface $context
214			* @Assert\Callback()
215			*/
216	1		public function validateFieldSets(ExecutionContextInterface $context)
217			{
218	1		if (!is_array($this->fieldSets)) {
219	1		return;
220			}
221
222	1		foreach ($this->fieldSets as $resource => $fields) {
223	1		$invalidFields = array_diff($fields, $this->getAllowedFields($resource));
224
225	1	View Code Duplication	if (count($invalidFields) > 0) {
			0 ignored issues – show Duplication introduced 2016-07-22 14:13 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
226			$context
227	1		->buildViolation('Invalid fields: %fields%')
228	1		->setParameter('%fields%', sprintf("'%s'", implode("', '", $invalidFields)))
229	1		->setPlural(count($invalidFields))
230	1		->setInvalidValue($invalidFields)
231	1		->setCode(self::INVALID_FIELD_SET)
232	1		->atPath('fieldSets.' . $resource)
233	1		->addViolation();
234			}
235			}
236	1		}
237
238			/**
239			* Returns list of allowed include paths
240			*
241			* @return string[]
242			*/
243	1		protected function getAllowedIncludePaths()
244			{
245	1		return [];
246			}
247
248			/**
249			* Returns list of fields available in specified resource
250			*
251			* @param string $resource
252			* @return array[]
253			*/
254	1		protected function getAllowedFields($resource)
			0 ignored issues – show Unused Code introduced 2016-07-22 14:13 UTC by Report Bug Copy Issue Report The parameter `$resource` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
255			{
256	1		return [];
257			}
258			}
259

reva2 / jsonapi

GitHub Access Token became invalid

Push — master ( 862be0...4d4fd5 )

QueryParameters::getAllowedIncludePaths() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like