Edit Report a Bug

    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\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, stdClass, MongoDB\BSON\Document, or MongoDB\BSON\PackedArray à sérialiser en tant que tableau ou document BSON.

    Historique

    Version Description
    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, le pilote 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 lorsque stocké comme document racine. Ces instances sont stockés sous forme de tableaux lorsqu'elles sont utilisés 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'];
    }
    }

    $bson = MongoDB\BSON\fromPHP(new MyDocument);
    echo     MongoDB\BSON\toJSON($bson), "\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];
    }
    }

    $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(): array
    {
    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(): 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

    add a note add a note

    User Contributed Notes 1 note

    up
    0
    Anonymous
    8 years ago
    This documentation seems to be obsolete because I tried the first example and it doesn't convert the objectId to a string.

    This seems to be more current documentation but I can't figure out how to get bson to json

    http://mongodb.github.io/mongo-php-library/api/source-class-MongoDB.Model.BSONDocument.html#48-57
    add a note add a note
    To Top