Merge pull request #320 from chyzas/patch-histogram-aggregation

Added histogram aggregation

Aggregation/HistogramAggregation.php

+<?php
+
+/*
+ * This file is part of the ONGR package.
+ *
+ * (c) NFQ Technologies UAB <info@nfq.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace ONGR\ElasticsearchBundle\DSL\Aggregation;
+
+use ONGR\ElasticsearchBundle\DSL\Aggregation\Type\BucketingTrait;
+
+/**
+ * Class representing Histogram aggregation.
+ */
+class HistogramAggregation extends AbstractAggregation
+{
+    use BucketingTrait;
+
+    const DIRECTION_ASC = 'asc';
+    const DIRECTION_DESC = 'desc';
+
+    /**
+     * @var int
+     */
+    protected $interval;
+
+    /**
+     * @var int
+     */
+    protected $minDocCount;
+
+    /**
+     * @var array
+     */
+    protected $extendedBounds;
+
+    /**
+     * @var string
+     */
+    protected $orderMode;
+
+    /**
+     * @var string
+     */
+    protected $orderDirection;
+
+    /**
+     * @var bool
+     */
+    protected $keyed;
+
+    /**
+     * @return bool
+     */
+    public function isKeyed()
+    {
+        return $this->keyed;
+    }
+
+    /**
+     * Get response as a hash instead keyed by the buckets keys.
+     *
+     * @param bool $keyed
+     */
+    public function setKeyed($keyed)
+    {
+        $this->keyed = $keyed;
+    }
+
+    /**
+     * Sets buckets ordering.
+     *
+     * @param string $mode
+     * @param string $direction
+     */
+    public function setOrder($mode, $direction = self::DIRECTION_ASC)
+    {
+        $this->orderMode = $mode;
+        $this->orderDirection = $direction;
+    }
+
+    /**
+     * @return array
+     */
+    public function getOrder()
+    {
+        return [$this->orderMode => $this->orderDirection];
+    }
+
+    /**
+     * @return int
+     */
+    public function getInterval()
+    {
+        return $this->interval;
+    }
+
+    /**
+     * @param int $interval
+     */
+    public function setInterval($interval)
+    {
+        $this->interval = $interval;
+    }
+
+    /**
+     * @return int
+     */
+    public function getMinDocCount()
+    {
+        return $this->minDocCount;
+    }
+
+    /**
+     * Set limit for document count buckets should have.
+     *
+     * @param int $minDocCount
+     */
+    public function setMinDocCount($minDocCount)
+    {
+        $this->minDocCount = $minDocCount;
+    }
+
+    /**
+     * @return array
+     */
+    public function getExtendedBounds()
+    {
+        return $this->extendedBounds;
+    }
+
+    /**
+     * @param int $min
+     * @param int $max
+     */
+    public function setExtendedBounds($min = null, $max = null)
+    {
+        $bounds = array_filter(
+            [
+                'min' => $min,
+                'max' => $max,
+            ]
+        );
+        $this->extendedBounds = $bounds;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getType()
+    {
+        return 'histogram';
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getArray()
+    {
+        $out = array_filter(
+            [
+                'field' => $this->getField(),
+                'interval' => $this->getInterval(),
+                'min_doc_count' => $this->getMinDocCount(),
+                'extended_bounds' => $this->getExtendedBounds(),
+                'keyed' => $this->isKeyed(),
+                'order' => $this->getOrder(),
+            ],
+            function ($val) {
+                return ($val || is_numeric($val));
+            }
+        );
+        $this->checkRequiredParameters($out, ['field', 'interval']);
+
+        return $out;
+    }
+
+    /**
+     * Checks if all required parameters are set.
+     *
+     * @param array $data
+     * @param array $required
+     *
+     * @throws \LogicException
+     */
+    protected function checkRequiredParameters($data, $required)
+    {
+        if (count(array_intersect_key(array_flip($required), $data)) !== count($required)) {
+            throw new \LogicException('Histogram aggregation must have field and interval set.');
+        }
+    }
+}