Completed
Push — master ( 72c2fc...074e1b )
by Simonas
04:21
created

isRequiredParametersSet()   B

Complexity

Conditions 5
Paths 2

Size

Total Lines 9
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 9
c 0
b 0
f 0
rs 8.8571
cc 5
eloc 5
nc 2
nop 1
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\Aggregation\Metric;
13
14
use ONGR\ElasticsearchDSL\Aggregation\AbstractAggregation;
15
use ONGR\ElasticsearchDSL\Aggregation\Type\MetricTrait;
16
use ONGR\ElasticsearchDSL\ScriptAwareTrait;
17
18
/**
19
 * Class representing Percentile Ranks Aggregation.
20
 *
21
 * @link https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-rank-aggregation.html
22
 */
23
class PercentileRanksAggregation extends AbstractAggregation
24
{
25
    use MetricTrait;
26
    use ScriptAwareTrait;
27
28
    /**
29
     * @var array
30
     */
31
    private $values;
32
33
    /**
34
     * @var int
35
     */
36
    private $compression;
37
38
    /**
39
     * Inner aggregations container init.
40
     *
41
     * @param string $name
42
     * @param string $field
43
     * @param array  $values
44
     * @param string $script
45
     * @param int    $compression
46
     */
47 View Code Duplication
    public function __construct($name, $field = null, $values = null, $script = null, $compression = null)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in 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...
48
    {
49
        parent::__construct($name);
50
51
        $this->setField($field);
52
        $this->setValues($values);
0 ignored issues
show
Bug introduced by
It seems like $values defined by parameter $values on line 47 can also be of type null; however, ONGR\ElasticsearchDSL\Ag...ggregation::setValues() does only seem to accept array, 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...
53
        $this->setScript($script);
54
        $this->setCompression($compression);
55
    }
56
57
    /**
58
     * @return array
59
     */
60
    public function getValues()
61
    {
62
        return $this->values;
63
    }
64
65
    /**
66
     * @param array $values
67
     */
68
    public function setValues($values)
69
    {
70
        $this->values = $values;
71
    }
72
73
    /**
74
     * @return int
75
     */
76
    public function getCompression()
77
    {
78
        return $this->compression;
79
    }
80
81
    /**
82
     * @param int $compression
83
     */
84
    public function setCompression($compression)
85
    {
86
        $this->compression = $compression;
87
    }
88
89
    /**
90
     * {@inheritdoc}
91
     */
92
    public function getType()
93
    {
94
        return 'percentile_ranks';
95
    }
96
97
    /**
98
     * {@inheritdoc}
99
     */
100 View Code Duplication
    public function getArray()
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in 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...
101
    {
102
        $out = array_filter(
103
            [
104
                'field' => $this->getField(),
105
                'script' => $this->getScript(),
106
                'values' => $this->getValues(),
107
                'compression' => $this->getCompression(),
108
            ],
109
            function ($val) {
110
                return ($val || is_numeric($val));
111
            }
112
        );
113
114
        $this->isRequiredParametersSet($out);
115
116
        return $out;
117
    }
118
119
    /**
120
     * @param array $a
121
     *
122
     * @return bool
123
     * @throws \LogicException
124
     */
125
    private function isRequiredParametersSet($a)
126
    {
127
        if (array_key_exists('field', $a) && array_key_exists('values', $a)
128
            || (array_key_exists('script', $a) && array_key_exists('values', $a))
129
        ) {
130
            return true;
131
        }
132
        throw new \LogicException('Percentile ranks aggregation must have field and values or script and values set.');
133
    }
134
}
135