PHPLIB-112: Support typeMap option for findAndModify operations

Author: jmikola

src/Collection.php

@@ -553,14 +553,11 @@ public function findOne($filter = [], array $options = [])
      *
      * The document to return may be null if no document matched the filter.
      *
-     * Note: BSON deserialization of the returned document does not yet support
-     * a custom type map (depends on: https://jira.mongodb.org/browse/PHPC-314).
-     *
      * @see FindOneAndDelete::__construct() for supported options
      * @see http://docs.mongodb.org/manual/reference/command/findAndModify/
      * @param array|object $filter  Query by which to filter documents
      * @param array        $options Command options
-     * @return object|null
+     * @return array|object|null
      * @throws UnexpectedValueException if the command response was malformed
      * @throws UnsupportedException if options are not supported by the selected server
      * @throws InvalidArgumentException for parameter/option parsing errors
@@ -574,6 +571,10 @@ public function findOneAndDelete($filter, array $options = [])
             $options['writeConcern'] = $this->writeConcern;
         }
 
+        if ( ! isset($options['typeMap'])) {
+            $options['typeMap'] = $this->typeMap;
+        }
+
         $operation = new FindOneAndDelete($this->databaseName, $this->collectionName, $filter, $options);
 
         return $operation->execute($server);
@@ -588,15 +589,12 @@ public function findOneAndDelete($filter, array $options = [])
      * FindOneAndReplace::RETURN_DOCUMENT_AFTER for the "returnDocument" option
      * to return the updated document.
      *
-     * Note: BSON deserialization of the returned document does not yet support
-     * a custom type map (depends on: https://jira.mongodb.org/browse/PHPC-314).
-     *
      * @see FindOneAndReplace::__construct() for supported options
      * @see http://docs.mongodb.org/manual/reference/command/findAndModify/
      * @param array|object $filter      Query by which to filter documents
      * @param array|object $replacement Replacement document
      * @param array        $options     Command options
-     * @return object|null
+     * @return array|object|null
      * @throws UnexpectedValueException if the command response was malformed
      * @throws UnsupportedException if options are not supported by the selected server
      * @throws InvalidArgumentException for parameter/option parsing errors
@@ -610,6 +608,10 @@ public function findOneAndReplace($filter, $replacement, array $options = [])
             $options['writeConcern'] = $this->writeConcern;
         }
 
+        if ( ! isset($options['typeMap'])) {
+            $options['typeMap'] = $this->typeMap;
+        }
+
         $operation = new FindOneAndReplace($this->databaseName, $this->collectionName, $filter, $replacement, $options);
 
         return $operation->execute($server);
@@ -624,15 +626,12 @@ public function findOneAndReplace($filter, $replacement, array $options = [])
      * FindOneAndUpdate::RETURN_DOCUMENT_AFTER for the "returnDocument" option
      * to return the updated document.
      *
-     * Note: BSON deserialization of the returned document does not yet support
-     * a custom type map (depends on: https://jira.mongodb.org/browse/PHPC-314).
-     *
      * @see FindOneAndReplace::__construct() for supported options
      * @see http://docs.mongodb.org/manual/reference/command/findAndModify/
      * @param array|object $filter  Query by which to filter documents
      * @param array|object $update  Update to apply to the matched document
      * @param array        $options Command options
-     * @return object|null
+     * @return array|object|null
      * @throws UnexpectedValueException if the command response was malformed
      * @throws UnsupportedException if options are not supported by the selected server
      * @throws InvalidArgumentException for parameter/option parsing errors
@@ -646,6 +645,10 @@ public function findOneAndUpdate($filter, $update, array $options = [])
             $options['writeConcern'] = $this->writeConcern;
         }
 
+        if ( ! isset($options['typeMap'])) {
+            $options['typeMap'] = $this->typeMap;
+        }
+
         $operation = new FindOneAndUpdate($this->databaseName, $this->collectionName, $filter, $update, $options);
 
         return $operation->execute($server);

src/Operation/FindAndModify.php

@@ -60,6 +60,8 @@ class FindAndModify implements Executable
      *  * sort (document): Determines which document the operation modifies if
      *    the query selects multiple documents.
      *
