« MongoDB\BSON\toJSON
MongoDB\BSON\toRelaxedExtendedJSON »

MongoDB\BSON\toPHP

(mongodb >=1.0.0)

MongoDB\BSON\toPHP — 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.

説明

function 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).

警告

BSON documents can technically contain duplicate keys because documents are stored as a list of key-value pairs; however, applications should refrain from generating documents with duplicate keys as server and driver behavior may be undefined. Since PHP objects and arrays cannot have duplicate keys, data could also be lost when decoding a BSON document with duplicate keys.

パラメータ

bson (string)

BSON value to be unserialized.

typeMap (array)

Type map configuration.

戻り値

The unserialized PHP value.

エラー / 例外

変更履歴

バージョン 説明
PECL mongodb 2.0.0 This function was removed.
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.

例

例1 MongoDB\BSON\toPHP() example

<?php

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

?>

上の例の出力は以下となります。

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

参考

関連キーワード:
MongoDB   toPHP   representation   mongodb   document   type   bson   documents   duplicate   keys   Driver   Exception   input   extension   typeMap   types   UnexpectedValueException   contains   unsupported   deprecated   debug   removed   Document   instead   used
関連する関数・ページ:
mongodb-bson-document.tophp   mongodb-bson-packedarray.tophp   function.mongodb.bson-fromphp   ref.bson.functions   function.mongodb.bson-fromjson   mongodb-bson-int64.tostring