Skip to content

Commit 22f3fdc

Browse files
authored
Apply suggestions from code review
1 parent 27b7c4e commit 22f3fdc

File tree

74 files changed

+74
-74
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+74
-74
lines changed

source/reference.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ API Documentation
33
=================
44

55
.. meta::
6-
:description: Explore the PHP library API reference for detailed information on available methods and classes.
6+
:description: Explore the MongoDB PHP library API reference for detailed information on available methods and classes.
77

88

99
.. toctree::

source/reference/class/MongoDBClient.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client Class
33
=====================
44

55
.. meta::
6-
:description: Explore the MongoDB\Client class, which serves as the entry point for connecting to MongoDB servers and accessing databases and collections in PHP.
6+
:description: Explore the MongoDB\Client class, which serves as the entry point for connecting to MongoDB servers and accessing databases and collections in the MongoDB PHP Library.
77

88
.. contents:: On this page
99
:local:

source/reference/class/MongoDBCollection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection Class
33
=========================
44

55
.. meta::
6-
:description: Explore methods for performing CRUD operations and index management with the MongoDB\\Collection class in PHP.
6+
:description: Explore methods for performing CRUD operations and index management with the MongoDB\Collection class in the MongoDB PHP Library.
77

88

99
.. contents:: On this page

source/reference/class/MongoDBDatabase.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Database Class
33
=======================
44

55
.. meta::
6-
:description: Explore methods for database operations and collection management using the `MongoDB\\Database` class in PHP.
6+
:description: Explore methods for database operations and collection management using the MongoDB\Database class in the MongoDB PHP Library.
77

88
.. contents:: On this page
99
:local:

source/reference/class/MongoDBGridFSBucket.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\GridFS\\Bucket Class
33
=============================
44

55
.. meta::
6-
:description: Explore the `MongoDB\GridFS\Bucket` class for managing file storage and retrieval in MongoDB using PHP Streams.
6+
:description: Explore the MongoDB\GridFS\Bucket class for managing file storage and retrieval in the MongoDB PHP Library using PHP Streams.
77

88

99
.. contents:: On this page

source/reference/exception-classes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Exception Classes
33
=================
44

55
.. meta::
6-
:description: Explore various exception classes in the PHP library for MongoDB, detailing their usage and inheritance.
6+
:description: Explore MongoDB\Exception classes in the MongoDB PHP Library, detailing their usage and inheritance.
77

88

99
.. contents:: On this page

source/reference/method/MongoDBClient-createClientEncryption.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::createClientEncryption()
33
=========================================
44

55
.. meta::
6-
:description: Create a ClientEncryption object in PHP for manual encryption and decryption of values using MongoDB's `createClientEncryption()` method.
6+
:description: Create a ClientEncryption object in PHP for manual encryption and decryption of values with the MongoDB PHP Library.
77

88

99
.. contents:: On this page

source/reference/method/MongoDBClient-dropDatabase.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::dropDatabase()
33
===============================
44

55
.. meta::
6-
:description: Drop a database on the server using `MongoDB\Client::dropDatabase()` with options for comments, sessions, type maps, and write concerns.
6+
:description: Drop a database on the server with options for comments, sessions, type maps, and write concerns with the MongoDB PHP Library.
77

88
.. contents:: On this page
99
:local:

source/reference/method/MongoDBClient-getManager.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::getManager()
33
=============================
44

55
.. meta::
6-
:description: Access the MongoDB\Driver\Manager used by a Client with the getManager() method.
6+
:description: Access the MongoDB\Driver\Manager used by a Client with the MongoDB PHP Library.
77

88

99
.. contents:: On this page

source/reference/method/MongoDBClient-getReadConcern.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::getReadConcern()
33
=================================
44

55
.. meta::
6-
:description: Retrieve the read concern level set for a MongoDB client using the `getReadConcern()` method.
6+
:description: Retrieve the read concern level set for a Client with the MongoDB PHP Library.
77

88
.. versionadded:: 1.2
99

source/reference/method/MongoDBClient-getReadPreference.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::getReadPreference()
33
====================================
44

55
.. meta::
6-
:description: Retrieve the read preference setting for a MongoDB client using the `getReadPreference()` method.
6+
:description: Retrieve the read preference setting for a Client with the MongoDB PHP Library.
77

88
.. versionadded:: 1.2
99

source/reference/method/MongoDBClient-getTypeMap.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::getTypeMap()
33
=============================
44

