QueryEndpoint::add() - Code Metrics - ongr-io/ElasticsearchDSL - Measure and Improve Code Quality continuously with Scrutinizer

QueryEndpoint::add() A
last analyzed 2020-02-05 16:55 UTC

↳ Parent: QueryEndpoint

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\ElasticsearchDSL\SearchEndpoint;

use ONGR\ElasticsearchDSL\BuilderInterface;
use ONGR\ElasticsearchDSL\Query\Compound\BoolQuery;
use ONGR\ElasticsearchDSL\Serializer\Normalizer\OrderedNormalizerInterface;
use Symfony\Component\Serializer\Normalizer\NormalizerInterface;

/**
 * Search query dsl endpoint.
 */
class QueryEndpoint extends AbstractSearchEndpoint implements OrderedNormalizerInterface
{
    /**
     * Endpoint name
     */
    const NAME = 'query';

    /**
     * @var BoolQuery
     */
    private $bool;

    /**
     * @var bool
     */
    private $filtersSet = false;

    /**
     * {@inheritdoc}
     */
    public function normalize(NormalizerInterface $normalizer, $format = null, array $context = [])
    {
        if (!$this->filtersSet && $this->hasReference('filter_query')) {
            /** @var BuilderInterface $filter */
            $filter = $this->getReference('filter_query');
            $this->addToBool($filter, BoolQuery::FILTER);
            $this->filtersSet = true;
        }

        if (!$this->bool) {
            return null;
        }

        return $this->bool->toArray();
    }

    /**
     * {@inheritdoc}
     */
    public function add(BuilderInterface $builder, $key = null)
    {
        return $this->addToBool($builder, BoolQuery::MUST, $key);
    }

    /**
     * {@inheritdoc}
     */
    public function addToBool(BuilderInterface $builder, $boolType = null, $key = null)
    {
        if (!$this->bool) {
            $this->bool = new BoolQuery();
        }

        return $this->bool->add($builder, $boolType, $key);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * {@inheritdoc}
     */
    public function getOrder()
    {
        return 2;
    }

    /**
     * @return BoolQuery
     */
    public function getBool()
    {
        return $this->bool;
    }

    /**
     * {@inheritdoc}
     */
    public function getAll($boolType = null)
    {
        return $this->bool->getQueries($boolType);
    }
}


1			<?php
2
3			/*
4			* This file is part of the ONGR package.
5			*
6			* (c) NFQ Technologies UAB <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace ONGR\ElasticsearchDSL\SearchEndpoint;
13
14			use ONGR\ElasticsearchDSL\BuilderInterface;
15			use ONGR\ElasticsearchDSL\Query\Compound\BoolQuery;
16			use ONGR\ElasticsearchDSL\Serializer\Normalizer\OrderedNormalizerInterface;
17			use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
18
19			/**
20			* Search query dsl endpoint.
21			*/
22			class QueryEndpoint extends AbstractSearchEndpoint implements OrderedNormalizerInterface
23			{
24			/**
25			* Endpoint name
26			*/
27			const NAME = 'query';
28
29			/**
30			* @var BoolQuery
31			*/
32			private $bool;
33
34			/**
35			* @var bool
36			*/
37			private $filtersSet = false;
38
39			/**
40			* {@inheritdoc}
41			*/
42			public function normalize(NormalizerInterface $normalizer, $format = null, array $context = [])
43			{
44			if (!$this->filtersSet && $this->hasReference('filter_query')) {
45			/** @var BuilderInterface $filter */
46			$filter = $this->getReference('filter_query');
47			$this->addToBool($filter, BoolQuery::FILTER);
48			$this->filtersSet = true;
49			}
50
51			if (!$this->bool) {
52			return null;
53			}
54
55			return $this->bool->toArray();
56			}
57
58			/**
59			* {@inheritdoc}
60			*/
61			public function add(BuilderInterface $builder, $key = null)
62			{
63			return $this->addToBool($builder, BoolQuery::MUST, $key);
64			}
65
66			/**
67			* {@inheritdoc}
68			*/
69			public function addToBool(BuilderInterface $builder, $boolType = null, $key = null)
70			{
71			if (!$this->bool) {
72			$this->bool = new BoolQuery();
73			}
74
75			return $this->bool->add($builder, $boolType, $key);
			0 ignored issues – show Documentation introduced 2015-12-31 12:48 UTC by Report Bug Copy Issue Report `$boolType` is of type `array\|null`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Bug introduced 2017-01-30 07:29 UTC by Report Bug Copy Issue Report It seems like `$key` defined by parameter `$key` on line 69 can also be of type `array`; however, `ONGR\ElasticsearchDSL\Qu...mpound\BoolQuery::add()` does only seem to accept `string\|null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
76			}
77
78			/**
79			* {@inheritdoc}
80			*/
81			public function getOrder()
82			{
83			return 2;
84			}
85
86			/**
87			* @return BoolQuery
88			*/
89			public function getBool()
90			{
91			return $this->bool;
92			}
93
94			/**
95			* {@inheritdoc}
96			*/
97			public function getAll($boolType = null)
98			{
99			return $this->bool->getQueries($boolType);
100			}
101			}
102

ongr-io / ElasticsearchDSL

QueryEndpoint::add() A last analyzed 2020-02-05 16:55 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

QueryEndpoint::add() A
last analyzed 2020-02-05 16:55 UTC