PHPLIB-79: Add __debugInfo() handlers for info classes

Author: jmikola

src/Model/CollectionInfo.php

@@ -76,4 +76,15 @@ public function getCappedSize()
     {
         return isset($this->info['options']['size']) ? (integer) $this->info['options']['size'] : null;
     }
+
+    /**
+     * Return the collection info as an array.
+     *
+     * @see http://php.net/oop5.magic#language.oop5.magic.debuginfo
+     * @return array
+     */
+    public function __debugInfo()
+    {
+        return $this->info;
+    }
 }

src/Model/DatabaseInfo.php

@@ -55,4 +55,15 @@ public function isEmpty()
     {
         return (boolean) $this->info['empty'];
     }
+
+    /**
+     * Return the collection info as an array.
+     *
+     * @see http://php.net/oop5.magic#language.oop5.magic.debuginfo
+     * @return array
+     */
+    public function __debugInfo()
+    {
+        return $this->info;
+    }
 }

src/Model/IndexInfo.php

@@ -157,4 +157,15 @@ public function offsetUnset($key)
     {
         throw new BadMethodCallException('IndexInfo is immutable');
     }
+
+    /**
+     * Return the collection info as an array.
+     *
+     * @see http://php.net/oop5.magic#language.oop5.magic.debuginfo
+     * @return array
+     */
+    public function __debugInfo()
+    {
+        return $this->info;
+    }
 }

tests/Model/CollectionInfoTest.php

@@ -39,4 +39,15 @@ public function testCappedCollectionMethods()
         $this->assertSame(100, $info->getCappedMax());
         $this->assertSame(1048576, $info->getCappedSize());
     }
+
+    public function testDebugInfo()
+    {
+        $expectedInfo = array(
+            'name' => 'foo',
+            'options' => array('capped' => true, 'size' => 1048576),
+        );
+
+        $info = new CollectionInfo($expectedInfo);
+        $this->assertSame($expectedInfo, $info->__debugInfo());
+    }
 }

tests/Model/DatabaseInfoTest.php

@@ -15,7 +15,7 @@ public function testGetName()
 
     public function testGetSizeOnDisk()
     {
-        $info = new DatabaseInfo(array('sizeOnDisk' => '1048576'));
+        $info = new DatabaseInfo(array('sizeOnDisk' => 1048576));
         $this->assertSame(1048576, $info->getSizeOnDisk());
     }
 
@@ -27,4 +27,16 @@ public function testIsEmpty()
         $info = new DatabaseInfo(array('empty' => true));
         $this->assertTrue($info->isEmpty());
     }
+
+    public function testDebugInfo()
+    {
+        $expectedInfo = array(
+            'name' => 'foo',
+            'sizeOnDisk' => 1048576,
+            'empty' => false,
+        );
+
+        $info = new DatabaseInfo($expectedInfo);
+        $this->assertSame($expectedInfo, $info->__debugInfo());
+    }
 }

tests/Model/IndexInfoTest.php

@@ -83,4 +83,17 @@ public function testTtlIndex()
         $this->assertTrue(isset($info['expireAfterSeconds']));
         $this->assertSame(100, $info['expireAfterSeconds']);
     }
+
+    public function testDebugInfo()
+    {
+        $expectedInfo = array(
+            'v' => 1,
+            'key' => array('x' => 1),
+            'name' => 'x_1',
+            'ns' => 'foo.bar',
+        );
+
+        $info = new IndexInfo($expectedInfo);
+        $this->assertSame($expectedInfo, $info->__debugInfo());
+    }
 }