Merge pull request #300

Author: jmikola

source/includes/apiargs-MongoDBCollection-method-aggregate-option.yaml

@@ -49,11 +49,6 @@ source:
 source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: typeMap
-post: |
-  .. note::
-
-     This is not supported for inline aggregation results (i.e. ``useCursor``
-     option is ``false`` or the server version is < 2.6).
 ---
 arg_name: option
 name: useCursor

source/includes/apiargs-MongoDBCollection-method-findOneAndDelete-option.yaml

@@ -14,6 +14,12 @@ source:
   file: apiargs-common-option.yaml
   ref: maxTimeMS
 ---
+source:
+  file: apiargs-MongoDBCollection-common-option.yaml
+  ref: typeMap
+post: |
+  This will be used for the returned result document.
+---
 source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: writeConcern

source/includes/apiargs-MongoDBCollection-method-findOneAndReplace-option.yaml

@@ -31,6 +31,12 @@ interface: phpmethod
 operation: ~
 optional: true
 ---
+source:
+  file: apiargs-MongoDBCollection-common-option.yaml
+  ref: typeMap
+post: |
+  This will be used for the returned result document.
+---
 source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: upsert

source/includes/apiargs-MongoDBCollection-method-findOneAndUpdate-option.yaml

@@ -31,6 +31,12 @@ interface: phpmethod
 operation: ~
 optional: true
 ---
+source:
+  file: apiargs-MongoDBCollection-common-option.yaml
+  ref: typeMap
+post: |
+  This will be used for the returned result document.
+---
 source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: upsert

source/includes/extracts-bson-deserialization-base.yaml

@@ -58,14 +58,6 @@ MongoDB server version and whether the ``useCursor`` option is specified. If
 ``result`` array from the command response document. In both cases, the return
 value will be :php:`Traversable <traversable>`.
 
-.. note::
-
-   BSON deserialization of inline aggregation results (i.e. not using a command
-   cursor) does not yet support a ``typeMap`` option. Classes implementing
-   :php:`MongoDB\\BSON\\Persistable <mongodb-bson-persistable>` will still be
-   deserialized according to the
-   :php:`Persistence <mongodb.persistence.deserialization>` specification.
-
 .. todo: add examples
 
 See Also

source/includes/extracts-bson-deserialization.yaml

@@ -29,13 +29,11 @@ Definition
 
    .. include:: /includes/apiargs/MongoDBCollection-method-findOneAndDelete-option.rst
 
-   .. include:: /includes/extracts/bson-deserialization-findOneAndDelete.rst
-
 Return Values
 -------------
 
-An object for the document that was deleted, or ``null`` if no document matched
-the query.
+An array or object for the document that was deleted, or ``null`` if no document
+matched the query. The return type will depend on the ``typeMap`` option.
 
 Errors/Exceptions
 -----------------

source/reference/method/MongoDBCollection-aggregate.txt

@@ -29,14 +29,13 @@ Definition
 
    .. include:: /includes/apiargs/MongoDBCollection-method-findOneAndReplace-option.rst
 
-   .. include:: /includes/extracts/bson-deserialization-findOneAndReplace.rst
-
 Return Values
 -------------
 
-An object for either the original or the replaced document, depending on the
-specified value of the ``returnDocument`` option. By default, the original
+An array object for either the original or the replaced document, depending on
+the specified value of the ``returnDocument`` option. By default, the original
 document is returned. If no document matched the query, ``null`` is returned.
+The return type will depend on the ``typeMap`` option.
 
 Errors/Exceptions
 -----------------

source/reference/method/MongoDBCollection-findOneAndDelete.txt

@@ -29,14 +29,13 @@ Definition
 
    .. include:: /includes/apiargs/MongoDBCollection-method-findOneAndUpdate-option.rst
 
-   .. include:: /includes/extracts/bson-deserialization-findOneAndUpdate.rst
-
 Return Values
 -------------
 
-An object for either the original or the updated document, depending on the
-specified value of the ``returnDocument`` option. By default, the original
+An array or object for either the original or the updated document, depending on
+the specified value of the ``returnDocument`` option. By default, the original
 document is returned. If no document matched the query, ``null`` is returned.
+The return type will depend on the ``typeMap`` option.
 
 Errors/Exceptions
 -----------------