Merge option arrays for listSearchIndexes

Author: GromNaN

src/Collection.php

@@ -1015,22 +1015,22 @@ public function listIndexes(array $options = [])
     }
 
     /**
-     * Returns information for all indexes for the collection.
+     * Returns information for all Atlas Search indexes for the collection.
      *
      * @see ListSearchIndexes::__construct() for supported aggregation and list options
      * @return Traversable
      * @throws InvalidArgumentException for parameter/option parsing errors
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
-    public function listSearchIndexes(string $name, array $aggregationOptions = [], array $listIndexOptions = []): Traversable
+    public function listSearchIndexes(string $name, array $options = []): Traversable
     {
         $filter = [];
         if ($name) {
             $filter += ['name' => $name];
         }
 
-        $operation = new ListSearchIndexes($this->databaseName, $this->collectionName, $filter, $aggregationOptions + $listIndexOptions);
-        $server = select_server($this->manager, $listIndexOptions);
+        $operation = new ListSearchIndexes($this->databaseName, $this->collectionName, $filter, $options);
+        $server = select_server($this->manager, $options);
 
         return $operation->execute($server);
     }

src/Operation/ListSearchIndexes.php

@@ -17,17 +17,18 @@
 
 namespace MongoDB\Operation;
 
+use ArrayIterator;
 use MongoDB\Driver\Cursor;
 use MongoDB\Driver\Exception\RuntimeException as DriverRuntimeException;
 use MongoDB\Driver\Server;
 use MongoDB\Exception\InvalidArgumentException;
 use MongoDB\Exception\UnexpectedValueException;
 use MongoDB\Exception\UnsupportedException;
 
-use function array_intersect_key;
 use function is_array;
-use function is_integer;
 use function is_object;
+use function is_string;
+use function MongoDB\document_to_array;
 
 /**
  * Operation for the listSearchIndexes command.
@@ -49,9 +50,6 @@ class ListSearchIndexes implements Executable
     /** @var array */
     private $aggregateOptions;
 
-    /** @var array */
-    private $listIndexesOptions;
-
     /** @var Aggregate */
     private $aggregate;
 
@@ -64,26 +62,25 @@ class ListSearchIndexes implements Executable
      * @param array        $options        Command options
      * @throws InvalidArgumentException for parameter/option parsing errors
      */
-    public function __construct(string $databaseName, string $collectionName, array $filter, array $options = [])
+    public function __construct(string $databaseName, string $collectionName, $filter, array $options = [])
     {
         if (! is_array($filter) && ! is_object($filter)) {
             throw InvalidArgumentException::invalidType('$filter', $filter, 'array or object');
         }
 
-        if (isset($options['limit']) && ! is_integer($options['limit'])) {
-            throw InvalidArgumentException::invalidType('"limit" option', $options['limit'], 'integer');
-        }
+        $filter = document_to_array($filter);
 
-        if (isset($options['skip']) && ! is_integer($options['skip'])) {
-            throw InvalidArgumentException::invalidType('"skip" option', $options['skip'], 'integer');
+        if (isset($filter['name']) && ! is_string($options['name'])) {
+            throw InvalidArgumentException::invalidType('"name" filter', $filter['name'], 'string');
         }
 
         $this->databaseName = $databaseName;
         $this->collectionName = $collectionName;
         $this->filter = $filter;
 
-        $this->aggregateOptions = array_intersect_key($options, ['batchSize' => 1]);
-        $this->listIndexesOptions = array_intersect_key($options, ['limit' => 1, 'skip' => 1]);
+        /* There is currently no additional options for the $listSearchIndexes operation, the $options array can be
+         * split into two parts: $listIndexesOptions and $aggregateOptions if options are added in the future. */
+        $this->aggregateOptions = $options;
 
         $this->aggregate = $this->createAggregate();
     }
@@ -92,11 +89,12 @@ public function __construct(string $databaseName, string $collectionName, array
      * Execute the operation.
      *
      * @see Executable::execute()
+     * @return ArrayIterator|Cursor
      * @throws UnexpectedValueException if the command response was malformed
      * @throws UnsupportedException if collation or read concern is used and unsupported
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */
-    public function execute(Server $server): Cursor
+    public function execute(Server $server)
     {
         return $this->aggregate->execute($server);
     }
@@ -107,14 +105,6 @@ private function createAggregate(): Aggregate
             ['$listSearchIndexes' => (object) $this->filter],
         ];
 
-        if (isset($this->listIndexesOptions['skip'])) {
-            $pipeline[] = ['$skip' => $this->listIndexesOptions['skip']];
-        }
-
-        if (isset($this->listIndexesOptions['limit'])) {
-            $pipeline[] = ['$limit' => $this->listIndexesOptions['limit']];
-        }
-
         return new Aggregate($this->databaseName, $this->collectionName, $pipeline, $this->aggregateOptions);
     }
 }