Allow to encode xml comments

maidmaid · maidmaid · commit 477df1d55cbe · 2018-08-16T13:28:10.000+02:00
diff --git a/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php b/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php
@@ -20,6 +20,7 @@
  * @author John Wards <jwards@whiteoctober.co.uk>
  * @author Fabian Vogler <fabian@equivalence.ch>
  * @author Kévin Dunglas <dunglas@gmail.com>
+ * @author Dany Maillard <danymaillard93b@gmail.com>
  */
 class XmlEncoder extends SerializerAwareEncoder implements EncoderInterface, DecoderInterface, NormalizationAwareInterface
 {
@@ -235,6 +236,13 @@ final protected function appendDocumentFragment(\DOMNode $node, $fragment)
         return false;
     }
 
+    final protected function appendComment(\DOMNode $node, $data)
+    {
+        $node->appendChild($this->dom->createComment($data));
+
+        return true;
+    }
+
     /**
      * Checks the name is a valid xml element name.
      *
@@ -384,6 +392,8 @@ private function buildXml(\DOMNode $parentNode, $data, $xmlRootNodeName = null)
                     $parentNode->setAttribute($attributeName, $data);
                 } elseif ('#' === $key) {
                     $append = $this->selectNodeType($parentNode, $data);
+                } elseif ('#comment' === $key) {
+                    $append = $this->appendComment($parentNode, $data);
                 } elseif (\is_array($data) && false === is_numeric($key)) {
                     // Is this array fully numeric keys?
                     if (ctype_digit(implode('', array_keys($data)))) {
diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php
@@ -633,6 +633,19 @@ public function testEncodeXmlWithDateTimeObjectField()
         $this->assertEquals($this->createXmlWithDateTimeField(), $actualXml);
     }
 
+    public function testEncodeComment()
+    {
+        $expected = <<<'XML'
+<?xml version="1.0"?>
+<response><!-- foo --></response>
+
+XML;
+
+        $data = array('#comment' => ' foo ');
+
+        $this->assertEquals($expected, $this->encoder->encode($data, 'xml'));
+    }
+
     /**
      * @return XmlEncoder
      */
