Skip to content

Commit 48e60f4

Browse files
committed
Clarify that Persistable is supported in methods without "typeMap" option
1 parent ba1c74f commit 48e60f4

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

docs/classes/collection.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,12 @@ returned; otherwise, an ArrayIterator is returned, which wraps the "result"
7575
array from the command response document.
7676

7777
**Note:** BSON deserialization of inline aggregation results (i.e. not using a
78-
command cursor) does not yet support a custom type map. Support is pending new
79-
functionality in the driver.
78+
command cursor) does not yet support a "typeMap" options; however, classes
79+
implementing [MongoDB\BSON\Persistable][persistable] will still be deserialized
80+
according to the [Persistence][persistence] specification.
81+
82+
[persistable]: http://php.net/mongodb-bson-persistable
83+
[persistence]: http://php.net/manual/en/mongodb.persistence.deserialization.php
8084

8185
### Supported Options
8286

@@ -595,7 +599,9 @@ Finds a single document and deletes it, returning the original. The document to
595599
return may be null if no document matched the filter.
596600

597601
**Note:** BSON deserialization of the returned document does not yet support a
598-
custom type map. Support is pending new functionality in the driver.
602+
"typeMap" option; however, classes implementing
603+
[MongoDB\BSON\Persistable][persistable] will still be deserialized according to
604+
the [Persistence][persistence] specification.
599605

600606
### Supported Options
601607

@@ -635,7 +641,9 @@ default, the original document is returned. Specify
635641
"returnDocument" option to return the updated document.
636642

637643
**Note:** BSON deserialization of the returned document does not yet support a
638-
custom type map. Support is pending new functionality in the driver.
644+
"typeMap" option; however, classes implementing
645+
[MongoDB\BSON\Persistable][persistable] will still be deserialized according to
646+
the [Persistence][persistence] specification.
639647

640648
### Supported Options
641649

@@ -688,7 +696,9 @@ default, the original document is returned. Specify
688696
"returnDocument" option to return the updated document.
689697

690698
**Note:** BSON deserialization of the returned document does not yet support a
691-
custom type map. Support is pending new functionality in the driver.
699+
"typeMap" option; however, classes implementing
700+
[MongoDB\BSON\Persistable][persistable] will still be deserialized according to
701+
the [Persistence][persistence] specification.
692702

693703
### Supported Options
694704

0 commit comments

Comments
 (0)