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

MongoDB\BSON\fromPHP

PHP function Deprecated as of mongodb 1.20.0 Edit on GitHub ✎

(mongodb >=1.0.0)

Returns the BSON representation of a PHP 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::fromPHP instead.

Description

MongoDB\BSON\fromPHP(array|object $value): string

Serializes a PHP array or object (e.g. document) to its BSON representation. The returned binary string will describe a BSON document.

Parameters

value (array|object): PHP value to be serialized.

Return Values

The serialized BSON document as a binary string.

Errors/Exceptions

Throws MongoDB\Driver\Exception\UnexpectedValueException if the PHP value cannot be converted to BSON. Possible reasons include, but are not limited to, encountering an unexpected MongoDB\BSON\Type instance or MongoDB\BSON\Serializable::bsonSerialize() failing to return an array or stdClass.

Changelog

Version	Description

Examples

MongoDB\BSON\fromPHP() example

php

<?php

$bson = MongoDB\BSON\fromPHP(['foo' => 1]);
echo bin2hex($bson), "\n";

?>

The above example will output:

output

0e00000010666f6f000100000000