class JsonEncoder implements EncoderInterface, DecoderInterface

Encodes JSON data.

Constants

FORMAT

Methods

__construct(JsonEncode $encodingImpl = null, JsonDecode $decodingImpl = null)

No description

int
getLastEncodingError() deprecated

Returns the last encoding error (if any).

int
getLastDecodingError() deprecated

Returns the last decoding error (if any).

scalar
encode(mixed $data, string $format, array $context = array())

Encodes data into the given format.

mixed
decode(string $data, string $format, array $context = array())

Decodes a string into PHP data.

bool
supportsEncoding(string $format)

Checks whether the serializer can encode to given format.

bool
supportsDecoding(string $format)

Checks whether the deserializer can decode from given format.

static string
getLastErrorMessage() deprecated

Resolves jsonlasterror message.

Details

at line line 26
__construct(JsonEncode $encodingImpl = null, JsonDecode $decodingImpl = null)

Parameters

JsonEncode $encodingImpl
JsonDecode $decodingImpl

at line line 39
int getLastEncodingError() deprecated

deprecated since version 2.5, to be removed in 3.0. JsonEncode throws exception if an error is found.

Returns the last encoding error (if any).

Return Value

int

at line line 53
int getLastDecodingError() deprecated

deprecated since version 2.5, to be removed in 3.0. JsonDecode throws exception if an error is found.

Returns the last decoding error (if any).

Return Value

int

at line line 63
scalar encode(mixed $data, string $format, array $context = array())

Encodes data into the given format.

Parameters

mixed $data Data to encode
string $format Format name
array $context Options that normalizers/encoders have access to

Return Value

scalar

Exceptions

UnexpectedValueException

at line line 71
mixed decode(string $data, string $format, array $context = array())

Decodes a string into PHP data.

Parameters

string $data Data to decode
string $format Format name
array $context Options that decoders have access to

The format parameter specifies which format the data is in; valid values depend on the specific implementation. Authors implementing this interface are encouraged to document which formats they support in a non-inherited phpdoc comment.

Return Value

mixed

Exceptions

UnexpectedValueException

at line line 79
bool supportsEncoding(string $format)

Checks whether the serializer can encode to given format.

Parameters

string $format Format name

Return Value

bool

at line line 87
bool supportsDecoding(string $format)

Checks whether the deserializer can decode from given format.

Parameters

string $format Format name

Return Value

bool

at line line 99
static string getLastErrorMessage() deprecated

deprecated since 2.8, to be removed in 3.0. Use json_last_error_msg() instead.

Resolves jsonlasterror message.

Return Value

string