reorganizing files

Author: norareidy

docs/reference/class/MongoDBBulkWriteResult.txt

@@ -4,6 +4,19 @@
 MongoDB\\BulkWriteResult Class
 ==============================
 
+Definition
+----------
+
+.. phpclass:: MongoDB\\BulkWriteResult
+
+   This class contains information about an executed bulk write operation. It
+   encapsulates a :php:`MongoDB\\Driver\\WriteResult
+   <class.mongodb-driver-writeresult>` object and is returned from
+   :phpmethod:`MongoDB\\Collection::bulkWrite()`.
+
+Methods
+-------
+
 .. toctree::
    :titlesonly:
 

docs/reference/class/MongoDBChangeStream.txt

@@ -4,6 +4,26 @@
 MongoDB\\ChangeStream Class
 ===========================
 
+.. versionadded:: 1.3
+
+Definition
+----------
+
+.. phpclass:: MongoDB\\ChangeStream
+
+   This class extends PHP's :php:`Iterator <manual/en/class.iterator.php>`
+   interface. An instance of this class is returned by
+   :phpmethod:`MongoDB\\Client::watch()`,
+   :phpmethod:`MongoDB\\Database::watch()`, and
+   :phpmethod:`MongoDB\\Collection::watch()`.
+
+   This class allows for iteration of events in a change stream. It also allows
+   iteration to automatically resume after certain errors, such as a replica set
+   failover.
+
+Methods
+-------
+
 .. toctree::
    :titlesonly:
 

docs/reference/class/MongoDBDeleteResult.txt

@@ -4,6 +4,20 @@
 MongoDB\\DeleteResult Class
 ===========================
 
+Definition
+----------
+
+.. phpclass:: MongoDB\\DeleteResult
+
+   This class contains information about an executed delete operation. It
+   encapsulates a :php:`MongoDB\\Driver\\WriteResult
+   <class.mongodb-driver-writeresult>` object and is returned from
+   :phpmethod:`MongoDB\\Collection::deleteMany()` or
+   :phpmethod:`MongoDB\\Collection::deleteOne()`.
+
+Methods
+-------
+
 .. toctree::
    :titlesonly:
 

docs/reference/class/MongoDBInsertManyResult.txt

@@ -4,6 +4,19 @@
 MongoDB\\InsertManyResult Class
 ===============================
 
+Definition
+----------
+
+.. phpclass:: MongoDB\\InsertManyResult
+
+   This class contains information about an executed bulk insert operation. It
+   encapsulates a :php:`MongoDB\\Driver\\WriteResult
+   <class.mongodb-driver-writeresult>` object and is returned from
+   :phpmethod:`MongoDB\\Collection::insertMany()`.
+
+Methods
+-------
+
 .. toctree::
    :titlesonly:
 

docs/reference/class/MongoDBInsertOneResult.txt

@@ -4,6 +4,19 @@
 MongoDB\\InsertOneResult Class
 ==============================
 
+Definition
+----------
+
+.. phpclass:: MongoDB\\InsertOneResult
+
+   This class contains information about an executed insert operation. It
+   encapsulates a :php:`MongoDB\\Driver\\WriteResult
+   <class.mongodb-driver-writeresult>` object and is returned from
+   :phpmethod:`MongoDB\\Collection::insertOne()`.
+
+Methods
+-------
+
 .. toctree::
    :titlesonly:
 

docs/reference/class/MongoDBMapReduceResult.txt

@@ -4,6 +4,24 @@
 MongoDB\\MapReduceResult Class
 ==============================
 
+.. versionadded:: 1.2
+
+Definition
+----------
+
+.. phpclass:: MongoDB\\MapReduceResult
+
+   This class extends PHP's :php:`IteratorAggregate <iteratoraggregate>`
+   interface. An instance of this class is returned by
+   :phpmethod:`MongoDB\\Collection::mapReduce()`.
+
+   This class allows for iteration of map-reduce results irrespective of the
+   output method (e.g. inline, collection). It also provides access to command
+   statistics.
+
+Methods
+-------
+
 .. toctree::
    :titlesonly:
 

docs/reference/class/MongoDBModelCollectionInfo.txt

@@ -4,6 +4,31 @@
 MongoDB\\Model\\CollectionInfo Class
 ====================================
 
+Definition
+----------
+
+.. phpclass:: MongoDB\\Model\\CollectionInfo
+
+   This class models information about a collection. Instances of this class are
+   returned by traversing a :phpclass:`MongoDB\\Model\\CollectionInfoIterator`,
+   which is returned by :phpmethod:`MongoDB\\Database::listCollections()`.
+
+.. versionchanged:: 1.4
+
+   This class implements PHP's :php:`ArrayAccess <arrayaccess>` interface. This
+   provides a mechanism for accessing index fields for which there exists no
+   helper method. :php:`isset() <isset>` may be used to check for the existence
+   of a field before accessing it with ``[]``.
+
+   .. note::
+
+      The :phpclass:`MongoDB\\Model\\CollectionInfo` class is immutable. Attempting
+      to modify it via the :php:`ArrayAccess <arrayaccess>` interface will
+      result in a :phpclass:`MongoDB\\Exception\\BadMethodCallException`.
+
+Methods
+-------
+
 .. toctree::
    :titlesonly:
 

docs/reference/class/MongoDBModelCollectionInfoIterator.txt

