Completed
Push — master ( d3ac62...0cb203 )
by Federico
02:08
created

lib/Elastica/Aggregation/Derivative.php (1 issue)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
namespace Elastica\Aggregation;
4
5
use Elastica\Exception\InvalidException;
6
7
/**
8
 * Class Derivative.
9
 *
10
 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-pipeline-derivative-aggregation.html
11
 */
12 View Code Duplication
class Derivative extends AbstractAggregation
0 ignored issues
show
This class 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...
13
{
14
    /**
15
     * @param string      $name
16
     * @param string|null $bucketsPath
17
     */
18
    public function __construct(string $name, string $bucketsPath = null)
19
    {
20
        parent::__construct($name);
21
22
        if (null !== $bucketsPath) {
23
            $this->setBucketsPath($bucketsPath);
24
        }
25
    }
26
27
    /**
28
     * Set the buckets_path for this aggregation.
29
     *
30
     * @param string $bucketsPath
31
     *
32
     * @return $this
33
     */
34
    public function setBucketsPath(string $bucketsPath)
35
    {
36
        return $this->setParam('buckets_path', $bucketsPath);
37
    }
38
39
    /**
40
     * Set the gap policy for this aggregation.
41
     *
42
     * @param string $gapPolicy
43
     *
44
     * @return $this
45
     */
46
    public function setGapPolicy(string $gapPolicy = 'skip')
47
    {
48
        return $this->setParam('gap_policy', $gapPolicy);
49
    }
50
51
    /**
52
     * Set the format for this aggregation.
53
     *
54
     * @param string $format
55
     *
56
     * @return $this
57
     */
58
    public function setFormat(string $format)
59
    {
60
        return $this->setParam('format', $format);
61
    }
62
63
    /**
64
     * @throws InvalidException If buckets path or script is not set
65
     *
66
     * @return array
67
     */
68
    public function toArray(): array
69
    {
70
        if (!$this->hasParam('buckets_path')) {
71
            throw new InvalidException('Buckets path is required');
72
        }
73
74
        return parent::toArray();
75
    }
76
}
77