DOCSP-36027: Shorten class headings backport (#1229)

docs/reference/class/MongoDBBulkWriteResult.txt

@@ -0,0 +1,37 @@
+==============================
+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:
+
+   getDeletedCount() </reference/method/MongoDBBulkWriteResult-getDeletedCount>
+   getInsertedCount() </reference/method/MongoDBBulkWriteResult-getInsertedCount>
+   getInsertedIds() </reference/method/MongoDBBulkWriteResult-getInsertedIds>
+   getMatchedCount() </reference/method/MongoDBBulkWriteResult-getMatchedCount>
+   getModifiedCount() </reference/method/MongoDBBulkWriteResult-getModifiedCount>
+   getUpsertedCount() </reference/method/MongoDBBulkWriteResult-getUpsertedCount>
+   getUpsertedIds() </reference/method/MongoDBBulkWriteResult-getUpsertedIds>
+   isAcknowledged() </reference/method/MongoDBBulkWriteResult-isAcknowledged>
+
+- :phpmethod:`MongoDB\\BulkWriteResult::getDeletedCount()`
+- :phpmethod:`MongoDB\\BulkWriteResult::getInsertedCount()`
+- :phpmethod:`MongoDB\\BulkWriteResult::getInsertedIds()`
+- :phpmethod:`MongoDB\\BulkWriteResult::getMatchedCount()`
+- :phpmethod:`MongoDB\\BulkWriteResult::getModifiedCount()`
+- :phpmethod:`MongoDB\\BulkWriteResult::getUpsertedCount()`
+- :phpmethod:`MongoDB\\BulkWriteResult::getUpsertedIds()`
+- :phpmethod:`MongoDB\\BulkWriteResult::isAcknowledged()`

docs/reference/class/MongoDBChangeStream.txt

@@ -0,0 +1,42 @@
+===========================
+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:
+
+   current() </reference/method/MongoDBChangeStream-current>
+   getCursorId() </reference/method/MongoDBChangeStream-getCursorId>
+   getResumeToken() </reference/method/MongoDBChangeStream-getResumeToken>
+   key() </reference/method/MongoDBChangeStream-key>
+   next() </reference/method/MongoDBChangeStream-next>
+   rewind() </reference/method/MongoDBChangeStream-rewind>
+   valid() </reference/method/MongoDBChangeStream-valid>
+
+- :phpmethod:`MongoDB\\ChangeStream::current()`
+- :phpmethod:`MongoDB\\ChangeStream::getCursorId()`
+- :phpmethod:`MongoDB\\ChangeStream::getResumeToken()`
+- :phpmethod:`MongoDB\\ChangeStream::key()`
+- :phpmethod:`MongoDB\\ChangeStream::next()`
+- :phpmethod:`MongoDB\\ChangeStream::rewind()`
+- :phpmethod:`MongoDB\\ChangeStream::valid()`

docs/reference/class/MongoDBClient.txt

@@ -28,18 +28,34 @@ Methods
 .. toctree::
    :titlesonly:
 
-   /reference/method/MongoDBClient__construct
-   /reference/method/MongoDBClient__get
-   /reference/method/MongoDBClient-createClientEncryption
-   /reference/method/MongoDBClient-dropDatabase
-   /reference/method/MongoDBClient-getManager
-   /reference/method/MongoDBClient-getReadConcern
-   /reference/method/MongoDBClient-getReadPreference
-   /reference/method/MongoDBClient-getTypeMap
-   /reference/method/MongoDBClient-getWriteConcern
-   /reference/method/MongoDBClient-listDatabaseNames
-   /reference/method/MongoDBClient-listDatabases
-   /reference/method/MongoDBClient-selectCollection
-   /reference/method/MongoDBClient-selectDatabase
-   /reference/method/MongoDBClient-startSession
-   /reference/method/MongoDBClient-watch
+   __construct() </reference/method/MongoDBClient__construct>
+   __get() </reference/method/MongoDBClient__get>
+   createClientEncryption() </reference/method/MongoDBClient-createClientEncryption>
+   dropDatabase() </reference/method/MongoDBClient-dropDatabase>
+   getManager() </reference/method/MongoDBClient-getManager>
+   getReadConcern() </reference/method/MongoDBClient-getReadConcern>
+   getReadPreference() </reference/method/MongoDBClient-getReadPreference>
+   getTypeMap() </reference/method/MongoDBClient-getTypeMap>
+   getWriteConcern() </reference/method/MongoDBClient-getWriteConcern>
+   listDatabaseNames() </reference/method/MongoDBClient-listDatabaseNames>
+   listDatabases() </reference/method/MongoDBClient-listDatabases>
+   selectCollection() </reference/method/MongoDBClient-selectCollection>
+   selectDatabase() </reference/method/MongoDBClient-selectDatabase>
+   startSession() </reference/method/MongoDBClient-startSession>
+   watch() </reference/method/MongoDBClient-watch>
+
+- :phpmethod:`MongoDB\\Client::__construct()`
+- :phpmethod:`MongoDB\\Client::__get()`
+- :phpmethod:`MongoDB\\Client::createClientEncryption()`
+- :phpmethod:`MongoDB\\Client::dropDatabase()`
+- :phpmethod:`MongoDB\\Client::getManager()`
+- :phpmethod:`MongoDB\\Client::getReadConcern()`
+- :phpmethod:`MongoDB\\Client::getReadPreference()`
+- :phpmethod:`MongoDB\\Client::getTypeMap()`
+- :phpmethod:`MongoDB\\Client::getWriteConcern()`
+- :phpmethod:`MongoDB\\Client::listDatabaseNames()`
+- :phpmethod:`MongoDB\\Client::listDatabases()`
+- :phpmethod:`MongoDB\\Client::selectCollection()`
+- :phpmethod:`MongoDB\\Client::selectDatabase()`
+- :phpmethod:`MongoDB\\Client::startSession()`
+- :phpmethod:`MongoDB\\Client::watch()`

docs/reference/class/MongoDBCollection.txt

@@ -58,41 +58,80 @@ Methods
 .. toctree::
    :titlesonly:
 
-   /reference/method/MongoDBCollection__construct
-   /reference/method/MongoDBCollection-aggregate
-   /reference/method/MongoDBCollection-bulkWrite
-   /reference/method/MongoDBCollection-count
-   /reference/method/MongoDBCollection-countDocuments
-   /reference/method/MongoDBCollection-createIndex
-   /reference/method/MongoDBCollection-createIndexes
-   /reference/method/MongoDBCollection-deleteMany
-   /reference/method/MongoDBCollection-deleteOne
-   /reference/method/MongoDBCollection-distinct
-   /reference/method/MongoDBCollection-drop
-   /reference/method/MongoDBCollection-dropIndex
-   /reference/method/MongoDBCollection-dropIndexes
-   /reference/method/MongoDBCollection-estimatedDocumentCount
-   /reference/method/MongoDBCollection-explain
-   /reference/method/MongoDBCollection-find
-   /reference/method/MongoDBCollection-findOne
-   /reference/method/MongoDBCollection-findOneAndDelete
-   /reference/method/MongoDBCollection-findOneAndReplace
-   /reference/method/MongoDBCollection-findOneAndUpdate
-   /reference/method/MongoDBCollection-getCollectionName
-   /reference/method/MongoDBCollection-getDatabaseName
-   /reference/method/MongoDBCollection-getManager
-   /reference/method/MongoDBCollection-getNamespace
-   /reference/method/MongoDBCollection-getReadConcern
-   /reference/method/MongoDBCollection-getReadPreference
-   /reference/method/MongoDBCollection-getTypeMap
-   /reference/method/MongoDBCollection-getWriteConcern
-   /reference/method/MongoDBCollection-insertMany
-   /reference/method/MongoDBCollection-insertOne
-   /reference/method/MongoDBCollection-listIndexes
-   /reference/method/MongoDBCollection-mapReduce
-   /reference/method/MongoDBCollection-rename
-   /reference/method/MongoDBCollection-replaceOne
-   /reference/method/MongoDBCollection-updateMany
-   /reference/method/MongoDBCollection-updateOne
-   /reference/method/MongoDBCollection-watch
-   /reference/method/MongoDBCollection-withOptions
+   __construct() </reference/method/MongoDBCollection__construct>
+   aggregate() </reference/method/MongoDBCollection-aggregate>
+   bulkWrite() </reference/method/MongoDBCollection-bulkWrite>
+   count() </reference/method/MongoDBCollection-count>
+   countDocuments() </reference/method/MongoDBCollection-countDocuments>
+   createIndex() </reference/method/MongoDBCollection-createIndex>
+   createIndexes() </reference/method/MongoDBCollection-createIndexes>
+   deleteMany() </reference/method/MongoDBCollection-deleteMany>
+   deleteOne() </reference/method/MongoDBCollection-deleteOne>
+   distinct() </reference/method/MongoDBCollection-distinct>
+   drop() </reference/method/MongoDBCollection-drop>
+   dropIndex() </reference/method/MongoDBCollection-dropIndex>
+   dropIndexes() </reference/method/MongoDBCollection-dropIndexes>
+   estimatedDocumentCount() </reference/method/MongoDBCollection-estimatedDocumentCount>
+   explain() </reference/method/MongoDBCollection-explain>
+   find() </reference/method/MongoDBCollection-find>
+   findOne() </reference/method/MongoDBCollection-findOne>
+   findOneAndDelete() </reference/method/MongoDBCollection-findOneAndDelete>
+   findOneAndReplace() </reference/method/MongoDBCollection-findOneAndReplace>
+   findOneAndUpdate() </reference/method/MongoDBCollection-findOneAndUpdate>
+   getCollectionName() </reference/method/MongoDBCollection-getCollectionName>
+   getDatabaseName() </reference/method/MongoDBCollection-getDatabaseName>
+   getManager() </reference/method/MongoDBCollection-getManager>
+   getNamespace() </reference/method/MongoDBCollection-getNamespace>
+   getReadConcern() </reference/method/MongoDBCollection-getReadConcern>
+   getReadPreference() </reference/method/MongoDBCollection-getReadPreference>
+   getTypeMap() </reference/method/MongoDBCollection-getTypeMap>
+   getWriteConcern() </reference/method/MongoDBCollection-getWriteConcern>
+   insertMany() </reference/method/MongoDBCollection-insertMany>
+   insertOne() </reference/method/MongoDBCollection-insertOne>
+   listIndexes() </reference/method/MongoDBCollection-listIndexes>
+   mapReduce() </reference/method/MongoDBCollection-mapReduce>
+   rename() </reference/method/MongoDBCollection-rename>
+   replaceOne() </reference/method/MongoDBCollection-replaceOne>
+   updateMany() </reference/method/MongoDBCollection-updateMany>
+   updateOne() </reference/method/MongoDBCollection-updateOne>
+   watch() </reference/method/MongoDBCollection-watch>
+   withOptions() </reference/method/MongoDBCollection-withOptions>
+
+- :phpmethod:`MongoDB\\Collection::__construct()`
+- :phpmethod:`MongoDB\\Collection::aggregate()`
+- :phpmethod:`MongoDB\\Collection::bulkWrite()`
+- :phpmethod:`MongoDB\\Collection::count()`
+- :phpmethod:`MongoDB\\Collection::countDocuments()`
+- :phpmethod:`MongoDB\\Collection::createIndex()`
+- :phpmethod:`MongoDB\\Collection::createIndexes()`
+- :phpmethod:`MongoDB\\Collection::deleteMany()`
+- :phpmethod:`MongoDB\\Collection::deleteOne()`
+- :phpmethod:`MongoDB\\Collection::distinct()`
+- :phpmethod:`MongoDB\\Collection::drop()`
+- :phpmethod:`MongoDB\\Collection::dropIndex()`
+- :phpmethod:`MongoDB\\Collection::dropIndexes()`
+- :phpmethod:`MongoDB\\Collection::estimatedDocumentCount()`
+- :phpmethod:`MongoDB\\Collection::explain()`
+- :phpmethod:`MongoDB\\Collection::find()`
+- :phpmethod:`MongoDB\\Collection::findOne()`
+- :phpmethod:`MongoDB\\Collection::findOneAndDelete()`
+- :phpmethod:`MongoDB\\Collection::findOneAndReplace()`
+- :phpmethod:`MongoDB\\Collection::findOneAndUpdate()`
+- :phpmethod:`MongoDB\\Collection::getCollectionName()`
+- :phpmethod:`MongoDB\\Collection::getDatabaseName()`
+- :phpmethod:`MongoDB\\Collection::getManager()`
+- :phpmethod:`MongoDB\\Collection::getNamespace()`
+- :phpmethod:`MongoDB\\Collection::getReadConcern()`
+- :phpmethod:`MongoDB\\Collection::getReadPreference()`
+- :phpmethod:`MongoDB\\Collection::getTypeMap()`
+- :phpmethod:`MongoDB\\Collection::getWriteConcern()`
+- :phpmethod:`MongoDB\\Collection::insertMany()`
+- :phpmethod:`MongoDB\\Collection::insertOne()`
+- :phpmethod:`MongoDB\\Collection::listIndexes()`
+- :phpmethod:`MongoDB\\Collection::mapReduce()`
+- :phpmethod:`MongoDB\\Collection::rename()`
+- :phpmethod:`MongoDB\\Collection::replaceOne()`
+- :phpmethod:`MongoDB\\Collection::updateMany()`
+- :phpmethod:`MongoDB\\Collection::updateOne()`
+- :phpmethod:`MongoDB\\Collection::watch()`
+- :phpmethod:`MongoDB\\Collection::withOptions()`

docs/reference/class/MongoDBDatabase.txt

@@ -43,26 +43,48 @@ Methods
 .. toctree::
    :titlesonly:
 
-   /reference/method/MongoDBDatabase__construct
-   /reference/method/MongoDBDatabase__get
-   /reference/method/MongoDBDatabase-aggregate
-   /reference/method/MongoDBDatabase-command
-   /reference/method/MongoDBDatabase-createCollection
-   /reference/method/MongoDBDatabase-createEncryptedCollection
-   /reference/method/MongoDBDatabase-drop
-   /reference/method/MongoDBDatabase-dropCollection
-   /reference/method/MongoDBDatabase-getDatabaseName
-   /reference/method/MongoDBDatabase-getManager
-   /reference/method/MongoDBDatabase-getReadConcern
-   /reference/method/MongoDBDatabase-getReadPreference
-   /reference/method/MongoDBDatabase-getTypeMap
-   /reference/method/MongoDBDatabase-getWriteConcern
-   /reference/method/MongoDBDatabase-listCollectionNames
-   /reference/method/MongoDBDatabase-listCollections
-   /reference/method/MongoDBDatabase-modifyCollection
-   /reference/method/MongoDBDatabase-renameCollection
-   /reference/method/MongoDBDatabase-selectCollection
-   /reference/method/MongoDBDatabase-selectGridFSBucket
-   /reference/method/MongoDBDatabase-watch
-   /reference/method/MongoDBDatabase-withOptions
+   __construct() </reference/method/MongoDBDatabase__construct>
+   __get() </reference/method/MongoDBDatabase__get>
+   aggregate() </reference/method/MongoDBDatabase-aggregate>
+   command() </reference/method/MongoDBDatabase-command>
+   createCollection() </reference/method/MongoDBDatabase-createCollection>
+   createEncryptedCollection() </reference/method/MongoDBDatabase-createEncryptedCollection>
+   drop() </reference/method/MongoDBDatabase-drop>
+   dropCollection() </reference/method/MongoDBDatabase-dropCollection>
+   getDatabaseName() </reference/method/MongoDBDatabase-getDatabaseName>
+   getManager() </reference/method/MongoDBDatabase-getManager>
+   getReadConcern() </reference/method/MongoDBDatabase-getReadConcern>
+   getReadPreference() </reference/method/MongoDBDatabase-getReadPreference>
+   getTypeMap() </reference/method/MongoDBDatabase-getTypeMap>
+   getWriteConcern() </reference/method/MongoDBDatabase-getWriteConcern>
+   listCollectionNames() </reference/method/MongoDBDatabase-listCollectionNames>
+   listCollections() </reference/method/MongoDBDatabase-listCollections>
+   modifyCollection() </reference/method/MongoDBDatabase-modifyCollection>
+   renameCollection() </reference/method/MongoDBDatabase-renameCollection>
+   selectCollection() </reference/method/MongoDBDatabase-selectCollection>
+   selectGridFSBucket() </reference/method/MongoDBDatabase-selectGridFSBucket>
+   watch() </reference/method/MongoDBDatabase-watch>
+   withOptions() </reference/method/MongoDBDatabase-withOptions>
 
+- :phpmethod:`MongoDB\\Database::__construct()`
+- :phpmethod:`MongoDB\\Database::__get()`
+- :phpmethod:`MongoDB\\Database::aggregate()`
+- :phpmethod:`MongoDB\\Database::command()`
+- :phpmethod:`MongoDB\\Database::createCollection()`
+- :phpmethod:`MongoDB\\Database::createEncryptedCollection()`
+- :phpmethod:`MongoDB\\Database::drop()`
+- :phpmethod:`MongoDB\\Database::dropCollection()`
+- :phpmethod:`MongoDB\\Database::getDatabaseName()`
+- :phpmethod:`MongoDB\\Database::getManager()`
+- :phpmethod:`MongoDB\\Database::getReadConcern()`
+- :phpmethod:`MongoDB\\Database::getReadPreference()`
+- :phpmethod:`MongoDB\\Database::getTypeMap()`
+- :phpmethod:`MongoDB\\Database::getWriteConcern()`
+- :phpmethod:`MongoDB\\Database::listCollectionNames()`
+- :phpmethod:`MongoDB\\Database::listCollections()`
+- :phpmethod:`MongoDB\\Database::modifyCollection()`
+- :phpmethod:`MongoDB\\Database::renameCollection()`
+- :phpmethod:`MongoDB\\Database::selectCollection()`
+- :phpmethod:`MongoDB\\Database::selectGridFSBucket()`
+- :phpmethod:`MongoDB\\Database::watch()`
+- :phpmethod:`MongoDB\\Database::withOptions()`

docs/reference/class/MongoDBDeleteResult.txt

@@ -0,0 +1,26 @@
+===========================
+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:
+
+   getDeletedCount() </reference/method/MongoDBDeleteResult-getDeletedCount>
+   isAcknowledged() </reference/method/MongoDBDeleteResult-isAcknowledged>
+
+- :phpmethod:`MongoDB\\DeleteResult::getDeletedCount()`
+- :phpmethod:`MongoDB\\DeleteResult::isAcknowledged()`