Merge pull request #93 from apisearch-io/feature/index-can-be-forced-in-query

Added indexUUID in query

Author: mmoreram

Query/Query.php

@@ -19,6 +19,7 @@
 use Apisearch\Geo\LocationRange;
 use Apisearch\Model\Coordinate;
 use Apisearch\Model\HttpTransportable;
+use Apisearch\Model\IndexUUID;
 use Apisearch\Model\Item;
 use Apisearch\Model\ItemUUID;
 use Apisearch\Model\User;
@@ -210,6 +211,13 @@ class Query implements HttpTransportable
      */
     private $subqueries = [];
 
+    /**
+     * @var IndexUUID
+     *
+     * Index UUID
+     */
+    private $indexUUID;
+
     /**
      * Construct.
      *
@@ -1409,6 +1417,30 @@ public function getUUID(): ? string
         return $this->UUID;
     }
 
+    /**
+     * Force Index UUID.
+     *
+     * @param IndexUUID $indexUUID
+     *
+     * @return Query
+     */
+    public function forceIndexUUID(IndexUUID $indexUUID): Query
+    {
+        $this->indexUUID = $indexUUID;
+
+        return $this;
+    }
+
+    /**
+     * Get index UUID.
+     *
+     * @return IndexUUID|null
+     */
+    public function getIndexUUID(): ? IndexUUID
+    {
+        return $this->indexUUID;
+    }
+
     /**
      * To array.
      *
@@ -1477,6 +1509,9 @@ public function toArray(): array
                     return $itemUUID->toArray();
                 }, $this->itemsPromoted)
             ),
+            'index_uuid' => ($this->indexUUID instanceof IndexUUID)
+                ? $this->indexUUID->toArray()
+                : null,
         ], function ($element) {
             return
             !(
@@ -1551,6 +1586,9 @@ public static function createFromArray(array $array): self
         if (isset($array['uuid'])) {
             $query->UUID = $array['uuid'];
         }
+        if (isset($array['index_uuid'])) {
+            $query->indexUUID = IndexUUID::createFromArray($array['index_uuid']);
+        }
 
         return $query;
     }

Tests/Query/QueryTest.php

@@ -15,6 +15,7 @@
 
 namespace Apisearch\Tests\Query;
 
+use Apisearch\Model\IndexUUID;
 use Apisearch\Query\Query;
 use Apisearch\Query\ScoreStrategies;
 use Apisearch\Query\SortBy;
@@ -71,6 +72,7 @@ public function testDefaults()
         $this->assertEquals([], $query->getMetadata());
         $this->assertEquals($query, HttpHelper::emulateHttpTransport($query));
         $this->assertNull($query->getUUID());
+        $this->assertNull($query->getIndexUUID());
     }
 
     /**
@@ -202,4 +204,18 @@ public function testIdentifier()
         $query = HttpHelper::emulateHttpTransport($query);
         $this->assertEquals('123', $query->getUUID());
     }
+
+    /**
+     * Test indexUUID.
+     */
+    public function testIndexUUID()
+    {
+        $indexUUID = IndexUUID::createById('123');
+        $query = Query::createMatchAll()->forceIndexUUID($indexUUID);
+        $this->assertEquals($indexUUID, $query->getIndexUUID());
+        $this->assertEquals($indexUUID->toArray(), $query->toArray()['index_uuid']);
+        $query = HttpHelper::emulateHttpTransport($query);
+        $this->assertEquals($indexUUID, $query->getIndexUUID());
+        $this->assertEquals($indexUUID->toArray(), $query->toArray()['index_uuid']);
+    }
 }