Home/ Manual/ functions / bson/ MongoDB\BSON\toPHP

MongoDB\BSON\toPHP

PHP function Deprecated as of mongodb 1.20.0 Edit on GitHub ✎

(mongodb >=1.0.0)

Returns the PHP representation of a BSON value

This function has been DEPRECATED as of extension version 1.20.0 and was removed in 2.0. Applications should use MongoDB\BSON\Document::toPHP instead.

Description

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

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

Duplicate-keys

Parameters

bson (string): BSON value to be unserialized.

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.

Changelog

Version	Description
PECL mongodb 1.4.0	If the input contains an unsupported, deprecated BSON type, the extension will now no longer log a warning to the debug log, but instead will create an object representing this type.
PECL mongodb 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 extension will now log a warning to the debug log (see: mongodb.debug).
PECL mongodb 1.3.0	`MongoDB\Driver\Exception\UnexpectedValueException` is thrown if the input contains an unsupported, deprecated BSON type. Previously, such types were ignored.

Examples

MongoDB\BSON\toPHP() example

php

<?php

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

?>

The above example will output:

output

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