feature #28289 [Serializer] Add support for ignoring comments while XML encoding (maidmaid)

fabpot · fabpot · commit 501212b9345e · 2018-08-30T18:33:29.000+02:00
This PR was merged into the 4.2-dev branch. Discussion ---------- [Serializer] Add support for ignoring comments while XML encoding | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | / | License | MIT | Doc PR | / In addition to #27926 which allowed to ignore XML processing instructions, this PR allows to ignore the XML comments while encoding. Commits ------- 8f8230a Add support for ignoring comments while XML encoding
diff --git a/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php b/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php
@@ -378,7 +378,9 @@ private function buildXml(\DOMNode $parentNode, $data, string $xmlRootNodeName =
                 } elseif ('#' === $key) {
                     $append = $this->selectNodeType($parentNode, $data);
                 } elseif ('#comment' === $key) {
-                    $append = $this->appendComment($parentNode, $data);
+                    if (!\in_array(XML_COMMENT_NODE, $this->encoderIgnoredNodeTypes, true)) {
+                        $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
@@ -782,6 +782,21 @@ public function testEncodeWithoutPI()
         $this->assertEquals($expected, $encoder->encode(array(), 'xml'));
     }
 
+    public function testEncodeWithoutComment()
+    {
+        $encoder = new XmlEncoder('response', null, array(), array(XML_COMMENT_NODE));
+
+        $expected = <<<'XML'
+<?xml version="1.0"?>
+<response/>
+
+XML;
+
+        $data = array('#comment' => ' foo ');
+
+        $this->assertEquals($expected, $encoder->encode($data, 'xml'));
+    }
+
     /**
      * @return XmlEncoder
      */
