LogicalOperator::getFlattenedCriteriaData() - Code Metrics - Inspection of "EZP-30806: Fixed processing REST logical op. input..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 6.13 ( d8f059...2d8437 )

unknown

created 2019-12-05 14:17 UTC

LogicalOperator::getFlattenedCriteriaData() B

↳ Parent: LogicalOperator

Complexity

Conditions	6
Paths	10

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
nc	10
nop	1
dl	0
loc	32
rs	8.7857
c	0
b	0
f	0

<?php

/**
 * File containing the LogicalOperator Criterion parser class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Publish\Core\REST\Server\Input\Parser\Criterion;

use eZ\Publish\Core\REST\Common\Input\ParsingDispatcher;
use eZ\Publish\Core\REST\Server\Input\Parser\Criterion;

/**
 * Parser for LogicalOperator Criterion.
 */
class LogicalOperator extends Criterion
{
    /**
     * Parses input structure to a Criterion object.
     *
     * @param array $data
     * @param \eZ\Publish\Core\REST\Common\Input\ParsingDispatcher $parsingDispatcher
     *
     * @throws \eZ\Publish\Core\REST\Common\Exceptions\Parser
     *
     * @return \eZ\Publish\API\Repository\Values\Content\Query\Criterion\LogicalOperator
     */
    public function parse(array $data, ParsingDispatcher $parsingDispatcher)
    {
        throw new \Exception('@todo implement');
    }

    /**
     * @param array $criteriaByType
     * @return array
     */
    protected function getFlattenedCriteriaData(array $criteriaByType)
    {
        if ($this->isZeroBasedArray($criteriaByType)) {
            $oldFormat = $criteriaByType;
            $criteriaByType = $this->normalizeCriteriaByType($criteriaByType);
            @trigger_error(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
                sprintf(
                    'REST View: Passing criteria as a list of objects to a logical operator is deprecated ' .
                    'and will cause Bad Request error in eZ Platform 3.0. Instead of "%s" provide "%s"',
                    json_encode($oldFormat),
                    json_encode($criteriaByType)
                ),
                E_USER_DEPRECATED
            );
        }

        $criteria = [];
        foreach ($criteriaByType as $type => $criterion) {
            if (!is_array($criterion) || !$this->isZeroBasedArray($criterion)) {
                $criterion = [$criterion];
            }

            foreach ($criterion as $criterionElement) {
                $criteria[] = [
                    'type' => $type,
                    'data' => $criterionElement,
                ];
            }
        }

        return $criteria;
    }

    /**
     * Checks if the given $value is zero based.
     *
     * @param array $value
     *
     * @return bool
     */
    protected function isZeroBasedArray(array $value)
    {
        reset($value);

        return empty($value) || key($value) === 0;
    }

    /**
     * Normalize list of criteria to be provided as the expected criterion type to its value map.
     *
     * Changes:
     * <code>
     * [
     *  0 => "CriterionType1" => "<value1>",
     *  1 => "CriterionType1" => "<value2>",
     *  2 => "CriterionType2" => "<value3>",
     * ]
     * </code>
     * into:
     * <code>
     * [
     *  "CriterionType1" => ["<value1>", "<value2>"],
     *  "CriterionType2" => ["<value3>"],
     * ]
     * </code>
     *
     * @param array $criterionList zero-based list of criteria
     *
     * @return array map of criterion types to their values
     */
    private function normalizeCriteriaByType(array $criterionList)
    {
        $criteriaByType = [];
        foreach ($criterionList as $criterion) {
            foreach ($criterion as $criterionType => $value) {
                if (!isset($criteriaByType[$criterionType])) {
                    $criteriaByType[$criterionType] = [];
                }

                $criteriaByType[$criterionType][] = $value;
            }
        }

        return $criteriaByType;
    }
}


