JsonSerializable::jsonSerialize

Angegebene Daten, die in JSON serialisiert werden sollen

Beschreibung

abstract public mixed JsonSerializable::jsonSerialize ( void )

Serialisiert das Objekt zu einem Wert, der nativ von json_encode serialisiert werden kann.

Parameter-Liste

Diese Funktion hat keine Parameter.

Rückgabewerte

Gibt Daten zurück, die von json_encode serialisiert werden können, welche ein Wert eines beliebigen Typs, der nicht resource ist.

Beispiele

Beispiel #1 JsonSerializable::jsonSerialize Beispiel, das ein array zurückgibt.


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

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

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

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

Beispiel #2 JsonSerializable::jsonSerialize Beispiel, das ein assoziatives array zurückgibt.


<?php
class ArrayValue implements JsonSerializable {
    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);
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

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

Beispiel #3 JsonSerializable::jsonSerialize Beispiel, das einen integer zurückgibt.


<?php
class IntegerValue implements JsonSerializable {
    public function __construct($number) {
        $this->number = (integer) $number;
    }

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

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

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

Beispiel #4 JsonSerializable::jsonSerialize Beispiel, das einen string zurückgibt


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

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

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

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

"Hello!"