Elastica\Aggregation\Histogram

Complexity

Total Complexity

7

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	11	2
A	setInterval()	0	6	1
A	setFixedInterval()	0	4	1
A	setCalendarInterval()	0	4	1
A	setOrder()	0	4	1
A	setMinimumDocumentCount()	0	4	1

<?php

namespace Elastica\Aggregation;

/**
 * Class Histogram.
 *
 * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html
 */
class Histogram extends AbstractSimpleAggregation
{
    /**
     * @param string     $name     the name of this aggregation
     * @param string     $field    the name of the field on which to perform the aggregation
     * @param int|string $interval the interval by which documents will be bucketed
     */
    public function __construct(string $name, string $field, $interval = null)
    {
        parent::__construct($name);
        $this->setField($field);

        if (null !== $interval) {
            trigger_deprecation('ruflin/elastica', '7.1.0', 'The "%s::__construct" third argument is deprecated, use "setDateInterval()" or "setCalendarInterval()" instead. It will be removed in 8.0.', __CLASS__);

            $this->setParam('interval', $interval);
        }
    }

    /**
     * Set the interval by which documents will be bucketed.
     *
     * @param int|string $interval
     *
     * @return $this
     */
    public function setInterval($interval): self
    {
        trigger_deprecation('ruflin/elastica', '7.1.0', 'The "%s()" method is deprecated, use "setDateInterval()" or "setCalendarInterval()" instead. It will be removed in 8.0.', __METHOD__);

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

    /**
     * Set the fixed interval by which documents will be bucketed.
     *
     * @param int|string $interval
     *
     * @return $this
     */
    public function setFixedInterval($interval): self
    {
        return $this->setParam('fixed_interval', $interval);
    }

    /**
     * Set the calendar interval by which documents will be bucketed.
     *
     * @param int|string $interval
     *
     * @return $this
     */
    public function setCalendarInterval($interval): self
    {
        return $this->setParam('calendar_interval', $interval);
    }

    /**
     * Set the bucket sort order.
     *
     * @param string $order     "_count", "_term", or the name of a sub-aggregation or sub-aggregation response field
     * @param string $direction "asc" or "desc"
     *
     * @return $this
     */
    public function setOrder(string $order, string $direction): self
    {
        return $this->setParam('order', [$order => $direction]);
    }

    /**
     * Set the minimum number of documents which must fall into a bucket in order for the bucket to be returned.
     *
     * @param int $count set to 0 to include empty buckets
     *
     * @return $this
     */
    public function setMinimumDocumentCount(int $count): self
    {
        return $this->setParam('min_doc_count', $count);
    }
}