array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'fr', ), 'this' => array ( 0 => 'mongodb-bson-serializable.bsonserialize.php', 1 => 'MongoDB\\BSON\\Serializable::bsonSerialize', 2 => 'Fournit un tableau ou un document à sérialiser en tant que BSON', ), 'up' => array ( 0 => 'class.mongodb-bson-serializable.php', 1 => 'MongoDB\\BSON\\Serializable', ), 'prev' => array ( 0 => 'class.mongodb-bson-serializable.php', 1 => 'MongoDB\\BSON\\Serializable', ), 'next' => array ( 0 => 'class.mongodb-bson-unserializable.php', 1 => 'MongoDB\\BSON\\Unserializable', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'fr', 'path' => 'reference/mongodb/bson/serializable/bsonserialize.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

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(): array|stdClass|MongoDB\BSON\Document|MongoDB\BSON\PackedArray

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

Les documents racine (par exemple, un MongoDB\BSON\Serializable passé à MongoDB\BSON\Document::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 le constructeur) lors du retour des 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 de mise à jour, respectivement.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

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

Historique

Version Description
PECL mongodb 2.0.0 Les types de retour précédemment déclarés comme provisoires sont désormais appliqués.
PECL mongodb 1.17.0 Le type de retour n'est plus array|object. Plutôt qu'un object, le type de retour spécifie désormais stdClass. Les classes implémentant cette interface doivent être modifiées pour ne plus utiliser le type de retour object. Le type de retour étant prévisionnel, un avertissement de dépréciation est émis en PHP 8.1 ou ultérieur si les implémentations n'utilisent pas le bon type de retour. Additionnellement aux changements ci-dessus, l'extension supporte désormais de retourner des instances de MongoDB\BSON\Document et MongoDB\BSON\PackedArray. À noter que toute instance de MongoDB\BSON\PackedArray sera silencieusement convertie en objet lorsqu'il est stocké comme document racine. Ces instances sont stockées sous forme de tableaux lorsqu'elles sont utilisées comme valeur de champ intégrée.

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(): array
{
return ['_id' => $this->id, 'foo' => 'bar'];
}
}

echo MongoDB\BSON\Document::fromPHP(new MyDocument)->toRelaxedExtendedJSON(), "\n";

?>

Résultat de l'exemple ci-dessus est 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(): array
{
return [1, 2, 3];
}
}

echo MongoDB\BSON\Document::fromPHP(new MyArray)->toRelaxedExtendedJSON(), "\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(): array
{
return ['foo' => 'bar'];
}
}

$value = ['document' => new MyDocument];

echo MongoDB\BSON\Document::fromPHP($value)->toRelaxedExtendedJSON(), "\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(): array
{
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