1. interface
  2. Symfony
  3. Component
  4. Serializer
  5. Encoder
  6. EncoderInterface

EncoderInterface

interface EncoderInterface

Defines the interface of encoders.

Methods

scalar
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

at line line 34
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 43
bool supportsEncoding(string $format)

Checks whether the serializer can encode to given format.

Parameters

string $format format name

Return Value

bool