JsonSerializable::jsonSerialize

Specify data which should be serialized to JSON

&reftitle.description; public `mixed` `JsonSerializable::jsonSerialize`

Serializes the object to a value that can be serialized natively by `json_encode`.

&reftitle.parameters; &no.function.parameters;
&reftitle.returnvalues;

Returns data which can be serialized by `json_encode`, which is a value of any type other than a &resource;.

&reftitle.examples;

### `JsonSerializable::jsonSerialize` example returning an &array;

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

&example.outputs;

    [
        1,
        2,
        3
    ]

### `JsonSerializable::jsonSerialize` example returning an associative &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);
    ?>

&example.outputs;

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

### `JsonSerializable::jsonSerialize` example returning an &integer;

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

&example.outputs;

    1

### `JsonSerializable::jsonSerialize` example returning a &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);
    ?>

&example.outputs;

    "Hello!"