feature #20524 [Serializer][XmlEncoder] Allow removing empty tags in generated XML (amoiraud)

dunglas · dunglas · commit 4644ee91e871 · 2016-12-06T13:59:23.000+01:00
This PR was squashed before being merged into the 3.3-dev branch (closes #20524). Discussion ---------- [Serializer][XmlEncoder] Allow removing empty tags in generated XML | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #20398 | License | MIT | Doc PR | ~ Allow a new option in $context of XmlEncoder.php to remove empty tags if $context['remove_empty_tags'] setted to true, changing this : ```xml <node> <subnode>Value</subnode> <emptysubnode/> </node> ``` To this : ```xml <node> <subnode>Value</subnode> </node> ``` Commits ------- 0cb4d8e [Serializer][XmlEncoder] Allow removing empty tags in generated XML
diff --git a/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php b/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php
@@ -392,7 +392,7 @@ private function buildXml(\DOMNode $parentNode, $data, $xmlRootNodeName = null)
                     }
                 } elseif (is_numeric($key) || !$this->isElementNameValid($key)) {
                     $append = $this->appendNode($parentNode, $data, 'item', $key);
-                } else {
+                } elseif (null !== $data || !isset($this->context['remove_empty_tags']) || false === $this->context['remove_empty_tags']) {
                     $append = $this->appendNode($parentNode, $data, $key);
                 }
             }
diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php
@@ -138,6 +138,28 @@ public function testEncodeXmlAttributes()
         $this->assertSame($expected, $this->encoder->encode($array, 'xml', $context));
     }
 
+    public function testEncodeRemovingEmptyTags()
+    {
+        $array = array('person' => array('firstname' => 'Peter', 'lastname' => null));
+
+        $expected = '<?xml version="1.0"?>'."\n".
+            '<response><person><firstname>Peter</firstname></person></response>'."\n";
+
+        $context = array('remove_empty_tags' => true);
+
+        $this->assertSame($expected, $this->encoder->encode($array, 'xml', $context));
+    }
+
+    public function testEncodeNotRemovingEmptyTags()
+    {
+        $array = array('person' => array('firstname' => 'Peter', 'lastname' => null));
+
+        $expected = '<?xml version="1.0"?>'."\n".
+            '<response><person><firstname>Peter</firstname><lastname/></person></response>'."\n";
+
+        $this->assertSame($expected, $this->encoder->encode($array, 'xml'));
+    }
+
     public function testContext()
     {
         $array = array('person' => array('name' => 'George Abitbol'));

Original file line number	Diff line number	Diff line change
`@@ -392,7 +392,7 @@ private function buildXml(\DOMNode $parentNode, $data, $xmlRootNodeName = null)`
`392`	`392`	`}`
`393`	`393`	`} elseif (is_numeric($key) \|\| !$this->isElementNameValid($key)) {`
`394`	`394`	`$append = $this->appendNode($parentNode, $data, 'item', $key);`
`395`		`- } else {`
	`395`	`+ } elseif (null !== $data \|\| !isset($this->context['remove_empty_tags']) \|\| false === $this->context['remove_empty_tags']) {`
`396`	`396`	`$append = $this->appendNode($parentNode, $data, $key);`
`397`	`397`	`}`
`398`	`398`	`}`