PHP 8.4.1 Released!

MongoDB\BSON\Persistable::bsonSerialize

(mongodb >=1.0.0)

MongoDB\BSON\Persistable::bsonSerializeFournit un tableau ou un document à sérialiser en tant que BSON

Description

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

Appelée lors de la sérialisation de l'objet en BSON. La méthode doit retourner un array, stdClass, ou MongoDB\BSON\Document.

La valeur de retour sera toujours sérialisée en tant que document BSON. Le document sérialisé inclura un champ contenant le nom de la classe de l'objet. Pour cette raison, il n'est pas possible de retourner une instance de MongoDB\BSON\PackedArray dans cette méthode.

Les utilisateurs sont encouragés à inclure une propriété _id (par exemple un MongoDB\BSON\ObjectId initialisé dans le constructeur) lors du retour de données pour un document racine BSON. En l'absence d'une propriété _id, l'extension ou le serveur générera un MongoDB\BSON\ObjectId pour les opérations d'insertion ou d'upsert, respectivement.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Un array, stdClass, ou MongoDB\BSON\Document à sérialiser en tant que document BSON.

Historique

Version Description
PECL mongodb 1.17.0

Cette méthode peut maintenant également retourner des instances de MongoDB\BSON\Document en plus de array et stdClass.

Voir aussi

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top