class XmlEncoder implements EncoderInterface, DecoderInterface, NormalizationAwareInterface, SerializerAwareInterface

Encodes XML data.

Traits

SerializerAware trait.

Constants

FORMAT

Properties

protected SerializerInterface $serializer from SerializerAwareTrait

Methods

setSerializer(SerializerInterface $serializer)

Sets the serializer.

__construct(string $rootNodeName = 'response', int $loadOptions = null, array $ignoredNodeTypes = [XML_PI_NODE, XML_COMMENT_NODE])

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

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

Encodes data into the given format.

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

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.

bool
appendXMLString(DOMNode $node, string $val)

No description

bool
appendText(DOMNode $node, string $val)

No description

bool
appendCData(DOMNode $node, string $val)

No description

bool
appendDocumentFragment(DOMNode $node, DOMDocumentFragment $fragment)

No description

bool
isElementNameValid(string $name)

Checks the name is a valid xml element name.

Details

in SerializerAwareTrait at line 31
setSerializer(SerializerInterface $serializer)

Sets the serializer.

Parameters

SerializerInterface $serializer A SerializerInterface instance

at line 48
__construct(string $rootNodeName = 'response', int $loadOptions = null, array $ignoredNodeTypes = [XML_PI_NODE, XML_COMMENT_NODE])

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

Parameters

string $rootNodeName
int $loadOptions
array $ignoredNodeTypes

at line 58
string|int|float|bool encode(mixed $data, string $format, array $context = [])

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

at line 84
mixed decode(string $data, string $format, array $context = [])

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 152
bool supportsEncoding(string $format)

Checks whether the serializer can encode to given format.

Parameters

string $format Format name

Return Value

bool

at line 160
bool supportsDecoding(string $format)

Checks whether the deserializer can decode from given format.

Parameters

string $format Format name

Return Value

bool

at line 170
setRootNodeName(string $name)

Sets the root node name.

Parameters

string $name Root node name

at line 180
string getRootNodeName()

Returns the root node name.

Return Value

string

at line 185
final protected bool appendXMLString(DOMNode $node, string $val)

Parameters

DOMNode $node
string $val

Return Value

bool

at line 198
final protected bool appendText(DOMNode $node, string $val)

Parameters

DOMNode $node
string $val

Return Value

bool

at line 206
final protected bool appendCData(DOMNode $node, string $val)

Parameters

DOMNode $node
string $val

Return Value

bool

at line 218
final protected bool appendDocumentFragment(DOMNode $node, DOMDocumentFragment $fragment)

Parameters

DOMNode $node
DOMDocumentFragment $fragment

Return Value

bool

at line 232
final protected bool isElementNameValid(string $name)

Checks the name is a valid xml element name.

Parameters

string $name

Return Value

bool