JsonSerializable::jsonSerialize

JSON にシリアライズしたいデータを指定する

説明

public mixed JsonSerializable::jsonSerialize()

オブジェクトをシリアライズして、 json_encode がネイティブにシリアライズできる値にします。

パラメータ

この関数にはパラメータはありません。

戻り値

json_encode でシリアライズするデータを返します。 resource 型以外の任意の型になります。

例

例1 JsonSerializable::jsonSerialize で配列を返す例

<?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);
?>

上の例の出力は以下となります。

例2 JsonSerializable::jsonSerialize で連想配列を返す例

<?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 で整数値を返す例

<?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);
?>

上の例の出力は以下となります。

例4 JsonSerializable::jsonSerialize で文字列を返す例

<?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!"