Returns the PHP representation of a BSON value

Description

array|object MongoDB\BSON\toPHP ( string $bson [, array $typeMap = [] ] )

Unserializes a BSON document (i.e. binary string) to its PHP representation. The typeMap paramater may be used to control the PHP types used for converting BSON arrays and documents (both root and embedded).

Warning

Fields containing deprecated BSON types (i.e. undefined, symbol, DBPointer) are ignored when converting BSON to PHP. This can result in a loss of data when round-tripping BSON documents through PHP, as any fields containing a deprecated type will be silently dropped.

Parameters

bson (string): BSON value to be unserialized.
typeMap (array): Type map configuration.

Return Values

The unserialized PHP value.

Errors/Exceptions

Throws MongoDB\Driver\Exception\InvalidArgumentException if a class in the type map cannot be instantiated or does not implement MongoDB\BSON\Unserializable.
Throws MongoDB\Driver\Exception\UnexpectedValueException if the input contains an unsupported, deprecated BSON type. Possible types include 0x06 (undefined), 0x0E (symbol), and 0x0C (DBPointer).
Throws MongoDB\Driver\Exception\UnexpectedValueException if the input did not contain exactly one BSON document. Possible reasons include, but are not limited to, invalid BSON, extra data (after reading one BSON document), or an unexpected » libbson error.

Changelog

Version	Description
1.3.2	MongoDB\Driver\Exception\UnexpectedValueException is no longer thrown if the input contains an unsupported, deprecated BSON type. Such types will be ignored (as they were in versions before 1.3.0), although the driver will now log a warning to the debug log (see: mongodb.debug).
1.3.0	MongoDB\Driver\Exception\UnexpectedValueException is thrown if the input contains an unsupported, deprecated BSON type. Previously, such types were ignored.

Examples

Example #1 MongoDB\BSON\toPHP() example


<?php

$bson = hex2bin('0e00000010666f6f000100000000');
$value = MongoDB\BSON\toPHP($bson);
var_dump($value);

?>

The above example will output:

object(stdClass)#1 (1) {
  ["foo"]=>
  int(1)
}

MongoDB\BSON\toPHP