JsonSerializable::jsonSerialize
(PHP 5 >= 5.4.0, PHP 7, PHP 8)
JsonSerializable::jsonSerialize — Gibt die Daten an, die in JSON serialisiert werden sollen
Beschreibung
Serialisiert das Objekt zu einem Wert, der nativ von json_encode() serialisiert werden kann.
Parameter-Liste
Diese Funktion besitzt keine Parameter.
Rückgabewerte
Gibt die Daten zurück, die von der Funktion json_encode() serialisiert werden können, wobei es sich um Werte eines beliebigen Typs außer einer Ressource handeln kann.
Beispiele
Beispiel #1 Ein 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:
[
1,
2,
3
]
Beispiel #2 Ein 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 Ein 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:
1
Beispiel #4 Ein 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!"
