SubtreeIn - Code Metrics - Inspection of "Merge branch 'permissions_subtree_internal'" - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 702e62...20fc8a )

by André

created 2016-02-21 21:03 UTC

SubtreeIn A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	86
Duplicated Lines	16.28 %

Coupling/Cohesion

Components	0
Dependencies	3

Metric	Value
wmc	8
lcom	0
cbo	3
dl	14
loc	86
rs	10

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getCondition()	14	14	2
A	visitFilter()	0	11	1
A	visitQuery()	0	14	1
A	canVisit()	0	9	4

How to fix Duplicated Code

<?php

/**
 * File containing the SubtreeIn criterion visitor 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.
 *
 * @version //autogentag//
 */
namespace eZ\Publish\Core\Search\Elasticsearch\Content\CriterionVisitor;

use eZ\Publish\Core\Search\Elasticsearch\Content\CriterionVisitorDispatcher as Dispatcher;
use eZ\Publish\Core\Search\Elasticsearch\Content\CriterionVisitor;
use eZ\Publish\API\Repository\Values\Content\Query\Criterion;
use eZ\Publish\API\Repository\Values\Content\Query\Criterion\Operator;

/**
 * Visits the Subtree criterion.
 */
class SubtreeIn extends CriterionVisitor
{
    /**
     * Check if visitor is applicable to current criterion.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
     *
     * @return bool
     */
    public function canVisit(Criterion $criterion)
    {
        return
            $criterion instanceof Criterion\Subtree &&
            (
                ($criterion->operator ?: Operator::IN) === Operator::IN ||
                $criterion->operator === Operator::EQ
            );
    }

    /**
     * Returns nested condition common for filter and query contexts.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
     *
     * @return array
     */
    protected function getCondition(Criterion $criterion)
    {
        $filters = array();

        foreach ($criterion->value as $value) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $filters[] = array(
                'prefix' => array(
                    'locations_doc.path_string_id' => $value,
                ),
            );
        }

        return $filters;
    }

    /**
     * Map field value to a proper Elasticsearch filter representation.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
     * @param \eZ\Publish\Core\Search\Elasticsearch\Content\CriterionVisitorDispatcher $dispatcher
     * @param array $languageFilter
     *
     * @return mixed
     */
    public function visitFilter(Criterion $criterion, Dispatcher $dispatcher, array $languageFilter)
    {
        return array(
            'nested' => array(
                'path' => 'locations_doc',
                'filter' => array(
                    'or' => $this->getCondition($criterion),
                ),
            ),
        );
    }

    /**
     * Map field value to a proper Elasticsearch query representation.
     *
     * @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
     * @param \eZ\Publish\Core\Search\Elasticsearch\Content\CriterionVisitorDispatcher $dispatcher
     * @param array $languageFilter
     *
     * @return mixed
     */
    public function visitQuery(Criterion $criterion, Dispatcher $dispatcher, array $languageFilter)
    {
        return array(
            'nested' => array(
                'path' => 'locations_doc',
                'query' => array(
                    'bool' => array(
                        'should' => $this->getCondition($criterion),
                        'minimum_should_match' => 1,
                    ),
                ),
            ),
        );
    }
}


1		<?php
2
3		/**
4		* File containing the SubtreeIn criterion visitor 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		* @version //autogentag//
10		*/
11		namespace eZ\Publish\Core\Search\Elasticsearch\Content\CriterionVisitor;
12
13		use eZ\Publish\Core\Search\Elasticsearch\Content\CriterionVisitorDispatcher as Dispatcher;
14		use eZ\Publish\Core\Search\Elasticsearch\Content\CriterionVisitor;
15		use eZ\Publish\API\Repository\Values\Content\Query\Criterion;
16		use eZ\Publish\API\Repository\Values\Content\Query\Criterion\Operator;
17
18		/**
19		* Visits the Subtree criterion.
20		*/
21		class SubtreeIn extends CriterionVisitor
22		{
23		/**
24		* Check if visitor is applicable to current criterion.
25		*
26		* @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
27		*
28		* @return bool
29		*/
30		public function canVisit(Criterion $criterion)
31		{
32		return
33		$criterion instanceof Criterion\Subtree &&
34		(
35		($criterion->operator ?: Operator::IN) === Operator::IN \|\|
36		$criterion->operator === Operator::EQ
37		);
38		}
39
40		/**
41		* Returns nested condition common for filter and query contexts.
42		*
43		* @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
44		*
45		* @return array
46		*/
47	View Code Duplication	protected function getCondition(Criterion $criterion)
48		{
49		$filters = array();
50
51		foreach ($criterion->value as $value) {
		0 ignored issues – show Bug introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report The expression `$criterion->value` of type `integer\|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...
52		$filters[] = array(
53		'prefix' => array(
54		'locations_doc.path_string_id' => $value,
55		),
56		);
57		}
58
59		return $filters;
60		}
61
62		/**
63		* Map field value to a proper Elasticsearch filter representation.
64		*
65		* @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
66		* @param \eZ\Publish\Core\Search\Elasticsearch\Content\CriterionVisitorDispatcher $dispatcher
67		* @param array $languageFilter
68		*
69		* @return mixed
70		*/
71		public function visitFilter(Criterion $criterion, Dispatcher $dispatcher, array $languageFilter)
72		{
73		return array(
74		'nested' => array(
75		'path' => 'locations_doc',
76		'filter' => array(
77		'or' => $this->getCondition($criterion),
78		),
79		),
80		);
81		}
82
83		/**
84		* Map field value to a proper Elasticsearch query representation.
85		*
86		* @param \eZ\Publish\API\Repository\Values\Content\Query\Criterion $criterion
87		* @param \eZ\Publish\Core\Search\Elasticsearch\Content\CriterionVisitorDispatcher $dispatcher
88		* @param array $languageFilter
89		*
90		* @return mixed
91		*/
92		public function visitQuery(Criterion $criterion, Dispatcher $dispatcher, array $languageFilter)
93		{
94		return array(
95		'nested' => array(
96		'path' => 'locations_doc',
97		'query' => array(
98		'bool' => array(
99		'should' => $this->getCondition($criterion),
100		'minimum_should_match' => 1,
101		),
102		),
103		),
104		);
105		}
106		}
107

ezsystems / ezpublish-kernel

Push — master ( 702e62...20fc8a )

SubtreeIn A

Complexity

Size/Duplication

Coupling/Cohesion

4 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like