55
.. meta::
6-
:description: Retrieve the type map for a MongoDB client using the `getTypeMap()` method in PHP.
6+
:description: Retrieve the type map for a Client with the MongoDB PHP Library.
77

88
.. versionadded:: 1.2
99

source/reference/method/MongoDBClient-getWriteConcern.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::getWriteConcern()
33
==================================
44

55
.. meta::
6-
:description: Retrieve the write concern for a MongoDB client using the `getWriteConcern()` method in PHP.
6+
:description: Retrieve the write concern for a Client with the MongoDB PHP Library.
77

88
.. versionadded:: 1.2
99

source/reference/method/MongoDBClient-listDatabaseNames.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::listDatabaseNames()
33
====================================
44

55
.. meta::
6-
:description: Retrieve database names from a MongoDB server using the `listDatabaseNames()` method with optional parameters for filtering and session management.
6+
:description: Retrieve database names from a MongoDB server with the MongoDB PHP Library, with optional parameters for filtering and session management.
77

88
.. versionadded:: 1.7
99

source/reference/method/MongoDBClient-listDatabases.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::listDatabases()
33
================================
44

55
.. meta::
6-
:description: Retrieve information for all databases on the server using `MongoDB\Client::listDatabases()` with optional parameters for filtering and session association.
6+
:description: Retrieve information for all databases on the server with the MongoDB PHP Library, with optional parameters for filtering and session association.
77

88
.. contents:: On this page
99
:local:

source/reference/method/MongoDBClient-removeSubscriber.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::removeSubscriber()
33
===================================
44

55
.. meta::
6-
:description: Unregister a monitoring event subscriber from a MongoDB client using the `removeSubscriber()` method.
6+
:description: Unregister a monitoring event subscriber from a Client with the MongoDB PHP Library.
77

88
.. versionadded:: 1.18
99

source/reference/method/MongoDBClient-selectCollection.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::selectCollection()
33
===================================
44

55
.. meta::
6-
:description: Select a collection on the server using `MongoDB\Client::selectCollection()` with customizable options for read and write concerns.
6+
:description: Select a collection on the server with the MongoDB PHP Library, with customizable options for read and write concerns.
77

88
.. contents:: On this page
99
:local:

source/reference/method/MongoDBClient-selectDatabase.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::selectDatabase()
33
=================================
44

55
.. meta::
6-
:description: Select a database on the server using `MongoDB\Client::selectDatabase()`, with options for read and write concerns, read preference, and type mapping.
6+
:description: Select a database on the server with the MongoDB PHP Library, with options for read and write concerns, read preference, and type mapping.
77

88
.. contents:: On this page
99
:local:

source/reference/method/MongoDBClient-startSession.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::startSession()
33
===============================
44

55
.. meta::
6-
:description: Start a new client session in PHP using `MongoDB\Client::startSession()` and handle potential exceptions.
6+
:description: Start a new client session with the MongoDB PHP Library and handle potential exceptions.
77

88
.. versionadded:: 1.3
99

source/reference/method/MongoDBClient-watch.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::watch()
33
========================
44

55
.. meta::
6-
:description: Execute a change stream operation on the client to monitor cluster-level changes using `MongoDB\Client::watch()`.
6+
:description: Execute a change stream operation on the Client to monitor cluster-level changes with the MongoDB PHP Library.
77

88
.. versionadded:: 1.4
99

source/reference/method/MongoDBClient__construct.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::__construct()
33
==============================
44

55
.. meta::
6-
:description: Learn how to construct a new MongoDB Client instance in PHP, including options for connection strings, authentication, SSL, and custom type maps.
6+
:description: Learn how to construct a new MongoDB Client instance with the MongoDB PHP Library, including options for connection strings, authentication, SSL, and custom type maps.
77

88

99
.. contents:: On this page

source/reference/method/MongoDBClient__get.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Client::__get()
33
========================
44

55
.. meta::
6-
:description: Access a database on the server using the `MongoDB\Client::__get()` method, which acts as an alias for `selectDatabase()`.
6+
:description: Access a database on the server with the MongoDB PHP Library, which acts as an alias for the selectDatabase() method.
77

88

99
.. contents:: On this page

source/reference/method/MongoDBCollection-aggregate.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::aggregate()
33
================================
44

55
.. meta::
6-
:description: Execute an aggregation framework pipeline operation on a collection using `MongoDB\Collection::aggregate()` with various customizable options.
6+
:description: Execute an aggregation framework pipeline operation on a collection with the MongoDB PHP Library, with various customizable options.
77

