Handle new Cursor and toArray() API in extension

PHPC-224 consolidated the Result and Cursor classes into one. Additionally, PHPC-203 changed toArray() to return iterator_to_array($this) instead of only the first result document. For commands, this means we need to extract the first element in toArray()'s return value.

src/Client.php

@@ -3,9 +3,9 @@
 namespace MongoDB;
 
 use MongoDB\Driver\Command;
+use MongoDB\Driver\Cursor;
 use MongoDB\Driver\Manager;
 use MongoDB\Driver\ReadPreference;
-use MongoDB\Driver\Result;
 use MongoDB\Driver\WriteConcern;
 use ArrayIterator;
 use stdClass;
@@ -39,7 +39,7 @@ public function __construct($uri, array $options = array(), array $driverOptions
      *
      * @see http://docs.mongodb.org/manual/reference/command/dropDatabase/
      * @param string $databaseName
-     * @return Result
+     * @return Cursor
      */
     public function dropDatabase($databaseName)
     {
@@ -61,9 +61,8 @@ public function listDatabases()
     {
         $command = new Command(array('listDatabases' => 1));
 
-        $result = $this->manager->executeCommand('admin', $command);
-        $result = iterator_to_array($result);
-        $result = current($result);
+        $cursor = $this->manager->executeCommand('admin', $command);
+        $result = current($cursor->toArray());
 
         if ( ! isset($result['databases']) || ! is_array($result['databases'])) {
             throw new UnexpectedValueException('listDatabases command did not return a "databases" array');

src/Collection.php

@@ -3,10 +3,10 @@
 namespace MongoDB;
 
 use MongoDB\Driver\Command;
+use MongoDB\Driver\Cursor;
 use MongoDB\Driver\Manager;
 use MongoDB\Driver\Query;
 use MongoDB\Driver\ReadPreference;
-use MongoDB\Driver\Result;
 use MongoDB\Driver\BulkWrite;
 use MongoDB\Driver\WriteConcern;
 
@@ -86,14 +86,16 @@ public function aggregate(array $pipeline, array $options = array())
             "pipeline"  => $pipeline,
         ) + $options;
 
-        $result = $this->_runCommand($this->dbname, $cmd);
-        $doc = $result->toArray();
+        $cursor = $this->_runCommand($this->dbname, $cmd);
+
         if (isset($cmd["cursor"]) && $cmd["cursor"]) {
-            return $result;
-        } else {
-            if ($doc["ok"]) {
-                return new \ArrayIterator($doc["result"]);
-            }
+            return $cursor;
+        }
+
+        $doc = current($cursor->toArray());
+
+        if ($doc["ok"]) {
+            return new \ArrayIterator($doc["result"]);
         }
 
         throw $this->_generateCommandException($doc);
@@ -234,7 +236,7 @@ public function count(array $filter = array(), array $options = array())
             "query" => $filter,
         ) + $options;
 
-        $doc = $this->_runCommand($this->dbname, $cmd)->toArray();
+        $doc = current($this->_runCommand($this->dbname, $cmd)->toArray());
         if ($doc["ok"]) {
             return $doc["n"];
         }
@@ -324,7 +326,7 @@ public function distinct($fieldName, array $filter = array(), array $options = a
             "query"    => $filter,
         ) + $options;
 
-        $doc = $this->_runCommand($this->dbname, $cmd)->toArray();
+        $doc = current($this->_runCommand($this->dbname, $cmd)->toArray());
         if ($doc["ok"]) {
             return $doc["values"];
         }
@@ -335,7 +337,7 @@ public function distinct($fieldName, array $filter = array(), array $options = a
      * Drop this collection.
      *
      * @see http://docs.mongodb.org/manual/reference/command/drop/
-     * @return Result
+     * @return Cursor
      */
     public function drop()
     {
@@ -351,7 +353,7 @@ public function drop()
      * @see http://docs.mongodb.org/manual/reference/command/dropIndexes/
      * @see http://docs.mongodb.org/manual/reference/method/db.collection.dropIndex/
      * @param string $indexName
-     * @return Result
+     * @return Cursor
      * @throws InvalidArgumentException if "*" is specified
      */
     public function dropIndex($indexName)
@@ -364,7 +366,7 @@ public function dropIndex($indexName)
      *
      * @see http://docs.mongodb.org/manual/reference/command/dropIndexes/
      * @see http://docs.mongodb.org/manual/reference/method/db.collection.dropIndexes/
-     * @return Result
+     * @return Cursor
      */
     public function dropIndexes()
     {
@@ -379,7 +381,7 @@ public function dropIndexes()
      *
      * @param array $filter    The find query to execute
      * @param array $options   Additional options
-     * @return Result
+     * @return Cursor
      */
     public function find(array $filter = array(), array $options = array())
     {
@@ -437,7 +439,7 @@ public function findOneAndDelete(array $filter, array $options = array())
             "query"         => $filter,
         ) + $options;
 
-        $doc = $this->_runCommand($this->dbname, $cmd)->toArray();
+        $doc = current($this->_runCommand($this->dbname, $cmd)->toArray());
         if ($doc["ok"]) {
             return $doc["value"];
         }
@@ -474,7 +476,7 @@ public function findOneAndReplace(array $filter, array $replacement, array $opti
             "query"         => $filter,
         ) + $options;
 
-        $doc = $this->_runCommand($this->dbname, $cmd)->toArray();
+        $doc = current($this->_runCommand($this->dbname, $cmd)->toArray());
         if ($doc["ok"]) {
             return $doc["value"];
         }
@@ -512,7 +514,7 @@ public function findOneAndUpdate(array $filter, array $update, array $options =
             "query"         => $filter,
         ) + $options;
 
-        $doc = $this->_runCommand($this->dbname, $cmd)->toArray();
+        $doc = current($this->_runCommand($this->dbname, $cmd)->toArray());
         if ($doc["ok"]) {
             return $doc["value"];
         }
@@ -951,7 +953,7 @@ public function insertOne(array $document)
      *
      * @see http://docs.mongodb.org/manual/reference/command/listIndexes/
      * @see http://docs.mongodb.org/manual/reference/method/db.collection.getIndexes/
-     * @return Result
+     * @return Cursor
      */
     public function listIndexes()
     {

src/Database.php

@@ -4,10 +4,10 @@
 
 use MongoDB\Collection;
 use MongoDB\Driver\Command;
+use MongoDB\Driver\Cursor;
 use MongoDB\Driver\Manager;
 use MongoDB\Driver\Query;
 use MongoDB\Driver\ReadPreference;
-use MongoDB\Driver\Result;
 use MongoDB\Driver\WriteConcern;
 use MongoDB\Model\CollectionInfoIterator;
 use MongoDB\Model\CollectionInfoCommandIterator;
@@ -47,7 +47,7 @@ public function __construct(Manager $manager, $databaseName, WriteConcern $write
      * @see http://docs.mongodb.org/manual/reference/method/db.createCollection/
      * @param string $collectionName
      * @param array  $options
-     * @return Result
+     * @return Cursor
      */
     public function createCollection($collectionName, array $options = array())
     {
@@ -58,7 +58,7 @@ public function createCollection($collectionName, array $options = array())
      * Drop this database.
      *
      * @see http://docs.mongodb.org/manual/reference/command/dropDatabase/
-     * @return Result
+     * @return Cursor
      */
     public function drop()
     {
@@ -73,7 +73,7 @@ public function drop()
      *
      * @see http://docs.mongodb.org/manual/reference/command/drop/
      * @param string $collectionName
-     * @return Result
+     * @return Cursor
      */
     public function dropCollection($collectionName)
     {
@@ -130,9 +130,9 @@ private function listCollectionsCommand(array $options = array())
         // TODO: Relax RP if connected to a secondary node in standalone mode
         $readPreference = new ReadPreference(ReadPreference::RP_PRIMARY);
 
-        $result = $this->manager->executeCommand($this->databaseName, $command, $readPreference);
+        $cursor = $this->manager->executeCommand($this->databaseName, $command, $readPreference);
 
-        return new CollectionInfoCommandIterator($result);
+        return new CollectionInfoCommandIterator($cursor);
     }
 
     /**
@@ -166,8 +166,8 @@ private function listCollectionsLegacy(array $options = array())
         // TODO: Relax RP if connected to a secondary node in standalone mode
         $readPreference = new ReadPreference(ReadPreference::RP_PRIMARY);
 
-        $result = $this->manager->executeQuery($namespace, $query, $readPreference);
+        $cursor = $this->manager->executeQuery($namespace, $query, $readPreference);
 
-        return new CollectionInfoLegacyIterator($result);
+        return new CollectionInfoLegacyIterator($cursor);
     }
 }

tests/CollectionFunctionalTest.php

@@ -49,7 +49,7 @@ function testInsertAndRetrieve()
         $count = $this->collection->count($query);
         $this->assertEquals(1, $count);
         $cursor = $this->collection->find($query);
-        $this->assertInstanceOf('MongoDB\Driver\Result', $cursor);
+        $this->assertInstanceOf('MongoDB\Driver\Cursor', $cursor);
 
         foreach($cursor as $n => $person) {
             $this->assertInternalType("array", $person);

tests/FunctionalTestCase.php

@@ -4,7 +4,7 @@
 
 use MongoDB\Driver\Command;
 use MongoDB\Driver\Manager;
-use MongoDB\Driver\Result;
+use MongoDB\Driver\Cursor;
 
 abstract class FunctionalTestCase extends TestCase
 {
@@ -19,16 +19,16 @@ public function assertCollectionCount($namespace, $count)
     {
         list($databaseName, $collectionName) = explode('.', $namespace, 2);
 
-        $result = $this->manager->executeCommand($databaseName, new Command(array('count' => $collectionName)));
+        $cursor = $this->manager->executeCommand($databaseName, new Command(array('count' => $collectionName)));
 
-        $document = $result->toArray();
+        $document = current($cursor->toArray());
         $this->assertArrayHasKey('n', $document);
         $this->assertEquals($count, $document['n']);
     }
 
-    public function assertCommandSucceeded(Result $result)
+    public function assertCommandSucceeded(Cursor $cursor)
     {
-        $document = $result->toArray();
+        $document = current($cursor->toArray());
         $this->assertArrayHasKey('ok', $document);
         $this->assertEquals(1, $document['ok']);
     }