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

XmlEncoder

class XmlEncoder implements EncoderInterface, DecoderInterface, NormalizationAwareInterface, SerializerAwareInterface

Encodes XML data.

Traits

SerializerAwareTrait
SerializerAware trait.

Constants

FORMAT

AS_COLLECTION

DECODER_IGNORED_NODE_TYPES

An array of ignored XML node types while decoding, each one of the DOM Predefined XML_* constants.
ENCODER_IGNORED_NODE_TYPES

An array of ignored XML node types while encoding, each one of the DOM Predefined XML_* constants.
ENCODING

FORMAT_OUTPUT

LOAD_OPTIONS

A bit field of LIBXML_* constants.
REMOVE_EMPTY_TAGS

ROOT_NODE_NAME

STANDALONE

TYPE_CASE_ATTRIBUTES

VERSION

Properties

protected SerializerInterface $serializer from SerializerAwareTrait

Methods

setSerializer(SerializerInterface $serializer)

Sets the serializer.

from SerializerAwareTrait
__construct($defaultContext = array(), int $loadOptions = null, array $decoderIgnoredNodeTypes = array(XML_PI_NODE, XML_COMMENT_NODE), array $encoderIgnoredNodeTypes = array())

No description

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

Sets the root node name.

string
getRootNodeName() deprecated

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
appendComment(DOMNode $node, string $data)

No description

bool
isElementNameValid(string $name)

Checks the name is a valid xml element name.

Details

setSerializer(SerializerInterface $serializer)

Sets the serializer.

Parameters

SerializerInterface $serializer A SerializerInterface instance

__construct($defaultContext = array(), int $loadOptions = null, array $decoderIgnoredNodeTypes = array(XML_PI_NODE, XML_COMMENT_NODE), array $encoderIgnoredNodeTypes = array())

Parameters

$defaultContext
int $loadOptions
array $decoderIgnoredNodeTypes
array $encoderIgnoredNodeTypes

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

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

Checks whether the serializer can encode to given format.

Parameters

string $format Format name

Return Value

bool

bool supportsDecoding(string $format)

Checks whether the deserializer can decode from given format.

Parameters

string $format Format name

Return Value

bool

setRootNodeName(string $name) deprecated

deprecated since Symfony 4.2

Sets the root node name.

Parameters

string $name Root node name

string getRootNodeName() deprecated

deprecated since Symfony 4.2

Returns the root node name.

Return Value

string

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

Parameters

DOMNode $node
string $val

Return Value

bool

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

Parameters

DOMNode $node
string $val

Return Value

bool

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

Parameters

DOMNode $node
string $val

Return Value

bool

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

Parameters

DOMNode $node
DOMDocumentFragment $fragment

Return Value

bool

final protected bool appendComment(DOMNode $node, string $data)

Parameters

DOMNode $node
string $data

Return Value

bool

final protected bool isElementNameValid(string $name)

Checks the name is a valid xml element name.

Parameters

string $name

Return Value

bool