88

99
.. contents:: On this page

source/reference/method/MongoDBCollection-bulkWrite.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::bulkWrite()
33
================================
44

55
.. meta::
6-
:description: Execute multiple write operations in MongoDB using `bulkWrite()` with options for write concern, session, and more.
6+
:description: Execute multiple write operations with the MongoDB PHP Library, with options for write concern, session, and more.
77

88

99
.. contents:: On this page

source/reference/method/MongoDBCollection-count.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::count()
33
============================
44

55
.. meta::
6-
:description: Count documents matching filter criteria using `MongoDB\Collection::count()`, with options for collation, hint, limit, and more.
6+
:description: Count documents matching a filter criteria with the MongoDB PHP Library, with options for collation, hint, limit, and more.
77

88
.. deprecated:: 1.4
99

source/reference/method/MongoDBCollection-countDocuments.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::countDocuments()
33
=====================================
44

55
.. meta::
6-
:description: Count documents in a collection matching filter criteria using `MongoDB\Collection::countDocuments()` with various options for customization.
6+
:description: Count documents in a collection matching a filter criteria with the MongoDB PHP Library, with various options for customization.
77

88
.. versionadded:: 1.4
99

source/reference/method/MongoDBCollection-createIndex.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::createIndex()
33
==================================
44

55
.. meta::
6-
:description: Create an index in a MongoDB collection using `createIndex()` with options for collation, TTL, uniqueness, and more.
6+
:description: Create an index in a MongoDB collection with the MongoDB PHP Library, with options for collation, TTL, uniqueness, and more.
77

88

99
.. contents:: On this page

source/reference/method/MongoDBCollection-createIndexes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::createIndexes()
33
====================================
44

55
.. meta::
6-
:description: Create one or more indexes for a collection using `MongoDB\Collection::createIndexes()` with options for unique, compound, and 2dsphere indexes.
6+
:description: Create one or more indexes for a collection with the MongoDB PHP Library, with options for unique, compound, and 2dsphere indexes.
77

88
.. contents:: On this page
99
:local:

source/reference/method/MongoDBCollection-createSearchIndex.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::createSearchIndex()
33
========================================
44

55
.. meta::
6-
:description: Create an Atlas Search or Vector Search index for a collection using `MongoDB\Collection::createSearchIndex()` in PHP, specifying index type and options.
6+
:description: Create an Atlas Search or Vector Search index for a collection with the MongoDB PHP Library, specifying index type and options.
77

88
.. versionadded:: 1.17
99

source/reference/method/MongoDBCollection-createSearchIndexes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::createSearchIndexes()
33
==========================================
44

55
.. meta::
6-
:description: Create Atlas Search or Vector Search indexes for a collection using `createSearchIndexes()` in PHP, specifying index definitions and options.
6+
:description: Create Atlas Search or Vector Search indexes for a collection with the MongoDB PHP Library, specifying index definitions and options.
77

88
.. versionadded:: 1.17
99

source/reference/method/MongoDBCollection-deleteMany.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::deleteMany()
33
=================================
44

55
.. meta::
6-
:description: Delete multiple documents in a collection using `deleteMany()` with options for collation, hint, and write concern.
6+
:description: Delete multiple documents in a collection with the MongoDB PHP Library, with options for collation, hint, and write concern.
77

88

99
.. contents:: On this page

source/reference/method/MongoDBCollection-deleteOne.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::deleteOne()
33
================================
44

55
.. meta::
6-
:description: Delete a single document matching filter criteria using `MongoDB\Collection::deleteOne()` with options for collation, hint, and write concern.
6+
:description: Delete a single document matching a filter criteria with the MongoDB PHP Library, with options for collation, hint, and write concern.
77

88

99
.. contents:: On this page

source/reference/method/MongoDBCollection-distinct.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::distinct()
33
===============================
44

55
.. meta::
6-
:description: Find distinct values for a specified field in a MongoDB collection using the `distinct()` method, with options for filtering and additional parameters.
6+
:description: Find distinct values for a specified field in a collection with the MongoDB PHP Library, with options for filtering and additional parameters.
77

88
.. contents:: On this page
99
:local:

source/reference/method/MongoDBCollection-drop.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::drop()
33
===========================
44

