Terms::toArray() - Code Metrics - Inspection of "Removed helper function Terms::buildTermsLookup()..." - ruflin/Elastica - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 80157d...a5a981 )

by Ema

created 2020-03-23 08:25 UTC

Terms::toArray() A

↳ Parent: Terms

Complexity

Conditions	4
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	4
nc	3
nop	0

<?php

namespace Elastica\Query;

use Elastica\Exception\InvalidException;

/**
 * Terms query.
 *
 * @author Nicolas Ruflin <[email protected]>
 * @author Roberto Nygaard <[email protected]>
 *
 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html
 */
class Terms extends AbstractQuery
{
    /**
     * @var string
     */
    private $field;

    /**
     * @var string[]
     */
    private $terms;

    /**
     * @var string[]|null
     */
    private $lookup;

    /**
     * @param string[] $terms Terms list, leave empty if building a terms-lookup query
     */
    public function __construct(string $field, array $terms = [])
    {
        if (empty($field)) {
            throw new InvalidException('Terms field name has to be set');
        }

        $this->field = $field;
        $this->terms = $terms;
    }

    /**
     * Sets terms for the query.
     *
     * @param string[]
     */
    public function setTerms(array $terms): self
    {
        $this->terms = $terms;

        return $this;
    }

    /**
     * Adds a single term to the list.
     */
    public function addTerm(string $term): self
    {
        $this->terms[] = $term;

        return $this;
    }

    public function setTermsLookup(string $index, string $id, string $path): self
    {
        $this->lookup = [

            'index' => $index,
            'id' => $id,
            'path' => $path,
        ];

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function toArray(): array
    {
        if (null !== $this->lookup && \count($this->terms)) {
            throw new InvalidException('Unable to build Terms query: only one of terms or lookup properties should be set');
        }

        if (null !== $this->lookup) {
            $this->setParam($this->field, $this->lookup);
        } else {
            $this->setParam($this->field, $this->terms);
        }

        return parent::toArray();
    }
}


1			<?php
2
3			namespace Elastica\Query;
4
5			use Elastica\Exception\InvalidException;
6
7			/**
8			* Terms query.
9			*
10			* @author Nicolas Ruflin <[email protected]>
11			* @author Roberto Nygaard <[email protected]>
12			*
13			* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html
14			*/
15			class Terms extends AbstractQuery
16			{
17			/**
18			* @var string
19			*/
20			private $field;
21
22			/**
23			* @var string[]
24			*/
25			private $terms;
26
27			/**
28			* @var string[]\|null
29			*/
30			private $lookup;
31
32			/**
33			* @param string[] $terms Terms list, leave empty if building a terms-lookup query
34			*/
35			public function __construct(string $field, array $terms = [])
36			{
37			if (empty($field)) {
38			throw new InvalidException('Terms field name has to be set');
39			}
40
41			$this->field = $field;
42			$this->terms = $terms;
43			}
44
45			/**
46			* Sets terms for the query.
47			*
48			* @param string[]
49			*/
50			public function setTerms(array $terms): self
51			{
52			$this->terms = $terms;
53
54			return $this;
55			}
56
57			/**
58			* Adds a single term to the list.
59			*/
60			public function addTerm(string $term): self
61			{
62			$this->terms[] = $term;
63
64			return $this;
65			}
66
67			public function setTermsLookup(string $index, string $id, string $path): self
68			{
69			$this->lookup = [
			0 ignored issues – show Documentation Bug introduced 2020-03-11 15:46 UTC by Report Bug Copy Issue Report It seems like `array('index' => $index,...> $id, 'path' => $path)` of type `array<string,string,{"in...ring","path":"string"}>` is incompatible with the declared type `array<integer,string>\|null` of property `$lookup`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
70			'index' => $index,
71			'id' => $id,
72			'path' => $path,
73			];
74
75			return $this;
76			}
77
78			/**
79			* {@inheritdoc}
80			*/
81			public function toArray(): array
82			{
83			if (null !== $this->lookup && \count($this->terms)) {
84			throw new InvalidException('Unable to build Terms query: only one of terms or lookup properties should be set');
85			}
86
87			if (null !== $this->lookup) {
88			$this->setParam($this->field, $this->lookup);
89			} else {
90			$this->setParam($this->field, $this->terms);
91			}
92
93			return parent::toArray();
94			}
95			}
96

ruflin / Elastica

Push — master ( 80157d...a5a981 )

Terms::toArray() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like