PHPLIB-145: __debugInfo for Client, Database, and Collection

This allows the selectDatabase() and selectCollection() to be tested (PHPLIB-144).

src/Client.php

@@ -34,6 +34,20 @@ class Client
         $this->uri = (string) $uri;
     }
 
+    /**
+     * Return internal properties for debugging purposes.
+     *
+     * @see http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.debuginfo
+     * @param array
+     */
+    public function __debugInfo()
+    {
+        return [
+            'manager' => $this->manager,
+            'uri' => $this->uri,
+        ];
+    }
+
     /**
      * Return the connection string (i.e. URI).
      *

src/Collection.php

@@ -88,6 +88,23 @@ class Collection
         $this->writeConcern = isset($options['writeConcern']) ? $options['writeConcern'] : $this->manager->getWriteConcern();
     }
 
+    /**
+     * Return internal properties for debugging purposes.
+     *
+     * @see http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.debuginfo
+     * @param array
+     */
+    public function __debugInfo()
+    {
+        return [
+            'collectionName' => $this->collectionName,
+            'databaseName' => $this->databaseName,
+            'manager' => $this->manager,
+            'readPreference' => $this->readPreference,
+            'writeConcern' => $this->writeConcern,
+        ];
+    }
+
     /**
      * Return the collection namespace (e.g. "db.collection").
      *

src/Database.php

@@ -66,6 +66,22 @@ class Database
         $this->writeConcern = isset($options['writeConcern']) ? $options['writeConcern'] : $this->manager->getWriteConcern();
     }
 
+    /**
+     * Return internal properties for debugging purposes.
+     *
+     * @see http://php.net/manual/en/language.oop5.magic.php#language.oop5.magic.debuginfo
+     * @param array
+     */
+    public function __debugInfo()
+    {
+        return [
+            'databaseName' => $this->databaseName,
+            'manager' => $this->manager,
+            'readPreference' => $this->readPreference,
+            'writeConcern' => $this->writeConcern,
+        ];
+    }
+
     /**
      * Return the database name.
      *

tests/ClientTest.php

@@ -3,6 +3,8 @@
 namespace MongoDB\Tests;
 
 use MongoDB\Client;
+use MongoDB\Driver\ReadPreference;
+use MongoDB\Driver\WriteConcern;
 
 /**
  * Unit tests for the Client class.
@@ -22,4 +24,72 @@ class ClientTest extends TestCase
 
         $this->assertSame($this->getUri(), (string) $client);
     }
+
+    public function testSelectCollectionInheritsReadPreferenceAndWriteConcern()
+    {
+        $clientOptions = [
+            'readPreference' => 'secondaryPreferred',
+            'w' => WriteConcern::MAJORITY,
+        ];
+
+        $client = new Client($this->getUri(), $clientOptions);
+        $collection = $client->selectCollection($this->getDatabaseName(), $this->getCollectionName());
+        $debug = $collection->__debugInfo();
+
+        $this->assertInstanceOf('MongoDB\Driver\ReadPreference', $debug['readPreference']);
+        $this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
+        $this->assertInstanceOf('MongoDB\Driver\WriteConcern', $debug['writeConcern']);
+        $this->assertSame(WriteConcern::MAJORITY, $debug['writeConcern']->getW());
+    }
+
+    public function testSelectCollectionPassesReadPreferenceAndWriteConcern()
+    {
+        $collectionOptions = [
+            'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
+            'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
+        ];
+
+        $client = new Client($this->getUri());
+        $collection = $client->selectCollection($this->getDatabaseName(), $this->getCollectionName(), $collectionOptions);
+        $debug = $collection->__debugInfo();
+
+        $this->assertInstanceOf('MongoDB\Driver\ReadPreference', $debug['readPreference']);
+        $this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
+        $this->assertInstanceOf('MongoDB\Driver\WriteConcern', $debug['writeConcern']);
+        $this->assertSame(WriteConcern::MAJORITY, $debug['writeConcern']->getW());
+    }
+
+    public function testSelectDatabaseInheritsReadPreferenceAndWriteConcern()
+    {
+        $clientOptions = [
+            'readPreference' => 'secondaryPreferred',
+            'w' => WriteConcern::MAJORITY,
+        ];
+
+        $client = new Client($this->getUri(), $clientOptions);
+        $database = $client->selectDatabase($this->getDatabaseName());
+        $debug = $database->__debugInfo();
+
+        $this->assertInstanceOf('MongoDB\Driver\ReadPreference', $debug['readPreference']);
+        $this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
+        $this->assertInstanceOf('MongoDB\Driver\WriteConcern', $debug['writeConcern']);
+        $this->assertSame(WriteConcern::MAJORITY, $debug['writeConcern']->getW());
+    }
+
+    public function testSelectDatabasePassesReadPreferenceAndWriteConcern()
+    {
+        $databaseOptions = [
+            'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
+            'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
+        ];
+
+        $client = new Client($this->getUri());
+        $database = $client->selectDatabase($this->getDatabaseName(), $databaseOptions);
+        $debug = $database->__debugInfo();
+
+        $this->assertInstanceOf('MongoDB\Driver\ReadPreference', $debug['readPreference']);
+        $this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
+        $this->assertInstanceOf('MongoDB\Driver\WriteConcern', $debug['writeConcern']);
+        $this->assertSame(WriteConcern::MAJORITY, $debug['writeConcern']->getW());
+    }
 }

tests/Database/DatabaseFunctionalTest.php

@@ -4,6 +4,8 @@ namespace MongoDB\Tests\Database;
 
 use MongoDB\Database;
 use MongoDB\Driver\BulkWrite;
+use MongoDB\Driver\ReadPreference;
+use MongoDB\Driver\WriteConcern;
 
 /**
  * Functional tests for the Database class.
@@ -74,4 +76,37 @@ class DatabaseFunctionalTest extends FunctionalTestCase
         $this->assertCommandSucceeded($commandResult);
         $this->assertCollectionCount($this->getNamespace(), 0);
     }
+
+    public function testSelectCollectionInheritsReadPreferenceAndWriteConcern()
+    {
+        $databaseOptions = [
+            'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
+            'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
+        ];
+
+        $database = new Database($this->manager, $this->getDatabaseName(), $databaseOptions);
+        $collection = $database->selectCollection($this->getCollectionName());
+        $debug = $collection->__debugInfo();
+
+        $this->assertInstanceOf('MongoDB\Driver\ReadPreference', $debug['readPreference']);
+        $this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
+        $this->assertInstanceOf('MongoDB\Driver\WriteConcern', $debug['writeConcern']);
+        $this->assertSame(WriteConcern::MAJORITY, $debug['writeConcern']->getW());
+    }
+
+    public function testSelectCollectionPassesReadPreferenceAndWriteConcern()
+    {
+        $collectionOptions = [
+            'readPreference' => new ReadPreference(ReadPreference::RP_SECONDARY_PREFERRED),
+            'writeConcern' => new WriteConcern(WriteConcern::MAJORITY),
+        ];
+
+        $collection = $this->database->selectCollection($this->getCollectionName(), $collectionOptions);
+        $debug = $collection->__debugInfo();
+
+        $this->assertInstanceOf('MongoDB\Driver\ReadPreference', $debug['readPreference']);
+        $this->assertSame(ReadPreference::RP_SECONDARY_PREFERRED, $debug['readPreference']->getMode());
+        $this->assertInstanceOf('MongoDB\Driver\WriteConcern', $debug['writeConcern']);
+        $this->assertSame(WriteConcern::MAJORITY, $debug['writeConcern']->getW());
+    }
 }