Rechercher une fonction PHP

MongoDB\BSON\Serializable: : bsonSerialize

(mongodb >=1.0.0)

MongoDB\BSON\Serializable::bsonSerializeFournit 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.

Retour à la première page de Manuel PHP  Table des matières Haut

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Retour à la première page de Manuel PHP  Table des matières Haut

Valeurs de retour

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

Retour à la première page de Manuel PHP  Table des matières Haut

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 [
123];
    }
}

$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 [
123];
    }
}

$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 ] }
Rechercher une fonction PHP

Version en cache

24/12/2024 15:15:25 Cette version de la page est en cache (à la date du 24/12/2024 15:15:25) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.

Document créé le 30/01/2003, dernière modification le 26/10/2018
Source du document imprimé : https://www.gaudry.be/php-rf-mongodb-bson-serializable.bsonserialize.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :fr Manuel PHP : http://php.net

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.

Table des matières Haut