interface DecoderInterface

Defines the interface of decoders.

Methods

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

Decodes a string into PHP data.

bool
supportsDecoding(string $format)

Checks whether the deserializer can decode from given format.

Details

at line line 39
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 48
bool supportsDecoding(string $format)

Checks whether the deserializer can decode from given format.

Parameters

string $format format name

Return Value

bool