+     *  * typeMap (array): Type map for BSON deserialization.
+     *
      *  * update (document): Update or replacement to apply to the matched
      *    document. This option cannot be set if the remove option is true.
      *
@@ -117,6 +119,10 @@ public function __construct($databaseName, $collectionName, array $options)
             throw InvalidArgumentException::invalidType('"sort" option', $options['sort'], 'array or object');
         }
 
+        if (isset($options['typeMap']) && ! is_array($options['typeMap'])) {
+            throw InvalidArgumentException::invalidType('"typeMap" option', $options['typeMap'], 'array');
+        }
+
         if (isset($options['update']) && ! is_array($options['update']) && ! is_object($options['update'])) {
             throw InvalidArgumentException::invalidType('"update" option', $options['update'], 'array or object');
         }
@@ -143,7 +149,7 @@ public function __construct($databaseName, $collectionName, array $options)
      *
      * @see Executable::execute()
      * @param Server $server
-     * @return object|null
+     * @return array|object|null
      * @throws UnexpectedValueException if the command response was malformed
      * @throws UnsupportedException if collation or write concern is used and unsupported
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
@@ -180,6 +186,10 @@ public function execute(Server $server)
             throw new UnexpectedValueException('findAndModify command did not return a "value" document');
         }
 
+        if (isset($this->options['typeMap'])) {
+            return \MongoDB\apply_type_map_to_document($result->value, $this->options['typeMap']);
+        }
+
         return $result->value;
     }
 

src/Operation/FindOneAndDelete.php

@@ -37,6 +37,8 @@ class FindOneAndDelete implements Executable
      *  * sort (document): Determines which document the operation modifies if
      *    the query selects multiple documents.
      *
+     *  * typeMap (array): Type map for BSON deserialization.
+     *
      *  * writeConcern (MongoDB\Driver\WriteConcern): Write concern.
      *
      *    This is not supported for server versions < 3.2 and will result in an
@@ -76,7 +78,7 @@ public function __construct($databaseName, $collectionName, $filter, array $opti
      *
      * @see Executable::execute()
      * @param Server $server
-     * @return object|null
+     * @return array|object|null
      * @throws UnsupportedException if collation or write concern is used and unsupported
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */

src/Operation/FindOneAndReplace.php

@@ -49,6 +49,8 @@ class FindOneAndReplace implements Executable
      *  * sort (document): Determines which document the operation modifies if
      *    the query selects multiple documents.
      *
+     *  * typeMap (array): Type map for BSON deserialization.
+     *
      *  * upsert (boolean): When true, a new document is created if no document
      *    matches the query. The default is false.
      *
@@ -116,7 +118,7 @@ public function __construct($databaseName, $collectionName, $filter, $replacemen
      *
      * @see Executable::execute()
      * @param Server $server
-     * @return object|null
+     * @return array|object|null
      * @throws UnsupportedException if collation or write concern is used and unsupported
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */

src/Operation/FindOneAndUpdate.php

@@ -49,6 +49,8 @@ class FindOneAndUpdate implements Executable
      *  * sort (document): Determines which document the operation modifies if
      *    the query selects multiple documents.
      *
+     *  * typeMap (array): Type map for BSON deserialization.
+     *
      *  * upsert (boolean): When true, a new document is created if no document
      *    matches the query. The default is false.
      *
@@ -116,7 +118,7 @@ public function __construct($databaseName, $collectionName, $filter, $update, ar
      *
      * @see Executable::execute()
      * @param Server $server
-     * @return object|null
+     * @return array|object|null
      * @throws UnsupportedException if collation or write concern is used and unsupported
      * @throws DriverRuntimeException for other driver errors (e.g. connection errors)
      */

tests/Operation/FindAndModifyTest.php

@@ -51,6 +51,10 @@ public function provideInvalidConstructorOptions()
             $options[][] = ['sort' => $value];
         }
 
+        foreach ($this->getInvalidArrayValues() as $value) {
+            $options[][] = ['typeMap' => $value];
+        }
+
         foreach ($this->getInvalidDocumentValues() as $value) {
             $options[][] = ['update' => $value];
         }