array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ru', ), 'this' => array ( 0 => 'mongodb-bson-persistable.bsonserialize.php', 1 => 'MongoDB\\BSON\\Persistable::bsonSerialize', 2 => 'Предоставляет массив или документ для сериализации в формате BSON', ), 'up' => array ( 0 => 'class.mongodb-bson-persistable.php', 1 => 'MongoDB\\BSON\\Persistable', ), 'prev' => array ( 0 => 'class.mongodb-bson-persistable.php', 1 => 'MongoDB\\BSON\\Persistable', ), 'next' => array ( 0 => 'class.mongodb-bson-serializable.php', 1 => 'MongoDB\\BSON\\Serializable', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ru', 'path' => 'reference/mongodb/bson/persistable/bsonserialize.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

MongoDB\BSON\Persistable::bsonSerialize

(mongodb >=1.0.0)

MongoDB\BSON\Persistable::bsonSerialize — Предоставляет массив или документ для сериализации в формате BSON

Описание

abstract public MongoDB\BSON\Persistable::bsonSerialize(): array|stdClass|MongoDB\BSON\Document

Вызывается при сериализации объекта в BSON. Метод должен возвращать массив (array), stdClass или MongoDB\BSON\Document.

Возвращаемое значение всегда будет сериализовано в виде BSON-документа. Сериализованный документ будет включать поле, которое содержит имя класса объекта. По этой причине в этом методе невозможно вернуть экземпляр класса MongoDB\BSON\PackedArray.

Пользователям рекомендуется включать свойство _id (например, объект класса MongoDB\BSON\ObjectId, который инициализировали в конструкторе) при возврате данных для корневого BSON-документа. В отсутствие свойства _id модуль будет генерировать объект класса MongoDB\BSON\ObjectId для операций вставки, а сервер для операций обновления или вставки.

Список параметров

Сигнатура функции не содержит параметров.

Возвращаемые значения

Метод возвращает массив (array), объект класса stdClass или MongoDB\BSON\Document, который должен быть сериализован как BSON-документ.

Список изменений

Версия Описание
PECL-модуль mongodb 2.0.0 Типы значений возврата, которые для методов интерфейса прежде объявили предварительными, стали обязательными.
PECL mongodb 1.17.0

Теперь метод может также возвращать экземпляры классов MongoDB\BSON\Document в дополнение к массиву (array) и объекту класса stdClass.

Смотрите также