MongoDB\BSON\Serializable::bsonSerialize
(mongodb >=1.0.0)
MongoDB\BSON\Serializable::bsonSerialize — Предоставляет массив или документ для сериализации в формат BSON
Описание
Корневые документы (например,
интерфейс MongoDB\BSON\Serializable, который передали
в метод MongoDB\BSON\fromPHP()) сериализуются
как BSON-документ. Для значений полей ассоциативные массивы
и экземпляры класса stdClass будут сериализованы как BSON-документ,
а последовательные массивы (то есть массивы с последовательными числовыми индексами, которые начинаются
с 0
) будут сериализованы BSON-массив.
Пользователям рекомендуется включать свойство _id (например,
объект класса MongoDB\BSON\ObjectId, который инициализировали в конструкторе)
при возврате данных для корневого BSON-документа. В отсутствие
свойства _id модуль будет генерировать
объект класса MongoDB\BSON\ObjectId для операций вставки,
а сервер для операций обновления или вставки.
Список параметров
У этой функции нет параметров.
Примеры
Пример #1 MongoDB\BSON\Serializable::bsonSerialize() возвращение ассоциативного массива для корневого документа
<?php
class MyDocument implements MongoDB\BSON\Serializable
{
private $id;
function __construct()
{
$this->id = new MongoDB\BSON\ObjectId;
}
function bsonSerialize(): array
{
return ['_id' => $this->id, 'foo' => 'bar'];
}
}
$bson = MongoDB\BSON\fromPHP(new MyDocument);
echo MongoDB\BSON\toJSON($bson), "\n";
?>
Вывод приведённого примера будет похож на:
{ "_id" : { "$oid" : "56cccdcada14d8755a58c591" }, "foo" : "bar" }
Пример #2 Пример использования метода MongoDB\BSON\Serializable::bsonSerialize(), возвращающего ассоциативный массив для корневого документа
<?php
class MyArray implements MongoDB\BSON\Serializable
{
function bsonSerialize(): array
{
return [1, 2, 3];
}
}
$bson = MongoDB\BSON\fromPHP(new MyArray);
echo MongoDB\BSON\toJSON($bson), "\n";
?>
Результат выполнения приведённого примера:
{ "0" : 1, "1" : 2, "2" : 3 }
Пример #3 MongoDB\BSON\Serializable::bsonSerialize() возвращение ассоциативного массива для поля документа
<?php
class MyDocument implements MongoDB\BSON\Serializable
{
function bsonSerialize(): array
{
return ['foo' => 'bar'];
}
}
$value = ['document' => new MyDocument];
$bson = MongoDB\BSON\fromPHP($value);
echo MongoDB\BSON\toJSON($bson), "\n";
?>
Результат выполнения приведённого примера:
{ "document" : { "foo" : "bar" } }
Пример #4 MongoDB\BSON\Serializable::bsonSerialize() возвращение последовательного массива для поля документа
<?php
class MyArray implements MongoDB\BSON\Serializable
{
function bsonSerialize(): array
{
return [1, 2, 3];
}
}
$value = ['array' => new MyArray];
$bson = MongoDB\BSON\fromPHP($value);
echo MongoDB\BSON\toJSON($bson), "\n";
?>
Результат выполнения приведённого примера:
{ "array" : [ 1, 2, 3 ] }