1			<?php
2
3			/**
4			* File containing the LogicalOperator Criterion parser class.
5			*
6			* @copyright Copyright (C) eZ Systems AS. All rights reserved.
7			* @license For full copyright and license information view LICENSE file distributed with this source code.
8			*/
9			namespace eZ\Publish\Core\REST\Server\Input\Parser\Criterion;
10
11			use eZ\Publish\Core\REST\Common\Input\ParsingDispatcher;
12			use eZ\Publish\Core\REST\Server\Input\Parser\Criterion;
13
14			/**
15			* Parser for LogicalOperator Criterion.
16			*/
17			class LogicalOperator extends Criterion
18			{
19			/**
20			* Parses input structure to a Criterion object.
21			*
22			* @param array $data
23			* @param \eZ\Publish\Core\REST\Common\Input\ParsingDispatcher $parsingDispatcher
24			*
25			* @throws \eZ\Publish\Core\REST\Common\Exceptions\Parser
26			*
27			* @return \eZ\Publish\API\Repository\Values\Content\Query\Criterion\LogicalOperator
28			*/
29			public function parse(array $data, ParsingDispatcher $parsingDispatcher)
30			{
31			throw new \Exception('@todo implement');
32			}
33
34			/**
35			* @param array $criteriaByType
36			* @return array
37			*/
38			protected function getFlattenedCriteriaData(array $criteriaByType)
39			{
40			if ($this->isZeroBasedArray($criteriaByType)) {
41			$oldFormat = $criteriaByType;
42			$criteriaByType = $this->normalizeCriteriaByType($criteriaByType);
43			@trigger_error(
			0 ignored issues – show Security Best Practice introduced 2019-11-26 18:17 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
44			sprintf(
45			'REST View: Passing criteria as a list of objects to a logical operator is deprecated ' .
46			'and will cause Bad Request error in eZ Platform 3.0. Instead of "%s" provide "%s"',
47			json_encode($oldFormat),
48			json_encode($criteriaByType)
49			),
50			E_USER_DEPRECATED
51			);
52			}
53
54			$criteria = [];
55			foreach ($criteriaByType as $type => $criterion) {
56			if (!is_array($criterion) \|\| !$this->isZeroBasedArray($criterion)) {
57			$criterion = [$criterion];
58			}
59
60			foreach ($criterion as $criterionElement) {
61			$criteria[] = [
62			'type' => $type,
63			'data' => $criterionElement,
64			];
65			}
66			}
67
68			return $criteria;
69			}
70
71			/**
72			* Checks if the given $value is zero based.
73			*
74			* @param array $value
75			*
76			* @return bool
77			*/
78			protected function isZeroBasedArray(array $value)
79			{
80			reset($value);
81
82			return empty($value) \|\| key($value) === 0;
83			}
84
85			/**
86			* Normalize list of criteria to be provided as the expected criterion type to its value map.
87			*
88			* Changes:
89			* <code>
90			* [
91			* 0 => "CriterionType1" => "<value1>",
92			* 1 => "CriterionType1" => "<value2>",
93			* 2 => "CriterionType2" => "<value3>",
94			* ]
95			* </code>
96			* into:
97			* <code>
98			* [
99			* "CriterionType1" => ["<value1>", "<value2>"],
100			* "CriterionType2" => ["<value3>"],
101			* ]
102			* </code>
103			*
104			* @param array $criterionList zero-based list of criteria
105			*
106			* @return array map of criterion types to their values
107			*/
108			private function normalizeCriteriaByType(array $criterionList)
109			{
110			$criteriaByType = [];
111			foreach ($criterionList as $criterion) {
112			foreach ($criterion as $criterionType => $value) {
113			if (!isset($criteriaByType[$criterionType])) {
114			$criteriaByType[$criterionType] = [];
115			}
116
117			$criteriaByType[$criterionType][] = $value;
118			}
119			}
120
121			return $criteriaByType;
122			}
123			}
124

ezsystems / ezpublish-kernel

Push — 6.13 ( d8f059...2d8437 )

LogicalOperator::getFlattenedCriteriaData() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like