annotate core/modules/serialization/src/Encoder/XmlEncoder.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\serialization\Encoder;
Chris@0 4
Chris@0 5 use Symfony\Component\Serializer\Encoder\EncoderInterface;
Chris@0 6 use Symfony\Component\Serializer\Encoder\DecoderInterface;
Chris@0 7 use Symfony\Component\Serializer\Encoder\XmlEncoder as BaseXmlEncoder;
Chris@17 8 use Symfony\Component\Serializer\SerializerAwareInterface;
Chris@17 9 use Symfony\Component\Serializer\SerializerAwareTrait;
Chris@0 10
Chris@0 11 /**
Chris@0 12 * Adds XML support for serializer.
Chris@0 13 *
Chris@0 14 * This acts as a wrapper class for Symfony's XmlEncoder so that it is not
Chris@0 15 * implementing NormalizationAwareInterface, and can be normalized externally.
Chris@14 16 *
Chris@14 17 * @internal
Chris@14 18 * This encoder should not be used directly. Rather, use the `serializer`
Chris@14 19 * service.
Chris@0 20 */
Chris@17 21 class XmlEncoder implements SerializerAwareInterface, EncoderInterface, DecoderInterface {
Chris@17 22
Chris@17 23 use SerializerAwareTrait;
Chris@0 24
Chris@0 25 /**
Chris@0 26 * The formats that this Encoder supports.
Chris@0 27 *
Chris@0 28 * @var array
Chris@0 29 */
Chris@18 30 protected static $format = ['xml'];
Chris@0 31
Chris@0 32 /**
Chris@0 33 * An instance of the Symfony XmlEncoder to perform the actual encoding.
Chris@0 34 *
Chris@0 35 * @var \Symfony\Component\Serializer\Encoder\XmlEncoder
Chris@0 36 */
Chris@0 37 protected $baseEncoder;
Chris@0 38
Chris@0 39 /**
Chris@0 40 * Gets the base encoder instance.
Chris@0 41 *
Chris@0 42 * @return \Symfony\Component\Serializer\Encoder\XmlEncoder
Chris@0 43 * The base encoder.
Chris@0 44 */
Chris@0 45 public function getBaseEncoder() {
Chris@0 46 if (!isset($this->baseEncoder)) {
Chris@0 47 $this->baseEncoder = new BaseXmlEncoder();
Chris@0 48 $this->baseEncoder->setSerializer($this->serializer);
Chris@0 49 }
Chris@0 50
Chris@0 51 return $this->baseEncoder;
Chris@0 52 }
Chris@0 53
Chris@0 54 /**
Chris@0 55 * Sets the base encoder instance.
Chris@0 56 *
Chris@0 57 * @param \Symfony\Component\Serializer\Encoder\XmlEncoder $encoder
Chris@0 58 */
Chris@0 59 public function setBaseEncoder($encoder) {
Chris@0 60 $this->baseEncoder = $encoder;
Chris@0 61 }
Chris@0 62
Chris@0 63 /**
Chris@0 64 * {@inheritdoc}
Chris@0 65 */
Chris@12 66 public function encode($data, $format, array $context = []) {
Chris@0 67 return $this->getBaseEncoder()->encode($data, $format, $context);
Chris@0 68 }
Chris@0 69
Chris@0 70 /**
Chris@0 71 * {@inheritdoc}
Chris@0 72 */
Chris@0 73 public function supportsEncoding($format) {
Chris@0 74 return in_array($format, static::$format);
Chris@0 75 }
Chris@0 76
Chris@0 77 /**
Chris@0 78 * {@inheritdoc}
Chris@0 79 */
Chris@12 80 public function decode($data, $format, array $context = []) {
Chris@0 81 return $this->getBaseEncoder()->decode($data, $format, $context);
Chris@0 82 }
Chris@0 83
Chris@0 84 /**
Chris@0 85 * {@inheritdoc}
Chris@0 86 */
Chris@0 87 public function supportsDecoding($format) {
Chris@0 88 return in_array($format, static::$format);
Chris@0 89 }
Chris@0 90
Chris@0 91 }