MongoDB\BSON\Persistable::bsonSerialize
(mongodb >=1.0.0)
MongoDB\BSON\Persistable::bsonSerialize — Предоставляет массив или документ для сериализации в формате BSON
Описание
Вызывается при сериализации объекта в BSON. Метод должен возвращать массив (array), stdClass или MongoDB\BSON\Document.
Возвращаемое значение всегда будет сериализовано в виде BSON-документа. Сериализованный документ будет включать поле, содержащее имя класса объекта. По этой причине в данном методе невозможно вернуть экземпляр класса MongoDB\BSON\PackedArray.
Пользователям рекомендуется включать свойство _id (например, MongoDB\BSON\ObjectId, инициализированное в вашем конструкторе) при возвращении данных для корневого документа BSON; иначе драйверу или базе данных придётся генерировать MongoDB\BSON\ObjectId при добавлении или обновлении документа, соответственно.
Список параметров
У этой функции нет параметров.
Возвращаемые значения
Массив (array), stdClass или MongoDB\BSON\Document, который должен быть сериализован в виде BSON-документа.
Список изменений
| Версия | Описание |
|---|---|
| PECL mongodb 1.17.0 |
Теперь метод может также возвращать экземпляры MongoDB\BSON\Document в дополнение к массиву (array) и stdClass. |
Смотрите также
- MongoDB\BSON\Serializable::bsonSerialize() - Предоставляет массив или документ для сериализации в BSON
- MongoDB\BSON\Unserializable::bsonUnserialize() - Создаёт объект из массива BSON или документа
- MongoDB\BSON\Persistable
- Постоянные данные
add a note
