PHP Conference Kansai 2025

MongoDB\BSON\Persistable::bsonSerialize

(mongodb >=1.0.0)

MongoDB\BSON\Persistable::bsonSerializeFornece um array ou documento para serializar como BSON

Descrição

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

Chamado durante a serialização do objeto para BSON. O método precisa retornar um array, uma stdClass ou um MongoDB\BSON\Document.

O valor de retorno sempre será serializado como um documento BSON. O documento serializado irá incluir um campo contendo o nome da classe do objeto. Por esta razão, não é possível retornar uma instância de MongoDB\BSON\PackedArray neste método.

Usuários são encorajados a incluir uma propriedade _id (ex.: um MongoDB\BSON\ObjectId inicializado no construtor) ao retornar dados para um documento nativo BSON. Na ausência se uma propriedade _id, a extensão ou servidor irá gerar um MongoDB\BSON\ObjectId para operações de inserção ou atualização, respectivamente.

Parâmetros

Esta função não possui parâmetros.

Valor Retornado

Um array, uma stdClass ou um MongoDB\BSON\Document a ser serializado como um documento BSON.

Registro de Alterações

Versão Descrição
PECL mongodb 2.0.0 Os tipos de retorno anteriormente declarados como temporários agora devem ser cumpridos.
PECL mongodb 1.17.0

Este método agora também pode retornar instâncias de MongoDB\BSON\Document além de um array e uma stdClass.

Veja Também

adicione uma nota

Notas Enviadas por Usuários (em inglês)

Não há notas de usuários para esta página.
To Top