XmlEncoder
class XmlEncoder implements EncoderInterface, DecoderInterface, NormalizationAwareInterface, SerializerAwareInterface
Traits
Constants
Properties
Methods
| setSerializer(SerializerInterface $serializer) Sets the serializer. | from SerializerAwareTrait |
| __construct(string $rootNodeName = 'response', int $loadOptions = null, array $ignoredNodeTypes = array(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 = 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. | |
bool | appendXMLString(DOMNode $node, string $val) | |
bool | appendText(DOMNode $node, string $val) | |
bool | appendCData(DOMNode $node, string $val) | |
bool | appendDocumentFragment(DOMNode $node, DOMDocumentFragment $fragment) | |
bool | isElementNameValid(string $name) Checks the name is a valid xml element name. | |
Details
Sets the serializer.
Parameters
__construct(string $rootNodeName = 'response', int $loadOptions = null, array $ignoredNodeTypes = array(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 | |
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
Exceptions
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
Exceptions
bool
supportsEncoding(string $format)
Checks whether the serializer can encode to given format.
Parameters
string | $format | Format name |
Return Value
bool
supportsDecoding(string $format)
Checks whether the deserializer can decode from given format.
Parameters
string | $format | Format name |
Return Value
setRootNodeName(string $name)
Sets the root node name.
Parameters
string | $name | Root node name |
string
getRootNodeName()
Returns the root node name.
Return Value
final protected bool
appendXMLString(DOMNode $node, string $val)
Parameters
Return Value
final protected bool
appendText(DOMNode $node, string $val)
Parameters
Return Value
final protected bool
appendCData(DOMNode $node, string $val)
Parameters
Return Value
final protected bool
appendDocumentFragment(DOMNode $node, DOMDocumentFragment $fragment)
Parameters
Return Value
final protected bool
isElementNameValid(string $name)
Checks the name is a valid xml element name.
Parameters
Return Value