Fournit un tableau ou un document à sérialiser en tant que BSON

# MongoDB\BSON\Serializable::bsonSerialize

(mongodb >=1.0.0)

MongoDB\BSON\Serializable::bsonSerialize — Fournit un tableau ou un document à sérialiser en tant que BSON

### Description

abstract public MongoDB\BSON\Serializable::bsonSerialize ( void ) : array|object

Appelé pendant la sérialisation de l'objet à BSON. La méthode doit retourner un tableau ou stdClass.

Les documents racine (par exemple, un MongoDB\BSON\Serializable passé à MongoDB\BSON\fromPHP()) seront toujours sérialisés en tant que document BSON. Pour les valeurs de champ, les tableaux associatifs et les instances stdClass seront sérialisés en tant que document BSON et les tableaux séquentiels (c'est-à-dire les index numériques séquentiels commençant à 0) seront sérialisés en tant que tableau BSON.

Les utilisateurs sont encouragés à inclure une propriété _id (par exemple un MongoDB\BSON\ObjectId initialisé dans votre constructeur) lors du renvoi de données pour un document racine BSON; sinon, le pilote ou la base de données devra générer un MongoDB\BSON\ObjectId lors de l'insertion ou de la upserting du document, respectivement.

### Liste de paramètres

Cette fonction ne contient aucun paramètre.

### Valeurs de retour

tableau ou stdClass à sérialiser en tant que tableau ou document BSON.

### Exemples

Exemple #1 MongoDB\BSON\Serializable::bsonSerialize() renvoyant un tableau associatif pour le document racine

`<?php
class MyDocument implements MongoDB\BSON\Serializable
{
private $id;
function __construct()
{
$this->id = new MongoDB\BSON\ObjectId;
}
function bsonSerialize()
{
return ['_id' => $this->id, 'foo' => 'bar'];
}
}
$bson = MongoDB\BSON\fromPHP(new MyDocument);
echo MongoDB\BSON\toJSON($bson), "\n";
?>`

L'exemple ci-dessus va afficher quelque chose de similaire à :

    { "_id" : { "$oid" : "56cccdcada14d8755a58c591" }, "foo" : "bar" }

Exemple #2 MongoDB\BSON\Serializable::bsonSerialize() renvoyant un tableau séquentiel pour le document racine

`<?php
class MyArray implements MongoDB\BSON\Serializable
{
function bsonSerialize()
{
return [1, 2, 3];
}
}
$bson = MongoDB\BSON\fromPHP(new MyArray);
echo MongoDB\BSON\toJSON($bson), "\n";
?>`

L'exemple ci-dessus va afficher :

    { "0" : 1, "1" : 2, "2" : 3 }

Exemple #3 MongoDB\BSON\Serializable::bsonSerialize() renvoyant un tableau associatif pour le champ de document

`<?php
class MyDocument implements MongoDB\BSON\Serializable
{
function bsonSerialize()
{
return ['foo' => 'bar'];
}
}
$value = ['document' => new MyDocument];
$bson = MongoDB\BSON\fromPHP($value);
echo MongoDB\BSON\toJSON($bson), "\n";
?>`

L'exemple ci-dessus va afficher :

    { "document" : { "foo" : "bar" } }

Exemple #4 MongoDB\BSON\Serializable::bsonSerialize() renvoyant un tableau séquentiel pour le champ de document

`<?php
class MyArray implements MongoDB\BSON\Serializable
{
function bsonSerialize()
{
return [1, 2, 3];
}
}
$value = ['array' => new MyArray];
$bson = MongoDB\BSON\fromPHP($value);
echo MongoDB\BSON\toJSON($bson), "\n";
?>`

L'exemple ci-dessus va afficher :

    { "array" : [ 1, 2, 3 ] }

### Voir aussi

- MongoDB\BSON\Unserializable::bsonUnserialize() - Construit l'objet à partir d'un tableau ou d'un document BSON
- MongoDB\BSON\Persistable
- Persisting Data