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

EncoderInterface

interface EncoderInterface

Defines the interface of encoders.

Methods

string|int|float|bool
encode(mixed $data, string $format, array $context = array())

Encodes data into the given format.

bool
supportsEncoding(string $format)

Checks whether the serializer can encode to given format.

Details

string|int|float|bool 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

string|int|float|bool

Exceptions

UnexpectedValueException

bool supportsEncoding(string $format)

Checks whether the serializer can encode to given format.

Parameters

string $format Format name

Return Value

bool