Feature: Search improvements (#54)

Author: miagilepner

lib/GetStream/StreamChat/Client.php

@@ -877,13 +877,28 @@ public function search($filterConditions, $query, $options=null)
         if ($options === null) {
             $options = [];
         }
+
+        if (array_key_exists('offset', $options) && $options['offset'] > 0) {
+            if (array_key_exists('next', $options) || array_key_exists('sort', $options)) {
+                throw new StreamException("Cannot use offset with next or sort parameters");
+            }
+        }
+
         $options['filter_conditions'] = $filterConditions;
         if (is_string($query)) {
             $options['query'] = $query;
         } else {
             $options['message_filter_conditions'] = $query;
         }
 
+        $sortFields = [];
+        if (array_key_exists('sort', $options)) {
+            $sort = $options['sort'];
+            foreach ($sort as $k => $v) {
+                $sortFields[] = ["field" => $k, "direction" => $v];
+            }
+        }
+        $options['sort'] = $sortFields;
         return $this->get("search", ["payload" => json_encode($options)]);
     }
 

tests/integration/IntegrationTest.php

@@ -690,6 +690,55 @@ public function testSearch()
         $this->assertSame(count($response['results']), 1);
     }
 
+    public function testSearchOffsetAndSortFails()
+    {
+        $this->expectException(\GetStream\StreamChat\StreamException::class);
+        $query = "supercalifragilisticexpialidocious";
+        $this->client->search(
+            ["type" => "messaging"],
+            $query,
+            ["sort" => [["created_at"=>-1]], "offset" => 1]
+        );
+    }
+
+    public function testSearchOffsetAndNextFails()
+    {
+        $this->expectException(\GetStream\StreamChat\StreamException::class);
+        $query = "supercalifragilisticexpialidocious";
+        $this->client->search(
+            ["type" => "messaging"],
+            $query,
+            ["next" => $query, "offset" => 1]
+        );
+    }
+
+
+    public function testSearchWithSort()
+    {
+        $this->markTestSkipped();
+        $user = $this->getUser();
+        $channel = $this->getChannel();
+        $query = "supercalifragilisticexpialidocious";
+        $channel->sendMessage(["text" => "How many syllables are there in " . $query . "?"], $user["id"]);
+        $channel->sendMessage(["text" => "Does ". $query . " count as one or two?"], $user["id"]);
+        $response = $this->client->search(
+            ["type" => "messaging"],
+            $query,
+            ["sort"=> [["created_at"=> -1]], "limit" => 1]
+        );
+        // searches all channels so make sure at least one is found
+        $this->assertTrue(count($response['results']) >= 1);
+        $this->assertTrue(strpos($response['results'][0]['message']['text'], $query)!==false);
+        $response = $this->client->search(
+            ["type" => "messaging"],
+            $query,
+            ["limit" => 1, "next"=> $response['next']]
+        );
+        $this->assertTrue(count($response['results']) >= 1);
+        $this->assertTrue(strpos($response['results'][0]['message']['text'], $query)!==false);
+    }
+
+
     public function testGetMessage()
     {
         $user = $this->getUser();