55
.. meta::
6-
:description: Explore how to use the `MongoDB\Collection::drop()` method to remove a collection, including options for write concern and session management.
6+
:description: Remove a collection with the MongoDB PHP Library, including options for write concern and session management.
77

88

99
.. contents:: On this page

source/reference/method/MongoDBCollection-dropIndex.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::dropIndex()
33
================================
44

55
.. meta::
6-
:description: Drop an index from a collection using `MongoDB\Collection::dropIndex()` with options for session, write concern, and more.
6+
:description: Drop an index from a collection with the MongoDB PHP Library, with options for session, write concern, and more.
77

88
.. contents:: On this page
99
:local:

source/reference/method/MongoDBCollection-dropIndexes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::dropIndexes()
33
==================================
44

55
.. meta::
6-
:description: Drop all indexes in a MongoDB collection except the `_id` index using the `dropIndexes()` method, with options for comments, time limits, and write concerns.
6+
:description: Drop all indexes in a MongoDB collection except the `_id` index with the MongoDB PHP Library, with options for comments, time limits, and write concerns.
77

88
.. contents:: On this page
99
:local:

source/reference/method/MongoDBCollection-dropSearchIndex.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::dropSearchIndex()
33
======================================
44

55
.. meta::
6-
:description: Drop an Atlas Search index from a collection using the `dropSearchIndex` method, available for Atlas deployments with a minimum M10 cluster tier.
6+
:description: Drop an Atlas Search index from a collection with the MongoDB PHP Library, available for Atlas deployments with a minimum M10 cluster tier.
77

88
.. versionadded:: 1.17
99

source/reference/method/MongoDBCollection-estimatedDocumentCount.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::estimatedDocumentCount()
33
=============================================
44

55
.. meta::
6-
:description: Estimate the number of documents in a collection using `MongoDB\Collection::estimatedDocumentCount()` with optional parameters for read concern, read preference, and more.
6+
:description: Estimate the number of documents in a collection with the MongoDB PHP Library, with optional parameters for read concern, read preference, and more.
77

88
.. versionadded:: 1.4
99

source/reference/method/MongoDBCollection-explain.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::explain()
33
==============================
44

55
.. meta::
6-
:description: Explore how to use `MongoDB\Collection::explain()` to analyze command execution details, including parameters and return values.
6+
:description: Analyze command execution details with the MongoDB PHP Library, including parameters and return values.
77

88
.. versionadded:: 1.4
99

source/reference/method/MongoDBCollection-find.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::find()
33
===========================
44

55
.. meta::
6-
:description: Discover how to use `MongoDB\Collection::find()` to query documents with various options like filters, projections, and sorting in PHP.
6+
:description: Query documents with the MongoDB PHP Library, with various options like filters, projections, and sorting in PHP.
77

88
.. contents:: On this page
99
:local:

source/reference/method/MongoDBCollection-findOne.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::findOne()
33
==============================
44

55
.. meta::
6-
:description: Discover how to use `MongoDB\Collection::findOne()` to find a single document in a collection with various query and option parameters.
6+
:description: Find a single document in a collection with the MongoDB PHP Library, with various query and option parameters.
77

88
.. contents:: On this page
99
:local:

source/reference/method/MongoDBCollection-findOneAndDelete.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::findOneAndDelete()
33
=======================================
44

55
.. meta::
6-
:description: Use `findOneAndDelete()` to find and delete a single document matching a query in a MongoDB collection, with options for collation, projection, and more.
6+
:description: Find and delete a single document in a collection with the MongoDB PHP Library, with options for collation, projection, and more.
77

88

99
.. contents:: On this page

source/reference/method/MongoDBCollection-findOneAndReplace.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::findOneAndReplace()
33
========================================
44

55
.. meta::
6-
:description: Discover how to use `findOneAndReplace()` in PHP to find and replace a document in a MongoDB collection with various options and return the modified document.
6+
:description: Find and replace a document in a collection with the MongoDB PHP Library, with various options and return the modified document.
77

88

99
.. contents:: On this page

source/reference/method/MongoDBCollection-findOneAndUpdate.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ MongoDB\\Collection::findOneAndUpdate()
33
=======================================
44

55
.. meta::
6-
:description: Discover how to use `findOneAndUpdate()` in PHP to find and update a single document in a MongoDB collection, with options for projection, sorting, and more.
6+
:description: Find and update a single document in a collection with the MongoDB PHP Library, with options for projection, sorting, and more.
77

88

99
.. contents:: On this page

0 commit comments

Comments
 (0)