Merge v1.18 into master (#1300)

mongodb-php-bot · web-flow · commit c76ea21946e3 · 2024-05-10T10:18:41.000+02:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
diff --git a/.github/workflows/merge-up.yml b/.github/workflows/merge-up.yml
@@ -29,3 +29,4 @@ jobs:
           ref: ${{ github.ref_name }}
           branchNamePattern: 'v<major>.<minor>'
           fallbackBranch: 'master'
+          enableAutoMerge: true
diff --git a/docs/includes/extracts-option-requires.yaml b/docs/includes/extracts-option-requires.yaml
@@ -1,48 +1,47 @@
+ref: _option-requires-version
+content: |
+  This option is available since MongoDB {{version}} and will result in an
+  exception at execution time if specified for an older server version.
 ---
 ref: option-requires-4.2
 source:
-  ref: option-requires-version
   file: extracts-option-requires.yaml
+  ref: _option-requires-version
 replacement:
   version: "4.2"
 ---
 ref: option-requires-4.4
 source:
-  ref: option-requires-version
   file: extracts-option-requires.yaml
+  ref: _option-requires-version
 replacement:
   version: "4.4"
 ---
 ref: option-requires-5.0
 source:
-  ref: option-requires-version
   file: extracts-option-requires.yaml
+  ref: _option-requires-version
 replacement:
   version: "5.0"
 ---
 ref: option-requires-5.3
 source:
-  ref: option-requires-version
   file: extracts-option-requires.yaml
+  ref: _option-requires-version
 replacement:
   version: "5.3"
 ---
 ref: option-requires-6.0
 source:
-  ref: option-requires-version
   file: extracts-option-requires.yaml
+  ref: _option-requires-version
 replacement:
   version: "6.0"
 ---
 ref: option-requires-7.0
 source:
-  ref: option-requires-version
   file: extracts-option-requires.yaml
+  ref: _option-requires-version
 replacement:
   version: "7.0"
----
-ref: option-requires-version
-content: |
-  This option is available since MongoDB {{version}} and will result in an
-  exception at execution time if specified for an older server version.
 ...
diff --git a/docs/reference.txt b/docs/reference.txt
@@ -12,8 +12,6 @@ API Documentation
    /reference/class/MongoDBDatabase
    /reference/class/MongoDBCollection
    /reference/class/MongoDBGridFSBucket
-   /reference/write-result-classes
    /reference/result-classes
-   /reference/enumeration-classes
    /reference/functions
    /reference/exception-classes
diff --git a/docs/reference/method/MongoDBCollection-bulkWrite.txt b/docs/reference/method/MongoDBCollection-bulkWrite.txt
@@ -30,12 +30,12 @@ Parameters
 ``$operations`` : array
   An array containing the write operations to perform.
   :phpmethod:`MongoDB\Collection::bulkWrite()` supports
-  :phpmethod:`deleteMany() <MongoDB\Collection::deleteMany>`,
-  :phpmethod:`deleteOne() <MongoDB\Collection::deleteOne>`,
-  :phpmethod:`insertOne() <MongoDB\Collection::insertOne>`,
-  :phpmethod:`replaceOne() <MongoDB\Collection::replaceOne>`,
-  :phpmethod:`updateMany() <MongoDB\Collection::updateMany>`, and
-  :phpmethod:`updateOne() <MongoDB\Collection::updateOne>` operations in the
+  :phpmethod:`MongoDB\Collection::deleteMany()`,
+  :phpmethod:`MongoDB\Collection::deleteOne()`,
+  :phpmethod:`MongoDB\Collection::insertOne()`,
+  :phpmethod:`MongoDB\Collection::replaceOne()`,
+  :phpmethod:`MongoDB\Collection::updateMany()`, and
+  :phpmethod:`MongoDB\Collection::updateOne()` operations in the
   following array structure:
 
   .. code-block:: php
diff --git a/docs/reference/method/MongoDBCollection-dropIndex.txt b/docs/reference/method/MongoDBCollection-dropIndex.txt
@@ -29,8 +29,7 @@ Parameters
 
 ``$indexName`` : string| :phpclass:`MongoDB\Model\IndexInfo`
   The name or model object of the index to drop. View the existing indexes on
-  the collection using the :phpmethod:`listIndexes()
-  <MongoDB\Collection::listIndexes>` method.
+  the collection by using the :phpmethod:`MongoDB\Collection::listIndexes()` method.
 
 ``$options`` : array
   An array specifying the desired options.
diff --git a/docs/reference/method/MongoDBCollection-dropIndexes.txt b/docs/reference/method/MongoDBCollection-dropIndexes.txt
@@ -28,7 +28,7 @@ Parameters
 ``$indexName`` : string| :phpclass:`MongoDB\Model\IndexInfo`
   The name or model object of the index to drop. View the existing indexes on
   the collection using the :phpmethod:`listIndexes()
-  <MongoDB\Collection::listIndexes>` method.
+  <MongoDB\Collection::listIndexes()>` method.
 
 ``$options`` : array
   An array specifying the desired options.
diff --git a/docs/reference/method/MongoDBCollection-explain.txt b/docs/reference/method/MongoDBCollection-explain.txt
@@ -29,7 +29,7 @@ Definition
 Parameters
 ----------
 
-``$explainable`` : :phpclass:`MongoDB\Operation\Explainable`
+``$explainable`` : ``MongoDB\Operation\Explainable``
   The command to explain.
 
 ``$options`` : array
diff --git a/docs/reference/method/MongoDBCollection-findOneAndUpdate.txt b/docs/reference/method/MongoDBCollection-findOneAndUpdate.txt
@@ -33,7 +33,7 @@ Parameters
 
 ``$update`` : array|object
   Specifies the field and value combinations to update and any relevant update
-  operators. ``$update`` uses MongoDB's :method:`update operators
+  operators. ``$update`` uses MongoDB's :manual:`update operators
   </reference/operator/update>`. Starting with MongoDB 4.2, an `aggregation
   pipeline <https://mongodb.com/docs/master/reference/command/update/#update-with-an-aggregation-pipeline>`_
   can be passed as this parameter.
diff --git a/docs/reference/method/MongoDBCollection-updateMany.txt b/docs/reference/method/MongoDBCollection-updateMany.txt
@@ -33,7 +33,7 @@ Parameters
 
 ``$update`` : array|object
   Specifies the field and value combinations to update and any relevant update
-  operators. ``$update`` uses MongoDB's :method:`update operators
+  operators. ``$update`` uses MongoDB's :manual:`update operators
   </reference/operator/update>`. Starting with MongoDB 4.2, an `aggregation
   pipeline <https://mongodb.com/docs/master/reference/command/update/#update-with-an-aggregation-pipeline>`_
   can be passed as this parameter.
diff --git a/docs/reference/method/MongoDBCollection-updateOne.txt b/docs/reference/method/MongoDBCollection-updateOne.txt
@@ -35,7 +35,7 @@ Parameters
 
 ``$update`` : array|object
   Specifies the field and value combinations to update and any relevant update
-  operators. ``$update`` uses MongoDB's :method:`update operators
+  operators. ``$update`` uses MongoDB's :manual:`update operators
   </reference/operator/update>`. Starting with MongoDB 4.2, an `aggregation
   pipeline <https://mongodb.com/docs/master/reference/command/update/#update-with-an-aggregation-pipeline>`_
   can be passed as this parameter.
diff --git a/docs/reference/method/MongoDBDatabase-createCollection.txt b/docs/reference/method/MongoDBDatabase-createCollection.txt
@@ -296,7 +296,7 @@ Parameters
          rules or expressions. You can specify the expressions using the same
          operators as MongoDB's
          :manual:`query operators </reference/operator/query>` with the
-         exception of :query:`$geoNear`, :query:`$near`, :query:`$nearSphere`,
+         exception of :query:`$near`, :query:`$nearSphere`,
          :query:`$text`, and :query:`$where`.
 
          .. note::
diff --git a/docs/reference/result-classes.txt b/docs/reference/result-classes.txt
@@ -10,7 +10,7 @@ Result Classes
    BulkWriteResult Class </reference/class/MongoDBBulkWriteResult>
    DeleteResult Class </reference/class/MongoDBDeleteResult>
    InsertManyResult Class </reference/class/MongoDBInsertManyResult>
-   InsertOneResult Class </reference/class/MongoDInsertOneResult>
+   InsertOneResult Class </reference/class/MongoDBInsertOneResult>
    UpdateResult Class </reference/class/MongoDBUpdateResult>
    ChangeStream Class </reference/class/MongoDBChangeStream>
    MapReduceResult Class </reference/class/MongoDBMapReduceResult>
diff --git a/docs/tutorial/gridfs.txt b/docs/tutorial/gridfs.txt
@@ -35,7 +35,7 @@ The bucket can be constructed with various options:
   needed. The default size is ``261120`` (i.e. 255 KiB).
 - ``readConcern``, ``readPreference`` and ``writeConcern`` options can be used
   to specify defaults for read and write operations, much like the
-  :phpclass:`MongoDB\GridFS\Collection` options.
+  :phpclass:`MongoDB\Collection` options.
 
 Uploading Files with Writable Streams
 -------------------------------------
