A good example on when you would use functionality like this is when working with objects.
json_encode() will take a DateTime and convert it to:
{
"date":"2013-01-31 11:14:05",
"timezone_type":3,
"timezone":"America\/Los_Angeles"
}
This is great when working with PHP, but if the Date is being read by Java. The Java date parser doesn't know what to do with that. But it does know what to do with the ISO8601 format...
<?php
date_default_timezone_set('America/Los_Angeles');
class Fruit implements JsonSerializable {
public
$type = 'Apple',
$lastEaten = null;
public function __construct() {
$this->lastEaten = new DateTime();
}
public function jsonSerialize() {
return [
'type' => $this->type,
'lastEaten' => $this->lastEaten->format(DateTime::ISO8601)
];
}
}
echo json_encode(new Fruit()); //which outputs: {"type":"Apple","lastEaten":"2013-01-31T11:17:07-0500"}
?>
JsonSerializable::jsonSerialize
(PHP 5 >= 5.4.0)
JsonSerializable::jsonSerialize — Spécifie les données qui doivent être linéarisées en JSON
Description
Linéarise l'objet en une valeur qui peut être linéarisé nativement par la fonction json_encode().
Liste de paramètres
Cette fonction ne contient aucun paramètre.
Valeurs de retour
Retourne les données qui peuvent être linéarisées par la fonction json_encode(), qui peuvent être des valeurs de n'importe quel type autre qu'une ressource.
Exemples
Exemple #1 Exemple avec JsonSerializable::jsonSerialize() retournant un tableau
<?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);
?>
L'exemple ci-dessus va afficher :
[
1,
2,
3
]
Exemple #2 Exemple avec JsonSerializable::jsonSerialize() retournant un tableau associatif
<?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);
?>
L'exemple ci-dessus va afficher :
{
"foo": "bar",
"quux": "baz"
}
Exemple #3 Exemple avec JsonSerializable::jsonSerialize() retournant un entier
<?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);
?>
L'exemple ci-dessus va afficher :
1
Exemple #4 Exemple avec JsonSerializable::jsonSerialize() retournant une chaîne de caractères
<?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);
?>
L'exemple ci-dessus va afficher :
"Hello!"
