Merge pull request #14 from thrashzone13/main

Add extended bounds param to Histogram and DateHistogram

Author: erichard

src/Aggregation/DateHistogramAggregation.php

@@ -4,14 +4,15 @@
 
 namespace Erichard\ElasticQueryBuilder\Aggregation;
 
+use Erichard\ElasticQueryBuilder\Features\HasExtendedBounds;
 use Erichard\ElasticQueryBuilder\Features\HasField;
 
 /**
  * @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-datehistogram-aggregation.html
  */
 class DateHistogramAggregation extends AbstractAggregation
 {
-    use HasField; // TODO enum
+    use HasField, HasExtendedBounds; // TODO enum
 
     /**
      * @param array<AbstractAggregation> $aggregations
@@ -20,10 +21,14 @@ public function __construct(
         string $nameAndField,
         private string $calendarInterval,
         ?string $field = null,
-        array $aggregations = []
+        array $aggregations = [],
+        ?string $min = null,
+        ?string $max = null,
     ) {
         parent::__construct($nameAndField, $aggregations);
         $this->field = $field ?? $nameAndField;
+        $this->min = $min;
+        $this->max = $max;
     }
 
     public function setCalendarInterval(string $calendarInterval): self
@@ -45,9 +50,16 @@ protected function getType(): string
 
     protected function buildAggregation(): array
     {
-        return [
+        $build = [
             'field' => $this->field,
             'calendar_interval' => $this->calendarInterval,
         ];
+
+        if ($this->min !== null && $this->max !== null) {
+            $build['extended_bounds']['min'] = $this->min;
+            $build['extended_bounds']['max'] = $this->max;
+        }
+
+        return $build;
     }
 }

src/Aggregation/HistogramAggregation.php

@@ -4,11 +4,12 @@
 
 namespace Erichard\ElasticQueryBuilder\Aggregation;
 
+use Erichard\ElasticQueryBuilder\Features\HasExtendedBounds;
 use Erichard\ElasticQueryBuilder\Features\HasField;
 
 class HistogramAggregation extends AbstractAggregation
 {
-    use HasField;
+    use HasField, HasExtendedBounds;
 
     /**
      * @param array<AbstractAggregation> $aggregations
@@ -17,10 +18,14 @@ public function __construct(
         string $name,
         string $field,
         private int $interval,
-        array $aggregations = []
+        array $aggregations = [],
+        ?string $min = null,
+        ?string $max = null,
     ) {
         parent::__construct($name, $aggregations);
         $this->field = $field;
+        $this->min = $min;
+        $this->max = $max;
     }
 
     public function getInterval(): int
@@ -40,9 +45,16 @@ protected function getType(): string
 
     protected function buildAggregation(): array
     {
-        return [
+        $build = [
             'field' => $this->field,
             'interval' => $this->interval,
         ];
+
+        if ($this->min !== null && $this->max !== null) {
+            $build['extended_bounds']['min'] = $this->min;
+            $build['extended_bounds']['max'] = $this->max;
+        }
+
+        return $build;
     }
 }

src/Features/HasExtendedBounds.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Erichard\ElasticQueryBuilder\Features;
+
+/**
+ * @see  https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-histogram-aggregation.html#search-aggregations-bucket-histogram-aggregation-extended-bounds
+ */
+trait HasExtendedBounds
+{
+    protected ?string $min;
+
+    protected ?string $max;
+
+    public function setMin(?string $min): self
+    {
+        $this->min = $min;
+
+        return $this;
+    }
+
+    public function getMin(): ?string
+    {
+        return $this->min;
+    }
+
+    public function setMax(?string $max): self
+    {
+        $this->max = $max;
+
+        return $this;
+    }
+
+    public function getMax(): ?string
+    {
+        return $this->max;
+    }
+}

tests/Aggregation/DateHistogramAggregationTest.php

@@ -47,4 +47,26 @@ public function testItBuildTheAggregationWithSet(): void
             ],
         ], $aggregation->build());
     }
+
+    public function testWithExtendedBounds(): void
+    {
+        $nameAndField = 'per_day';
+        $calendarInterval = 'day';
+        $field = 'date';
+        $min = '2022-01-10';
+        $max = '2022-01-20';
+
+        $aggregation = new DateHistogramAggregation($nameAndField, $calendarInterval, $field, [], $min, $max);
+
+        $this->assertEquals([
+            'date_histogram' => [
+                'field' => $field,
+                'calendar_interval' => $calendarInterval,
+                'extended_bounds' => [
+                    'min' => $min,
+                    'max' => $max,
+                ],
+            ],
+        ], $aggregation->build());
+    }
 }