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 时调用。该方法必须返回一个 arraystdClassMongoDB\BSON\Document

返回值将始终被序列化为 BSON 文档。序列化的文档将包含一个包含对象类名的字段。因此,在此方法中无法返回 MongoDB\BSON\PackedArray 实例。

鼓励用户在返回 BSON 根文档的数据时,包含一个 _id 属性(例如,在构造函数中初始化的 MongoDB\BSON\ObjectId)。在没有 _id 属性的情况下,扩展或服务器将分别为插入或更新操作生成一个 MongoDB\BSON\ObjectId

参数

此函数没有参数。

返回值

一个 arraystdClassMongoDB\BSON\Document,要序列化为 BSON 文档。

变更日志

版本 描述
PECL mongodb 1.17.0

此方法现在除了 arraystdClass 之外,还可以返回 MongoDB\BSON\Document 实例。

另请参阅

添加注释

用户贡献注释

此页面没有用户贡献的注释。
To Top