class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, DecoderInterface, NormalizationAwareInterface

Encodes XML data.

Traits

SerializerAware trait.

Methods

setSerializer(SerializerInterface $serializer)

Sets the serializer.

__construct(string $rootNodeName = 'response', int|null $loadOptions = null)

Construct new XmlEncoder and allow to change the root node element name.

scalar
encode(mixed $data, string $format, array $context = array())

Encodes data into the given format.

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

Decodes a string into PHP data.

bool
supportsEncoding(string $format)

Checks whether the serializer can encode to given format.

bool
supportsDecoding(string $format)

Checks whether the deserializer can decode from given format.

setRootNodeName(string $name)

Sets the root node name.

string
getRootNodeName()

Returns the root node name.

Details

in SerializerAwareTrait at line line 31
setSerializer(SerializerInterface $serializer)

Sets the serializer.

Parameters

SerializerInterface $serializer A SerializerInterface instance

at line line 41
__construct(string $rootNodeName = 'response', int|null $loadOptions = null)

Construct new XmlEncoder and allow to change the root node element name.

Parameters

string $rootNodeName
int|null $loadOptions A bit field of LIBXML_* constants

at line line 50
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 76
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 144
bool supportsEncoding(string $format)

Checks whether the serializer can encode to given format.

Parameters

string $format format name

Return Value

bool

at line line 152
bool supportsDecoding(string $format)

Checks whether the deserializer can decode from given format.

Parameters

string $format format name

Return Value

bool

at line line 162
setRootNodeName(string $name)

Sets the root node name.

Parameters

string $name root node name

at line line 172
string getRootNodeName()

Returns the root node name.

Return Value

string