Support for multi_search. Resolves #14

Author: jasonbosco

README.md

@@ -22,6 +22,7 @@ Typesense uses [HTTPlug](http://httplug.io/) as an abstraction layer for an HTTP
 
 | Typesense Server | typesense-php |
 |------------------|----------------|
+| \>= v0.19.0 | \>= v4.5.0 |
 | \>= v0.18.0 | \>= v4.4.0 |
 | \>= v0.17.0 | \>= v4.2.0 |
 | \>= v0.16.0 | \>= v4.1.0 |

docker-compose.yml

@@ -2,7 +2,7 @@ version: '3.5'
 
 services:
     typesense:
-        image: typesense/typesense:0.18.0
+        image: typesense/typesense:0.19.0.rc18
         environment:
             TYPESENSE_DATA_DIR: /data
             TYPESENSE_API_KEY: xyz

examples/collection_operations.php

@@ -159,12 +159,35 @@
     );
     echo "--------Search Document-------\n";
     echo "\n";
+    echo "--------Multi search-------\n";
+    print_r(
+        $client->multiSearch->perform(
+            [
+                'searches' => [
+                    [
+                        'q' => 'hunger',
+                        'sort_by' => 'ratings_count:desc',
+                    ],
+                    [
+                        'q' => 'game',
+                        'sort_by' => 'ratings_count:asc',
+                    ]
+                ]
+            ],
+            [
+                'query_by' => 'title',
+                'collection' => 'books'
+            ]
+        )
+    );
+    echo "--------Multi Search-------\n";
+    echo "\n";
     echo "--------Delete Document-------\n";
     print_r($client->collections['books']->documents['1']->delete());
     echo "--------Delete Document-------\n";
     echo "\n";
     echo "--------Import Documents-------\n";
-    $docsToImport         = [];
+    $docsToImport = [];
     $exportedDocStrsArray = explode('\n', $exportedDocStrs);
     foreach ($exportedDocStrsArray as $exportedDocStr) {
         $docsToImport[] = json_decode($exportedDocStr, true);

src/Client.php

@@ -55,6 +55,11 @@ class Client
      */
     public Operations $operations;
 
+    /**
+     * @var MultiSearch
+     */
+    public MultiSearch $multiSearch;
+
     /**
      * @var ApiCall
      */
@@ -79,6 +84,7 @@ public function __construct(array $config)
         $this->metrics     = new Metrics($this->apiCall);
         $this->health      = new Health($this->apiCall);
         $this->operations  = new Operations($this->apiCall);
+        $this->multiSearch = new MultiSearch($this->apiCall);
     }
 
     /**
@@ -136,4 +142,12 @@ public function getOperations(): Operations
     {
         return $this->operations;
     }
+
+    /**
+     * @return MultiSearch
+     */
+    public function getMultiSearch(): MultiSearch
+    {
+        return $this->multiSearch;
+    }
 }

src/MultiSearch.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Typesense;
+
+use Http\Client\Exception as HttpClientException;
+use Typesense\Exceptions\TypesenseClientError;
+
+/**
+ * Class MultiSearch
+ *
+ * @package \Typesense
+ */
+class MultiSearch
+{
+    public const RESOURCE_PATH = '/multi_search';
+
+    /**
+     * @var ApiCall
+     */
+    private ApiCall $apiCall;
+
+    /**
+     * Alias constructor.
+     *
+     * @param ApiCall $apiCall
+     */
+    public function __construct(ApiCall $apiCall)
+    {
+        $this->apiCall = $apiCall;
+    }
+
+    /**
+     * @param string $searches
+     * @param array $queryParameters
+     *
+     * @return array
+     * @throws TypesenseClientError|HttpClientException
+     */
+    public function perform(array $searches, array $queryParameters = []): array
+    {
+        return $this->apiCall->post(
+            sprintf('%s', static::RESOURCE_PATH),
+            $searches,
+            true,
+            $queryParameters
+        );
+    }
+}