1. interface
  2. Symfony
  3. \
  4. Component
  5. \
  6. Serializer
  7. \
  8. Encoder
  9. \
  10. DecoderInterface

DecoderInterface

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

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

bool supportsDecoding(string $format)

Checks whether the deserializer can decode from given format.

Parameters

string $format Format name

Return Value

bool