Merge pull request #172 from rustagir/DOCSP-43953-v2-iterator-changes

rustagir · web-flow · commit 4205c7caaf3f · 2024-10-22T15:44:08.000-04:00
DOCSP-43953: v2 iterator changes
diff --git a/source/reference/class/MongoDBModelCollectionInfo.txt b/source/reference/class/MongoDBModelCollectionInfo.txt
@@ -8,8 +8,8 @@ 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()`.
+   stored in an :php:`Iterator <manual/en/class.iterator.php>`
+   returned by :phpmethod:`MongoDB\Database::listCollections()`.
 
 .. versionchanged:: 1.4
 
diff --git a/source/reference/class/MongoDBModelCollectionInfoIterator.txt b/source/reference/class/MongoDBModelCollectionInfoIterator.txt
diff --git a/source/reference/class/MongoDBModelDatabaseInfo.txt b/source/reference/class/MongoDBModelDatabaseInfo.txt
@@ -8,8 +8,8 @@ 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()`.
+   stored in an :php:`Iterator <manual/en/class.iterator.php>`
+   returned by :phpmethod:`MongoDB\Client::listDatabases()`.
 
 .. versionchanged:: 1.4
 
diff --git a/source/reference/class/MongoDBModelDatabaseInfoIterator.txt b/source/reference/class/MongoDBModelDatabaseInfoIterator.txt
diff --git a/source/reference/class/MongoDBModelIndexInfo.txt b/source/reference/class/MongoDBModelIndexInfo.txt
@@ -8,8 +8,8 @@ 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()`.
+   stored in an :php:`Iterator <manual/en/class.iterator.php>`
+   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
diff --git a/source/reference/class/MongoDBModelIndexInfoIterator.txt b/source/reference/class/MongoDBModelIndexInfoIterator.txt
diff --git a/source/reference/method/MongoDBClient-listDatabaseNames.txt b/source/reference/method/MongoDBClient-listDatabaseNames.txt
@@ -77,8 +77,8 @@ Parameters
 Return Values
 -------------
 
-An :php:`Iterator <class.iterator.php>`, which provides the name of each
-database on the server.
+An :php:`Iterator <manual/en/class.iterator.php>`, which provides the
+name of each database on the server.
 
 Errors/Exceptions
 -----------------
diff --git a/source/reference/method/MongoDBClient-listDatabases.txt b/source/reference/method/MongoDBClient-listDatabases.txt
@@ -2,8 +2,6 @@
 MongoDB\\Client::listDatabases()
 ================================
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -19,7 +17,7 @@ Definition
 
    .. code-block:: php
 
-      function listDatabases(array $options = []): MongoDB\Model\DatabaseInfoIterator
+      function listDatabases(array $options = []): Iterator
 
 Parameters
 ----------
@@ -77,9 +75,9 @@ Parameters
 Return Values
 -------------
 
-A traversable :phpclass:`MongoDB\Model\DatabaseInfoIterator`, which contains
-a :phpclass:`MongoDB\Model\DatabaseInfo` object for each database on the
-server.
+An :php:`Iterator <manual/en/class.iterator.php>`
+instance, which contains a :phpclass:`MongoDB\Model\DatabaseInfo` object
+for each database on the server.
 
 Errors/Exceptions
 -----------------
diff --git a/source/reference/method/MongoDBCollection-listIndexes.txt b/source/reference/method/MongoDBCollection-listIndexes.txt
@@ -2,8 +2,6 @@
 MongoDB\\Collection::listIndexes()
 ==================================
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -19,7 +17,7 @@ Definition
 
    .. code-block:: php
 
-      function listIndexes(array $options = []): MongoDB\Model\IndexInfoIterator
+      function listIndexes(array $options = []): Iterator
 
 Parameters
 ----------
@@ -56,8 +54,9 @@ Parameters
 Return Values
 -------------
 
-A traversable :phpclass:`MongoDB\Model\IndexInfoIterator`, which contains a
-:phpclass:`MongoDB\Model\IndexInfo` object for each index for the collection.
+An :php:`Iterator <manual/en/class.iterator.php>`
+instance, which contains a :phpclass:`MongoDB\Model\IndexInfo` object
+for each index for the collection.
 
 Errors/Exceptions
 -----------------
diff --git a/source/reference/method/MongoDBDatabase-listCollectionNames.txt b/source/reference/method/MongoDBDatabase-listCollectionNames.txt
@@ -74,8 +74,8 @@ Parameters
 Return Values
 -------------
 
-An :php:`Iterator <class.iterator.php>`, which provides the name of each
-collection in the database.
+An :php:`Iterator <manual/en/class.iterator.php>`, which provides the
+name of each collection in the database.
 
 Example
 -------
diff --git a/source/reference/method/MongoDBDatabase-listCollections.txt b/source/reference/method/MongoDBDatabase-listCollections.txt
@@ -2,8 +2,6 @@
 MongoDB\\Database::listCollections()
 ====================================
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none
@@ -19,7 +17,7 @@ Definition
 
    .. code-block:: php
 
-      function listCollections(array $options = []): MongoDB\Model\CollectionInfoIterator
+      function listCollections(array $options = []): Iterator
 
 Parameters
 ----------
@@ -74,9 +72,9 @@ Parameters
 Return Values
 -------------
 
-A traversable :phpclass:`MongoDB\Model\CollectionInfoIterator`, which contains
-a :phpclass:`MongoDB\Model\CollectionInfo` object for each collection in the
-database.
+An :php:`Iterator <manual/en/class.iterator.php>`
+instance, which contains a :phpclass:`MongoDB\Model\CollectionInfo`
+object for each collection in the database.
 
 Example
 -------
diff --git a/source/reference/result-classes.txt b/source/reference/result-classes.txt
@@ -12,8 +12,5 @@ Result Classes
    UpdateResult Class </reference/class/MongoDBUpdateResult>
    ChangeStream Class </reference/class/MongoDBChangeStream>
    CollectionInfo Class </reference/class/MongoDBModelCollectionInfo>
-   CollectionInfoIterator Class </reference/class/MongoDBModelCollectionInfoIterator>
    DatabaseInfo Class </reference/class/MongoDBModelDatabaseInfo>
-   DatabaseInfoIterator Class </reference/class/MongoDBModelDatabaseInfoIterator>
    IndexInfo Class </reference/class/MongoDBModelIndexInfo>
-   IndexInfoIterator Class </reference/class/MongoDBModelIndexInfoIterator>
diff --git a/source/whats-new.txt b/source/whats-new.txt
@@ -42,11 +42,11 @@ What's New in 2.0
 
    - The following methods return ``void`` instead of the raw command
      response:
-
-     - ``MongoDB\\Client``: ``dropDatabase()``
-     - ``MongoDB\\Collection``: ``drop()``, ``dropIndex()``,
+   
+     - ``MongoDB\Client``: ``dropDatabase()``
+     - ``MongoDB\Collection``: ``drop()``, ``dropIndex()``,
        ``dropIndexes()``, ``dropSearchIndex()``, ``rename()``
-     - ``MongoDB\\Database``: ``createCollection()``, ``drop()``,
+     - ``MongoDB\Database``: ``createCollection()``, ``drop()``,
        ``dropCollection()``, ``renameCollection()``
    
    To learn more about breaking changes in this release, see the
@@ -82,20 +82,32 @@ improvements, and fixes:
 - Removes the deprecated ``IndexInfo::isGeoHaystack()`` method.
 
 - Removes the deprecated ``autoIndexId`` and ``flags`` options for the
-  ``MongoDB\\Database::createCollection()`` method.
+  ``MongoDB\Database::createCollection()`` method.
 
 - Drops support for map-reduce functionality by removing the following
   deprecated methods and types:
 
-  - ``MongoDB\\Collection::mapReduce()``
-  - ``MongoDB\\MapReduceResult``
+  - ``MongoDB\Collection::mapReduce()``
+  - ``MongoDB\MapReduceResult``
 
   You can rewrite map-reduce operations by using aggregation pipeline
   stages such as ``$group`` and ``$merge``. To learn more, see
   :manual:`Map-Reduce to Aggregation Pipeline
   </reference/map-reduce-to-aggregation-pipeline/>` in the
   {+mdb-server+} manual.
 
+- Removes the following ``Iterator`` implementations:
+
+  - ``MongoDB\Model\CollectionInfoIterator``
+  - ``MongoDB\Model\DatabaseInfoIterator``
+  - ``MongoDB\Model\IndexInfoIterator``
+
+  The :phpmethod:`MongoDB\Client::listDatabases()`,
+  :phpmethod:`MongoDB\Database::listCollections()`, and
+  :phpmethod:`MongoDB\Collection::listIndexes()` methods return a
+  general traversable ``Iterator`` instance that contains the corresponding
+  results.
+
 .. _php-lib-version-1.20:
 
 What's New in 1.20