@@ -0,0 +1,22 @@
+.. _php-model-collection-info-iterator:
+
+============================================
+MongoDB\\Model\\CollectionInfoIterator Class
+============================================
+
+Definition
+----------
+
+.. phpclass:: MongoDB\\Model\\CollectionInfoIterator
+
+   This interface extends PHP's :php:`Iterator <manual/en/class.iterator.php>`
+   interface. An instance of this interface is returned by
+   :phpmethod:`MongoDB\\Database::listCollections()`.
+
+Methods
+-------
+
+This interface adds no new methods to :php:`Iterator
+<manual/en/class.iterator.php>`, but specifies that :php:`current()
+<manual/en/iterator.current.php>` will return an instance of
+:phpclass:`MongoDB\\Model\\CollectionInfo`.

docs/reference/class/MongoDBModelDatabaseInfo.txt

@@ -4,6 +4,31 @@
 MongoDB\\Model\\DatabaseInfo Class
 ==================================
 
+Definition
+----------
+
+.. phpclass:: MongoDB\\Model\\DatabaseInfo
+
+   This class models information about a database. Instances of this class are
+   returned by traversing a :phpclass:`MongoDB\\Model\\DatabaseInfoIterator`,
+   which is returned by :phpmethod:`MongoDB\\Client::listDatabases()`.
+
+.. versionchanged:: 1.4
+
+   This class implements PHP's :php:`ArrayAccess <arrayaccess>` interface. This
+   provides a mechanism for accessing index fields for which there exists no
+   helper method. :php:`isset() <isset>` may be used to check for the existence
+   of a field before accessing it with ``[]``.
+
+   .. note::
+
+      The :phpclass:`MongoDB\\Model\\DatabaseInfo` class is immutable. Attempting
+      to modify it via the :php:`ArrayAccess <arrayaccess>` interface will
+      result in a :phpclass:`MongoDB\\Exception\\BadMethodCallException`.
+
+Methods
+-------
+
 .. toctree::
    :titlesonly:
 

docs/reference/class/MongoDBModelDatabaseInfoIterator.txt

@@ -0,0 +1,22 @@
+.. _php-model-database-info-iterator:
+
+==========================================
+MongoDB\\Model\\DatabaseInfoIterator Class
+==========================================
+
+Definition
+----------
+
+.. phpclass:: MongoDB\\Model\\DatabaseInfoIterator
+
+   This interface extends PHP's :php:`Iterator <manual/en/class.iterator.php>`
+   interface. An instance of this interface is returned by
+   :phpmethod:`MongoDB\\Client::listDatabases()`.
+
+Methods
+-------
+
+This interface adds no new methods to :php:`Iterator
+<manual/en/class.iterator.php>`, but specifies that :php:`current()
+<manual/en/iterator.current.php>` will return an instance of
+:phpclass:`MongoDB\\Model\\DatabaseInfo`.

docs/reference/class/MongoDBModelIndexInfo.txt

@@ -4,6 +4,29 @@
 MongoDB\\Model\\IndexInfo Class
 ===============================
 
+Definition
+----------
+
+.. phpclass:: MongoDB\\Model\\IndexInfo
+
+   This class models information about an index. Instances of this class are
+   returned by traversing a :phpclass:`MongoDB\\Model\\IndexInfoIterator`,
+   which is returned by :phpmethod:`MongoDB\\Collection::listIndexes()`.
+
+   This class implements PHP's :php:`ArrayAccess <arrayaccess>` interface. This
+   provides a mechanism for accessing index fields for which there exists no
+   helper method. :php:`isset() <isset>` may be used to check for the existence
+   of a field before accessing it with ``[]``.
+
+   .. note::
+
+      The :phpclass:`MongoDB\\Model\\IndexInfo` class is immutable. Attempting
+      to modify it via the :php:`ArrayAccess <arrayaccess>` interface will
+      result in a :phpclass:`MongoDB\\Exception\\BadMethodCallException`.
+
+Methods
+-------
+
 .. toctree::
    :titlesonly:
 

docs/reference/class/MongoDBModelIndexInfoIterator.txt

@@ -0,0 +1,22 @@
+.. _php-model-index-info-iterator:
+
+=======================================
+MongoDB\\Model\\IndexInfoIterator Class
+=======================================
+
+Definition
+----------
+
+.. phpclass:: MongoDB\\Model\\IndexInfoIterator
+
+   This interface extends PHP's :php:`Iterator <manual/en/class.iterator.php>`
+   interface. An instance of this interface is returned by
+   :phpmethod:`MongoDB\\Collection::listIndexes()`.
+
+Methods
+-------
+
+This interface adds no new methods to :php:`Iterator
+<manual/en/class.iterator.php>`, but specifies that :php:`current()
+<manual/en/iterator.current.php>` will return an instance of
+:phpclass:`MongoDB\\Model\\IndexInfo`.

docs/reference/class/MongoDBUpdateResult.txt

@@ -4,6 +4,21 @@
 MongoDB\\UpdateResult Class
 ===========================
 
+Definition
+----------
+
+.. phpclass:: MongoDB\\UpdateResult
+
+   This class contains information about an executed update or replace
+   operation. It encapsulates a :php:`MongoDB\\Driver\\WriteResult
+   <class.mongodb-driver-writeresult>` object and is returned from
+   :phpmethod:`MongoDB\\Collection::replaceOne()`,
+   :phpmethod:`MongoDB\\Collection::updateMany()`, or
+   :phpmethod:`MongoDB\\Collection::updateOne()`.
+
+Methods
+-------
+
 .. toctree::
    :titlesonly: