create a federation object for the multi-search

meilisearch · Aug 1, 2024 · 47ffe4b · 47ffe4b
1 parent 8a906a7
commit 47ffe4b
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 3 deletions.
diff --git a/src/Contracts/SearchQuery.php b/src/Contracts/SearchQuery.php
@@ -4,6 +4,34 @@
 
 namespace Meilisearch\Contracts;
 
+class MultiSearchFederation
+{
+    private ?int $limit = null;
+    private ?int $offset = null;
+
+    public function setLimit(int $limit): MultiSearchFederation
+    {
+        $this->limit = $limit;
+
+        return $this;
+    }
+
+    public function setOffset(int $offset): MultiSearchFederation
+    {
+        $this->offset = $offset;
+
+        return $this;
+    }
+
+    public function toArray(): array
+    {
+        return array_filter([
+            'limit' => $this->limit,
+            'offset' => $this->offset,
+        ], static function ($item) { return null !== $item; });
+    }
+}
+
 class FederationOptions
 {
     private ?float $weight = null;

diff --git a/src/Endpoints/Delegates/HandlesMultiSearch.php b/src/Endpoints/Delegates/HandlesMultiSearch.php
@@ -5,6 +5,7 @@
 namespace Meilisearch\Endpoints\Delegates;
 
 use Meilisearch\Contracts\Http;
+use Meilisearch\Contracts\MultiSearchFederation;
 
 trait HandlesMultiSearch
 {
@@ -13,14 +14,14 @@ trait HandlesMultiSearch
     /**
      * @param list<\Meilisearch\Contracts\SearchQuery> $queries
      */
-    public function multiSearch(array $queries = [], array $multiSearchParams = [])
+    public function multiSearch(array $queries = [], ?MultiSearchFederation $federation = null)
     {
         $body = [];
 
         foreach ($queries as $query) {
             $body[] = $query->toArray();
         }
 
-        return $this->http->post('/multi-search', ['queries' => $body, ...$multiSearchParams]);
+        return $this->http->post('/multi-search', ['queries' => $body, 'federation' => $federation->toArray()]);
     }
 }
diff --git a/tests/Endpoints/MultiSearchTest.php b/tests/Endpoints/MultiSearchTest.php
@@ -5,6 +5,7 @@
 namespace Tests\Endpoints;
 
 use Meilisearch\Contracts\FederationOptions;
+use Meilisearch\Contracts\MultiSearchFederation;
 use Meilisearch\Contracts\SearchQuery;
 use Meilisearch\Endpoints\Indexes;
 use Tests\TestCase;
@@ -88,7 +89,7 @@ public function testFederation(): void
                 // By setting the weight to 0.9 this query should appear second
                 ->setFederationOptions((new FederationOptions())->setWeight(0.9)),
         ],
-            ['federation' => ['limit' => 2]]
+            (new MultiSearchFederation())->setLimit(2)
         );
 
         self::assertArrayHasKey('hits', $response);