Elastica\Aggregation\Percentiles

Complexity

Total Complexity

7

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
A	setCompression()	0	6	1
A	setHdr()	0	6	1
A	setPercents()	0	4	1
A	addPercent()	0	4	1
A	setMissing()	0	4	1

<?php

namespace Elastica\Aggregation;

/**
 * Class Percentiles.
 *
 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics-percentile-aggregation.html
 */
class Percentiles extends AbstractSimpleAggregation
{
    use KeyedTrait;

    /**
     * @param string $name  the name of this aggregation
     * @param string $field the field on which to perform this aggregation
     */
    public function __construct(string $name, ?string $field = null)
    {
        parent::__construct($name);

        if (null !== $field) {
            $this->setField($field);
        }
    }

    /**
     * Set compression parameter.
     *
     * @return $this
     */
    public function setCompression(float $value): self
    {
        $compression = ['compression' => $value];

        return $this->setParam('tdigest', $compression);
    }

    /**
     * Set hdr parameter.
     *
     * @return $this
     */
    public function setHdr(string $key, float $value): self
    {
        $compression = [$key => $value];

        return $this->setParam('hdr', $compression);
    }

    /**
     * Set which percents must be returned.
     *
     * @param float[] $percents
     *
     * @return $this
     */
    public function setPercents(array $percents): self
    {
        return $this->setParam('percents', $percents);
    }

    /**
     * Add yet another percent to result.
     *
     * @return $this
     */
    public function addPercent(float $percent): self
    {
        return $this->addParam('percents', $percent);
    }

    /**
     * Defines how documents that are missing a value should
     * be treated.
     *
     * @return $this
     */
    public function setMissing(float $missing): self
    {
        return $this->setParam('missing', $missing);
    }
}