PHPLIB-675 Document new CollectionInfo methods (#841)

* Document deprecation of capped collection helpers

* Add detail about where collection information comes from

* Document new CollectionInfo helpers

* Address review feedback

* Fix wrong backticks

Author: alcaeus

docs/reference/enumeration-classes.txt

@@ -43,8 +43,11 @@ Methods
 
    /reference/method/MongoDBModelCollectionInfo-getCappedMax
    /reference/method/MongoDBModelCollectionInfo-getCappedSize
+   /reference/method/MongoDBModelCollectionInfo-getIdIndex
+   /reference/method/MongoDBModelCollectionInfo-getInfo
    /reference/method/MongoDBModelCollectionInfo-getName
    /reference/method/MongoDBModelCollectionInfo-getOptions
+   /reference/method/MongoDBModelCollectionInfo-getType
    /reference/method/MongoDBModelCollectionInfo-isCapped
 
 ----

docs/reference/method/MongoDBModelCollectionInfo-getCappedMax.txt

@@ -2,6 +2,8 @@
 MongoDB\\Model\\CollectionInfo::getCappedMax()
 ==============================================
 
+.. deprecated:: 1.9
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
@@ -28,6 +30,10 @@ Return Values
 The document limit for the capped collection. If the collection is not capped,
 ``null`` will be returned.
 
+This method is deprecated in favor of using
+:phpmethod:`MongoDB\\Model\\CollectionInfo::getOptions()` and accessing the
+``max`` key.
+
 Examples
 --------
 

docs/reference/method/MongoDBModelCollectionInfo-getCappedSize.txt

@@ -2,6 +2,8 @@
 MongoDB\\Model\\CollectionInfo::getCappedSize()
 ===============================================
 
+.. deprecated:: 1.9
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
@@ -29,6 +31,10 @@ Return Values
 The size limit for the capped collection in bytes. If the collection is not
 capped, ``null`` will be returned.
 
+This method is deprecated in favor of using
+:phpmethod:`MongoDB\\Model\\CollectionInfo::getOptions()` and accessing the
+``size`` key.
+
 Examples
 --------
 

docs/reference/method/MongoDBModelCollectionInfo-getIdIndex.txt

@@ -0,0 +1,73 @@
+============================================
+MongoDB\\Model\\CollectionInfo::getIdIndex()
+============================================
+
+.. versionadded:: 1.9
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Definition
+----------
+
+.. phpmethod:: MongoDB\\Model\\CollectionInfo::getIdIndex()
+
+   Returns information about the ``_id`` field index.
+
+   .. code-block:: php
+
+      function getIdIndex(): array
+
+Return Values
+-------------
+
+An array containing information on the ``_id`` index. This corresponds to the
+``idIndex`` field returned in the ``listCollections`` command reply.
+
+Examples
+--------
+
+.. code-block:: php
+
+   <?php
+
+   $info = new CollectionInfo([
+     'type' => 'view',
+     'name' => 'foo',
+     'idIndex' => [
+        'v' => 2,
+        'key' => ['_id' => 1],
+        'name' => '_id',
+        'ns' => 'test.foo',
+     ],
+   ]);
+
+   var_dump($info->getIdIndex());
+
+The output would then resemble::
+
+   array(4) {
+     ["v"]=>
+     int(2)
+     ["key"]=>
+     array(1) {
+       ["_id"]=>
+       int(1)
+     }
+     ["name"]=>
+     string(3) "_id"
+     ["ns"]=>
+     string(8) "test.foo"
+   }
+
+See Also
+--------
+
+- :phpmethod:`MongoDB\\Database::createCollection()`
+- :manual:`listCollections </reference/command/listCollections>` command
+  reference in the MongoDB manual

docs/reference/method/MongoDBModelCollectionInfo-getInfo.txt

@@ -0,0 +1,59 @@
+=========================================
+MongoDB\\Model\\CollectionInfo::getInfo()
+=========================================
+
+.. versionadded:: 1.9
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Definition
+----------
+
+.. phpmethod:: MongoDB\\Model\\CollectionInfo::getInfo()
+
+   Returns additional information about the collection.
+
+   .. code-block:: php
+
+      function getInfo(): array
+
+Return Values
+-------------
+
+An array containing extra information about the collection. This corresponds to
+the ``info`` field returned in the ``listCollections`` command reply.
+
+Examples
+--------
+
+.. code-block:: php
+
+   <?php
+
+   $info = new CollectionInfo([
+     'type' => 'view',
+     'name' => 'foo',
+     'info' => ['readOnly' => true]
+   ]);
+
+   var_dump($info->getInfo());
+
+The output would then resemble::
+
+   array(1) {
+     ["readOnly"]=>
+     bool(true)
+   }
+
+See Also
+--------
+
+- :phpmethod:`MongoDB\\Database::createCollection()`
+- :manual:`listCollections </reference/command/listCollections>` command
+  reference in the MongoDB manual

docs/reference/method/MongoDBModelCollectionInfo-getName.txt

@@ -24,7 +24,8 @@ Definition
 Return Values
 -------------
 
-The collection name.
+The collection name. This corresponds to the ``name`` field returned in the
+``listCollections`` command reply.
 
 Examples
 --------

docs/reference/method/MongoDBModelCollectionInfo-getOptions.txt

@@ -26,7 +26,8 @@ Definition
 Return Values
 -------------
 
-The collection options.
+The collection options. This corresponds to the ``options`` field returned in
+the ``listCollections`` command reply.
 
 Examples
 --------

docs/reference/method/MongoDBModelCollectionInfo-getType.txt

@@ -0,0 +1,52 @@
+=========================================
+MongoDB\\Model\\CollectionInfo::getType()
+=========================================
+
+.. versionadded:: 1.9
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 1
+   :class: singlecol
+
+Definition
+----------
+
+.. phpmethod:: MongoDB\\Model\\CollectionInfo::getType()
+
+   Return the collection type.
+
+   .. code-block:: php
+
+      function getType(): string
+
+Return Values
+-------------
+
+The collection type. This corresponds to the ``type`` field returned in the
+``listCollections`` command reply.
+
+Examples
+--------
+
+.. code-block:: php
+
+   <?php
+
+   $info = new CollectionInfo(['type' => 'collection', 'name' => 'foo']);
+
+   echo $info->getType();
+
+The output would then resemble::
+
+   collection
+
+See Also
+--------
+
+- :phpmethod:`MongoDB\\Database::createCollection()`
+- :manual:`listCollections </reference/command/listCollections>` command
+  reference in the MongoDB manual

docs/reference/method/MongoDBModelCollectionInfo-isCapped.txt

@@ -2,6 +2,8 @@
 MongoDB\\Model\\CollectionInfo::isCapped()
 ==========================================
 
+.. deprecated:: 1.9
+
 .. default-domain:: mongodb
 
 .. contents:: On this page
@@ -27,6 +29,10 @@ Return Values
 
 A boolean indicating whether the collection is a capped collection.
 
+This method is deprecated in favor of using
+:phpmethod:`MongoDB\\Model\\CollectionInfo::getOptions()` and accessing the
+``capped`` key.
+
 Examples
 --------