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

YamlEncoder

class YamlEncoder implements EncoderInterface, DecoderInterface

Encodes YAML data.

Constants

FORMAT

ALTERNATIVE_FORMAT

Methods

__construct(Dumper $dumper = null, Parser $parser = null, array $defaultContext = array())

No description

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.

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

__construct(Dumper $dumper = null, Parser $parser = null, array $defaultContext = array())

Parameters

Dumper $dumper
Parser $parser
array $defaultContext

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

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