Merge pull request #53 from ensi-platform/v7-inner-hits

Collaps Inner Hits and Search Aggregation

Author: MsNatali

src/Search/Collapsing/Collapse.php

@@ -5,10 +5,16 @@
 use Ensi\LaravelElasticQuery\Contracts\DSLAware;
 use Webmozart\Assert\Assert;
 
+/**
+ * @property string $field
+ * @property InnerHits[] $innerHits
+ */
 class Collapse implements DSLAware
 {
-    public function __construct(private string $field)
-    {
+    public function __construct(
+        private string $field,
+        private array $innerHits = [],
+    ) {
         Assert::stringNotEmpty(trim($field));
     }
 
@@ -19,6 +25,13 @@ public function field(): string
 
     public function toDSL(): array
     {
-        return ['field' => $this->field];
+        $dsl = ['field' => $this->field];
+
+        /** @var InnerHits $innerHit */
+        foreach ($this->innerHits as $innerHit) {
+            $dsl['inner_hits'][] = $innerHit->toDSL();
+        }
+
+        return $dsl;
     }
 }

src/Search/Collapsing/InnerHits.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Ensi\LaravelElasticQuery\Search\Collapsing;
+
+use Ensi\LaravelElasticQuery\Contracts\DSLAware;
+use Ensi\LaravelElasticQuery\Search\Sorting\Sort;
+use Webmozart\Assert\Assert;
+
+class InnerHits implements DSLAware
+{
+    public function __construct(
+        protected string $name,
+        protected int $size,
+        protected ?Sort $sort,
+    ) {
+        Assert::stringNotEmpty(trim($name));
+    }
+
+    public function toDSL(): array
+    {
+        $dsl = [
+            'name' => $this->name,
+            'size' => $this->size,
+        ];
+
+        if ($this->sort) {
+            $dsl['sort'] = $this->sort->toDSL();
+        }
+
+        return $dsl;
+    }
+}

src/Search/CursorPage.php

@@ -9,6 +9,7 @@ class CursorPage
     public function __construct(
         int $size,
         public Collection $hits,
+        public Collection|null $aggs,
         public ?string $current = null,
         public ?string $next = null,
         public ?string $previous = null

src/Search/Page.php

@@ -9,6 +9,7 @@ class Page
     public function __construct(
         public int $size,
         public Collection $hits,
+        public Collection|null $aggs,
         public int $offset = 0,
         public int $total = 0
     ) {

src/Search/SearchQuery.php

@@ -3,8 +3,10 @@
 namespace Ensi\LaravelElasticQuery\Search;
 
 use Closure;
+use Ensi\LaravelElasticQuery\Aggregating\AggregationCollection;
 use Ensi\LaravelElasticQuery\Concerns\DecoratesBoolQuery;
 use Ensi\LaravelElasticQuery\Concerns\ExtendsSort;
+use Ensi\LaravelElasticQuery\Contracts\Aggregation;
 use Ensi\LaravelElasticQuery\Contracts\CollapsibleQuery;
 use Ensi\LaravelElasticQuery\Contracts\SearchIndex;
 use Ensi\LaravelElasticQuery\Contracts\SortableQuery;
@@ -25,6 +27,7 @@ class SearchQuery implements SortableQuery, CollapsibleQuery
     protected BoolQueryBuilder $boolQuery;
     protected SortCollection $sorts;
     protected ?Collapse $collapse = null;
+    protected ?AggregationCollection $aggregations = null;
     protected ?int $size = null;
     protected ?int $from = null;
     protected array $fields = [];
@@ -60,6 +63,7 @@ public function paginate(int $size, int $offset = 0): Page
         return new Page(
             $size,
             $hits,
+            aggs: $this->aggregations?->parseResults($response['aggregations'] ?? []),
             offset: $offset,
             total: data_get($response, 'hits.total.value', 0)
         );
@@ -82,6 +86,7 @@ public function cursorPaginate(int $size, ?string $cursor = null): CursorPage
         return new CursorPage(
             $size,
             $hits,
+            aggs: $this->aggregations?->parseResults($response['aggregations'] ?? []),
             current: $current->encode(),
             next: $this->findNextCursor($sorts, $size, $hits),
             previous: $this->findPreviousCursor($sorts, $size, $current)
@@ -131,6 +136,10 @@ protected function execute(
             $dsl['sort'] = $sorts->toDSL();
         }
 
+        if (!is_null($this->aggregations)) {
+            $dsl['aggs'] = $this->aggregations->toDSL();
+        }
+
         if (!is_null($this->collapse)) {
             $dsl['collapse'] = $this->collapse->toDSL();
         }
@@ -175,9 +184,17 @@ public function sortByNested(string $field, Closure $callback): static
         return $this;
     }
 
-    public function collapse(string $field): static
+    public function collapse(string $field, array $innerHits = []): static
+    {
+        $this->collapse = new Collapse($field, $innerHits);
+
+        return $this;
+    }
+
+    public function addAggregations(Aggregation $aggregation): static
     {
-        $this->collapse = new Collapse($field);
+        $this->aggregations ??= new AggregationCollection();
+        $this->aggregations->add($aggregation);
 
         return $this;
     }