Merge pull request #10 from smoench/field-collapsing

add field collapsing

Author: smoench

src/FieldAwareTrait.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenSearchDSL\FieldCollapse;
+
+use OpenSearchDSL\BuilderInterface;
+use OpenSearchDSL\ParametersTrait;
+use stdClass;
+
+class FieldCollapse implements BuilderInterface
+{
+    use ParametersTrait;
+
+    /**
+     * @var list<InnerHits>
+     */
+    private array $innerHits = [];
+
+    public function __construct(
+        private readonly string $field
+    ) {
+    }
+
+    public function addInnerHits(InnerHits $innerHits): self
+    {
+        $this->innerHits[] = $innerHits;
+
+        return $this;
+    }
+
+    public function getType(): string
+    {
+        return 'collapse';
+    }
+
+    public function toArray(): array|stdClass
+    {
+        $array = [
+            'field' => $this->field,
+        ];
+
+        if ($this->innerHits !== []) {
+            $array['inner_hits'] = array_map(
+                static fn (InnerHits $innerHits) => $innerHits->toArray(),
+                $this->innerHits
+            );
+        }
+
+        return $this->processArray($array);
+    }
+}

src/FieldCollapse/FieldCollapse.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenSearchDSL\FieldCollapse;
+
+use OpenSearchDSL\BuilderInterface;
+use OpenSearchDSL\ParametersTrait;
+
+class InnerHits implements BuilderInterface
+{
+    use ParametersTrait;
+
+    private ?FieldCollapse $collapse = null;
+
+    public function __construct(
+        private readonly string $name,
+    ) {
+    }
+
+    public function setFieldCollapse(FieldCollapse $collapse): self
+    {
+        $this->collapse = $collapse;
+
+        return $this;
+    }
+
+    public function getType(): string
+    {
+        return 'inner_hits';
+    }
+
+    public function toArray(): array
+    {
+        $array = [
+            'name' => $this->name,
+        ];
+
+        if ($this->collapse instanceof FieldCollapse) {
+            $array['collapse'] = $this->collapse->toArray();
+        }
+
+        return $this->processArray($array);
+    }
+}

src/FieldCollapse/InnerHits.php

@@ -15,11 +15,13 @@
 
 use InvalidArgumentException;
 use OpenSearchDSL\Aggregation\AbstractAggregation;
+use OpenSearchDSL\FieldCollapse\FieldCollapse;
 use OpenSearchDSL\Highlight\Highlight;
 use OpenSearchDSL\InnerHit\NestedInnerHit;
 use OpenSearchDSL\Query\Compound\BoolQuery;
 use OpenSearchDSL\SearchEndpoint\AbstractSearchEndpoint;
 use OpenSearchDSL\SearchEndpoint\AggregationsEndpoint;
+use OpenSearchDSL\SearchEndpoint\CollapseEndpoint;
 use OpenSearchDSL\SearchEndpoint\HighlightEndpoint;
 use OpenSearchDSL\SearchEndpoint\InnerHitsEndpoint;
 use OpenSearchDSL\SearchEndpoint\PostFilterEndpoint;
@@ -188,9 +190,7 @@ private function getEndpoint(string $type): SearchEndpointInterface
      */
     public function getQueries(): ?BoolQuery
     {
-        $endpoint = $this->getEndpoint(QueryEndpoint::NAME);
-
-        return $endpoint->getBool();
+        return $this->getEndpoint(QueryEndpoint::NAME)->getBool();
     }
 
     /**
@@ -237,9 +237,7 @@ public function addPostFilter(
      */
     public function getPostFilters(): ?BoolQuery
     {
-        $endpoint = $this->getEndpoint(PostFilterEndpoint::NAME);
-
-        return $endpoint->getBool();
+        return $this->getEndpoint(PostFilterEndpoint::NAME)->getBool();
     }
 
     /**
@@ -325,7 +323,7 @@ public function addHighlight(Highlight $highlight): self
     /**
      * Returns highlight builder.
      */
-    public function getHighlights(): ?BuilderInterface
+    public function getHighlights(): ?Highlight
     {
         /** @var HighlightEndpoint $highlightEndpoint */
         $highlightEndpoint = $this->getEndpoint(HighlightEndpoint::NAME);
@@ -353,6 +351,24 @@ public function getSuggests(): array
         return $this->getEndpoint(SuggestEndpoint::NAME)->getAll();
     }
 
