PHPLIB-75: Refactor model classes and add class-level docs

Author: jmikola

src/Model/CollectionInfo.php

@@ -2,10 +2,20 @@
 
 namespace MongoDB\Model;
 
+/**
+ * Collection information model class.
+ *
+ * This class models the collection information returned by the listCollections
+ * command or, for legacy servers, queries on the "system.namespaces"
+ * collection. It provides methods to access options for the collection.
+ *
+ * @api
+ * @see MongoDB\Database::listCollections()
+ * @see https://github.com/mongodb/specifications/blob/master/source/enumerate-collections.rst
+ */
 class CollectionInfo
 {
-    private $name;
-    private $options;
+    private $info;
 
     /**
     * Constructor.
@@ -14,8 +24,7 @@ class CollectionInfo
     */
     public function __construct(array $info)
     {
-        $this->name = (string) $info['name'];
-        $this->options = isset($info['options']) ? (array) $info['options'] : array();
+        $this->info = $info;
     }
 
     /**
@@ -25,7 +34,7 @@ public function __construct(array $info)
      */
     public function getName()
     {
-        return $this->name;
+        return (string) $this->info['name'];
     }
 
     /**
@@ -35,7 +44,7 @@ public function getName()
      */
     public function getOptions()
     {
-        return $this->options;
+        return isset($this->info['options']) ? (array) $this->info['options'] : array();
     }
 
     /**
@@ -45,7 +54,7 @@ public function getOptions()
      */
     public function isCapped()
     {
-        return isset($this->options['capped']) ? (boolean) $this->options['capped'] : false;
+        return ! empty($this->info['options']['capped']);
     }
 
     /**
@@ -55,7 +64,7 @@ public function isCapped()
      */
     public function getCappedMax()
     {
-        return isset($this->options['max']) ? (integer) $this->options['max'] : null;
+        return isset($this->info['options']['max']) ? (integer) $this->info['options']['max'] : null;
     }
 
     /**
@@ -65,6 +74,6 @@ public function getCappedMax()
      */
     public function getCappedSize()
     {
-        return isset($this->options['size']) ? (integer) $this->options['size'] : null;
+        return isset($this->info['options']['size']) ? (integer) $this->info['options']['size'] : null;
     }
 }

src/Model/DatabaseInfo.php

@@ -2,11 +2,19 @@
 
 namespace MongoDB\Model;
 
+/**
+ * Database information model class.
+ *
+ * This class models the database information returned by the listDatabases
+ * command. It provides methods to access common database properties.
+ *
+ * @api
+ * @see MongoDB\Client::listDatabases()
+ * @see http://docs.mongodb.org/manual/reference/command/listDatabases/
+ */
 class DatabaseInfo
 {
-    private $empty;
-    private $name;
-    private $sizeOnDisk;
+    private $info;
 
     /**
     * Constructor.
@@ -15,9 +23,7 @@ class DatabaseInfo
     */
     public function __construct(array $info)
     {
-        $this->name = (string) $info['name'];
-        $this->empty = (boolean) $info['empty'];
-        $this->sizeOnDisk = (integer) $info['sizeOnDisk'];
+        $this->info = $info;
     }
 
     /**
@@ -27,7 +33,7 @@ public function __construct(array $info)
      */
     public function getName()
     {
-        return $this->name;
+        return (string) $this->info['name'];
     }
 
     /**
@@ -37,7 +43,7 @@ public function getName()
      */
     public function getSizeOnDisk()
     {
-        return $this->sizeOnDisk;
+        return (integer) $this->info['sizeOnDisk'];
     }
 
     /**
@@ -47,6 +53,6 @@ public function getSizeOnDisk()
      */
     public function isEmpty()
     {
-        return $this->empty;
+        return (boolean) $this->info['empty'];
     }
 }