PHPLIB-675 Add helpers to check collection types to CollectionInfo (#839)

* PHPLIB-675 Expose additional methods to access collection info

* Use arrayNotHasKey over isset in tests

* Add version information to deprecation messages

Author: alcaeus

src/Model/CollectionInfo.php

@@ -60,6 +60,8 @@ public function __debugInfo()
     /**
      * Return the maximum number of documents to keep in the capped collection.
      *
+     * @deprecated 1.0 Deprecated in favor of using getOptions
+     *
      * @return integer|null
      */
     public function getCappedMax()
@@ -71,6 +73,8 @@ public function getCappedMax()
     /**
      * Return the maximum size (in bytes) of the capped collection.
      *
+     * @deprecated 1.0 Deprecated in favor of using getOptions
+     *
      * @return integer|null
      */
     public function getCappedSize()
@@ -79,9 +83,31 @@ public function getCappedSize()
         return isset($this->info['options']['size']) ? (integer) $this->info['options']['size'] : null;
     }
 
+    /**
+     * Return information about the _id index for the collection.
+     *
+     * @return array
+     */
+    public function getIdIndex(): array
+    {
+        return (array) ($this->info['idIndex'] ?? []);
+    }
+
+    /**
+     * Return the "info" property of the server response.
+     *
+     * @see https://docs.mongodb.com/manual/reference/command/listCollections/#output
+     * @return array
+     */
+    public function getInfo(): array
+    {
+        return (array) ($this->info['info'] ?? []);
+    }
+
     /**
      * Return the collection name.
      *
+     * @see https://docs.mongodb.com/manual/reference/command/listCollections/#output
      * @return string
      */
     public function getName()
@@ -92,16 +118,30 @@ public function getName()
     /**
      * Return the collection options.
      *
+     * @see https://docs.mongodb.com/manual/reference/command/listCollections/#output
      * @return array
      */
     public function getOptions()
     {
-        return isset($this->info['options']) ? (array) $this->info['options'] : [];
+        return (array) ($this->info['options'] ?? []);
+    }
+
+    /**
+     * Return the collection type.
+     *
+     * @see https://docs.mongodb.com/manual/reference/command/listCollections/#output
+     * @return string
+     */
+    public function getType(): string
+    {
+        return (string) $this->info['type'];
     }
 
     /**
      * Return whether the collection is a capped collection.
      *
+     * @deprecated 1.0 Deprecated in favor of using getOptions
+     *
      * @return boolean
      */
     public function isCapped()

tests/Model/CollectionInfoTest.php

@@ -8,19 +8,47 @@
 
 class CollectionInfoTest extends TestCase
 {
-    public function testGetName(): void
+    public function testGetBasicInformation(): void
     {
-        $info = new CollectionInfo(['name' => 'foo']);
+        $info = new CollectionInfo([
+            'name' => 'foo',
+            'type' => 'view',
+            'options' => ['capped' => true, 'size' => 1048576],
+            'info' => ['readOnly' => true],
+            'idIndex' => ['idIndex' => true], // Dummy option
+        ]);
+
         $this->assertSame('foo', $info->getName());
+        $this->assertSame('foo', $info['name']);
+
+        $this->assertSame('view', $info->getType());
+        $this->assertSame('view', $info['type']);
+
+        $this->assertSame(['capped' => true, 'size' => 1048576], $info->getOptions());
+        $this->assertSame(['capped' => true, 'size' => 1048576], $info['options']);
+
+        $this->assertSame(['readOnly' => true], $info->getInfo());
+        $this->assertSame(['readOnly' => true], $info['info']);
+
+        $this->assertSame(['idIndex' => true], $info->getIdIndex());
+        $this->assertSame(['idIndex' => true], $info['idIndex']);
     }
 
-    public function testGetOptions(): void
+    public function testMissingFields(): void
     {
-        $info = new CollectionInfo(['name' => 'foo']);
+        $info = new CollectionInfo([
+            'name' => 'foo',
+            'type' => 'view',
+        ]);
+
         $this->assertSame([], $info->getOptions());
+        $this->assertArrayNotHasKey('options', $info);
 
-        $info = new CollectionInfo(['name' => 'foo', 'options' => ['capped' => true, 'size' => 1048576]]);
-        $this->assertSame(['capped' => true, 'size' => 1048576], $info->getOptions());
+        $this->assertSame([], $info->getInfo());
+        $this->assertArrayNotHasKey('info', $info);
+
+        $this->assertSame([], $info->getIdIndex());
+        $this->assertArrayNotHasKey('idIndex', $info);
     }
 
     public function testCappedCollectionMethods(): void