+    /**
+     * Allows to highlight search results on one or more fields.
+     */
+    public function addCollapse(FieldCollapse $collapse): self
+    {
+        $this->getEndpoint(CollapseEndpoint::NAME)->add($collapse, 'collapse');
+
+        return $this;
+    }
+
+    public function getCollapse(): ?FieldCollapse
+    {
+        /** @var CollapseEndpoint $endpoint */
+        $endpoint = $this->getEndpoint(CollapseEndpoint::NAME);
+
+        return $endpoint->getCollapse();
+    }
+
     public function getFrom(): ?int
     {
         return $this->from;

src/Search.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenSearchDSL\SearchEndpoint;
+
+use InvalidArgumentException;
+use OpenSearchDSL\BuilderInterface;
+use OpenSearchDSL\FieldCollapse\FieldCollapse;
+use OverflowException;
+
+class CollapseEndpoint extends AbstractSearchEndpoint
+{
+    final public const NAME = 'collapse';
+
+    private ?FieldCollapse $collapse = null;
+
+    private ?string $key = null;
+
+    public function normalize(): ?array
+    {
+        if ($this->collapse instanceof FieldCollapse) {
+            return $this->collapse->toArray();
+        }
+
+        return null;
+    }
+
+    public function add(BuilderInterface $builder, ?string $key = null): string
+    {
+        if (! $builder instanceof FieldCollapse) {
+            throw new InvalidArgumentException('Only FieldCollapse can be added');
+        }
+        if ($this->collapse instanceof FieldCollapse) {
+            throw new OverflowException('Only one highlight can be set');
+        }
+
+        if (! $key) {
+            $key = bin2hex(random_bytes(30));
+        }
+
+        $this->key = $key;
+        $this->collapse = $builder;
+
+        return $this->key;
+    }
+
+    public function getAll(?string $boolType = null): array
+    {
+        return [
+            $this->key => $this->collapse,
+        ];
+    }
+
+    public function getCollapse(): ?FieldCollapse
+    {
+        return $this->collapse;
+    }
+}

src/SearchEndpoint/CollapseEndpoint.php

@@ -13,29 +13,25 @@
 
 namespace OpenSearchDSL\SearchEndpoint;
 
+use InvalidArgumentException;
 use OpenSearchDSL\BuilderInterface;
+use OpenSearchDSL\Highlight\Highlight;
 use OverflowException;
 
 /**
  * Search highlight dsl endpoint.
  */
 class HighlightEndpoint extends AbstractSearchEndpoint
 {
-    /**
-     * Endpoint name
-     */
     final public const NAME = 'highlight';
 
-    private ?BuilderInterface $highlight = null;
+    private ?Highlight $highlight = null;
 
-    /**
-     * @var string|null Key for highlight storing.
-     */
     private ?string $key = null;
 
     public function normalize(): ?array
     {
-        if ($this->highlight instanceof \OpenSearchDSL\BuilderInterface) {
+        if ($this->highlight instanceof Highlight) {
             return $this->highlight->toArray();
         }
 
@@ -44,7 +40,10 @@ public function normalize(): ?array
 
     public function add(BuilderInterface $builder, ?string $key = null): string
     {
-        if ($this->highlight instanceof \OpenSearchDSL\BuilderInterface) {
+        if (! $builder instanceof Highlight) {
+            throw new InvalidArgumentException('Only highlight can be added');
+        }
+        if ($this->highlight instanceof Highlight) {
             throw new OverflowException('Only one highlight can be set');
         }
 
@@ -65,7 +64,7 @@ public function getAll(?string $boolType = null): array
         ];
     }
 
-    public function getHighlight(): ?BuilderInterface
+    public function getHighlight(): ?Highlight
     {
         return $this->highlight;
     }

src/SearchEndpoint/HighlightEndpoint.php

@@ -20,17 +20,15 @@
  */
 class SearchEndpointFactory
 {
-    /**
-     * @var array Holds namespaces for endpoints.
-     */
     private static array $endpoints = [
-        'query' => QueryEndpoint::class,
-        'post_filter' => PostFilterEndpoint::class,
-        'sort' => SortEndpoint::class,
-        'highlight' => HighlightEndpoint::class,
-        'aggregations' => AggregationsEndpoint::class,
-        'suggest' => SuggestEndpoint::class,
-        'inner_hits' => InnerHitsEndpoint::class,
+        QueryEndpoint::NAME => QueryEndpoint::class,
+        PostFilterEndpoint::NAME => PostFilterEndpoint::class,
+        SortEndpoint::NAME => SortEndpoint::class,
+        HighlightEndpoint::NAME => HighlightEndpoint::class,
+        AggregationsEndpoint::NAME => AggregationsEndpoint::class,
+        SuggestEndpoint::NAME => SuggestEndpoint::class,
+        InnerHitsEndpoint::NAME => InnerHitsEndpoint::class,
+        CollapseEndpoint::NAME => CollapseEndpoint::class,
     ];
 
     /**