JsonSerializable::jsonSerialize

    (PHP 5 >= 5.4.0, PHP 7, PHP 8)

    JsonSerializable::jsonSerialize — Задаёт данные, которые должны быть сериализованы в JSON

    Описание

    publicJsonSerializable::jsonSerialize(): mixed

    Сериализует объект в значение, которое изначально может быть сериализовано функцией json_encode().

    Список параметров

    У этой функции нет параметров.

    Возвращаемые значения

    Возвращает данные, которые могут быть сериализованы json_encode(), которые являются значением любого типа, кроме resource.

    Примеры

    Пример #1 Пример использования JsonSerializable::jsonSerialize(), возвращающий массив (array)

    <?php

    class ArrayValue implements JsonSerializable {
    private     $array;
    public function     __construct(array $array) {
    $this->array = $array;
    }

    public function     jsonSerialize(): mixed {
    return     $this->array;
    }
    }

    $array = [1, 2, 3];
    echo     json_encode(new ArrayValue($array), JSON_PRETTY_PRINT);
    ?>

    Результат выполнения приведённого примера: 

    [ 1, 2, 3 ]

    Пример #2 Пример использования JsonSerializable::jsonSerialize(), возвращающий ассоциативный массив (array)

    <?php

    class ArrayValue implements JsonSerializable {
    private     $array;
    public function     __construct(array $array) {
    $this->array = $array;
    }

    public function     jsonSerialize() {
    return     $this->array;
    }
    }

    $array = ['foo' => 'bar', 'quux' => 'baz'];
    echo     json_encode(new ArrayValue($array), JSON_PRETTY_PRINT);
    ?>

    Результат выполнения приведённого примера: 

    { "foo": "bar", "quux": "baz" }

    Пример #3 Пример использования JsonSerializable::jsonSerialize(), возвращающий целое значение (int)

    <?php

    class IntegerValue implements JsonSerializable {
    private     $number;
    public function     __construct($number) {
    $this->number = (int) $number;
    }

    public function     jsonSerialize() {
    return     $this->number;
    }
    }

    echo     json_encode(new IntegerValue(1), JSON_PRETTY_PRINT);
    ?>

    Результат выполнения приведённого примера: 

    1

    Пример #4 Пример использования JsonSerializable::jsonSerialize(), возвращающий строку (string)

    <?php

    class StringValue implements JsonSerializable {
    private     $string;
    public function     __construct($string) {
    $this->string = (string) $string;
    }

    public function     jsonSerialize() {
    return     $this->string;
    }
    }

    echo     json_encode(new StringValue('Hello!'), JSON_PRETTY_PRINT);
    ?>

    Результат выполнения приведённого примера: 

    "Hello!"
    To Top