XmlEncoder
class XmlEncoder implements EncoderInterface, DecoderInterface, NormalizationAwareInterface, SerializerAwareInterface
Encodes XML data.
Traits
SerializerAwareTrait | SerializerAware trait. |
Constants
FORMAT |
Methods
setSerializer(SerializerInterface $serializer) Sets the serializer. | from SerializerAwareTrait | |
__construct(string $rootNodeName = 'response', int $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
setSerializer(SerializerInterface $serializer)
Sets the serializer.
Parameters
SerializerInterface | $serializer | A SerializerInterface instance |
__construct(string $rootNodeName = 'response', int $loadOptions = null)
Construct new XmlEncoder and allow to change the root node element name.
Parameters
string | $rootNodeName | |
int | $loadOptions | A bit field of LIBXML_* constants |
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 |
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)
Sets the root node name.
Parameters
string | $name | Root node name |
string getRootNodeName()
Returns the root node name.
Return Value
string |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Serializer/Encoder/XmlEncoder.html