PHP 7.4.0RC6 Released!

MongoDB\BSON\toPHP

(mongodb >=1.0.0)

MongoDB\BSON\toPHPReturns the PHP representation of a BSON value

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 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 represented only by bare-bones objects of the classes MongoDB\BSON\Undefined, MongoDB\BSON\Symbol, and MongoDB\BSON\DBPointer, when converting BSON to PHP. These objects are created from BSON data and used for storing these types back into the database, but can not be instantiated as they have a private constructor.

Parameters

bson (string)

BSON value to be unserialized.

typeMap (array)

Type map configuration.

Return Values

The unserialized PHP value.

Errors/Exceptions

Changelog

Version Description
1.4.0

If the input contains an unsupported, deprecated BSON type, the driver will now no longer log a warning to the debug log, but instead will create an object representing this type.

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)
}

See Also

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top