feat: add polyfill for array_is_list and make query handling more generic

Author: Benoit POLASZEK

composer.json

@@ -28,7 +28,8 @@
         "psr-4": {
             "MeiliSearch\\": "src/",
             "Meilisearch\\": "src/"
-        }
+        },
+      "files": ["src/polyfills.php"]
     },
     "autoload-dev": {
         "psr-4": {

phpstan.dist.neon

@@ -10,5 +10,7 @@ parameters:
 	paths:
 		- src
 		- tests
+	tips:
+		treatPhpDocTypesAsCertain: false
 	additionalConstructors:
 		- PHPUnit\Framework\TestCase::setUp

src/Endpoints/Delegates/HandlesDocuments.php

@@ -29,12 +29,6 @@ public function getDocuments(?DocumentsQuery $options = null): DocumentsResults
             if ($options->hasFilter()) {
                 $response = $this->http->post(self::PATH.'/'.$this->uid.'/documents/fetch', $query);
             } else {
-                if (isset($query['sort'])) {
-                    $query['sort'] = implode(',', $query['sort']);
-                }
-                if (isset($query['fields'])) {
-                    $query['fields'] = implode(',', $query['fields']);
-                }
                 $response = $this->http->get(self::PATH.'/'.$this->uid.'/documents', $query);
             }
 

src/Http/Client.php

@@ -165,6 +165,9 @@ private function buildQueryString(array $queryParams = []): string
             if (\is_bool($value)) {
                 $queryParams[$key] = $value ? 'true' : 'false';
             }
+            if (\is_array($value) && array_is_list($value)) {
+                $queryParams[$key] = implode(',', $value);
+            }
         }
 
         return \count($queryParams) > 0 ? '?'.http_build_query($queryParams) : '';

src/polyfills.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+if (!function_exists('array_is_list')) {
+    /**
+     * @param array<mixed, mixed> $array
+     *
+     * @see https://github.com/symfony/polyfill/blob/1.x/src/Php81/Php81.php
+     */
+    function array_is_list(array $array): bool
+    {
+        if ([] === $array || $array === array_values($array)) {
+            return true;
+        }
+
+        $nextKey = -1;
+
+        foreach ($array as $k => $v) {
+            if ($k !== ++$nextKey) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}

tests/PollyfillsTest.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests;
+
+use PHPUnit\Framework\Attributes\RequiresPhp;
+
+class PollyfillsTest extends TestCase
+{
+    #[RequiresPhp('< 8.0')]
+    public function testArrayIsList(): void
+    {
+        self::assertTrue(array_is_list([])); // @phpstan-ignore-line
+        self::assertTrue(array_is_list(['foo', 'bar'])); // @phpstan-ignore-line
+        self::assertFalse(array_is_list(['foo' => 'bar'])); // @phpstan-ignore-line
+        self::assertFalse(array_is_list([0 => 'foo', 'foo' => 'bar'])); // @phpstan-ignore-line
+    }
+}