bug #17984 Allow to normalize \Traversable when serializing xml (Ener-Getick)

fabpot · fabpot · commit 9a5ea71c2204 · 2016-03-04T08:19:22.000+01:00
This PR was merged into the 2.3 branch. Discussion ---------- Allow to normalize \Traversable when serializing xml | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | no | Fixed tickets | | License | MIT It's impossible to normalize an object implementing ``\Traversable`` when using the ``XMLEncoder``. For example we can't customize the serializer output when serializing a ``FormInterface`` instance. So my proposition is to fix this by using the default XML encoder output only when the serializer can't normalize the data. Commits ------- 97c5d27 Allow to normalize \Traversable
diff --git a/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php b/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php
@@ -305,7 +305,7 @@ private function buildXml(\DOMElement $parentNode, $data, $xmlRootNodeName = nul
     {
         $append = true;
 
-        if (is_array($data) || $data instanceof \Traversable) {
+        if (is_array($data) || ($data instanceof \Traversable && !$this->serializer->supportsNormalization($data, $this->format))) {
             foreach ($data as $key => $data) {
                 //Ah this is the magic @ attribute types.
                 if (0 === strpos($key, '@') && is_scalar($data) && $this->isElementNameValid($attributeName = substr($key, 1))) {
diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Serializer\Tests\Encoder;
 
 use Symfony\Component\Serializer\Tests\Fixtures\Dummy;
+use Symfony\Component\Serializer\Tests\Fixtures\NormalizableTraversableDummy;
 use Symfony\Component\Serializer\Tests\Fixtures\ScalarDummy;
 use Symfony\Component\Serializer\Encoder\XmlEncoder;
 use Symfony\Component\Serializer\Serializer;
@@ -203,6 +204,21 @@ public function testEncodeSerializerXmlRootNodeNameOption()
         $this->assertEquals($expected, $serializer->serialize($array, 'xml', $options));
     }
 
+    public function testEncodeTraversableWhenNormalizable() {
+        $this->encoder = new XmlEncoder();
+        $serializer = new Serializer(array(new CustomNormalizer()), array('xml' => new XmlEncoder()));
+        $this->encoder->setSerializer($serializer);
+
+        $expected = <<<XML
+<?xml version="1.0"?>
+<response><foo>normalizedFoo</foo><bar>normalizedBar</bar></response>
+
+XML;
+
+        $this->assertEquals($expected, $serializer->serialize(new NormalizableTraversableDummy(), 'xml'));
+
+    }
+
     public function testDecode()
     {
         $source = $this->getXmlSource();

Original file line number	Diff line number	Diff line change
`@@ -305,7 +305,7 @@ private function buildXml(\DOMElement $parentNode, $data, $xmlRootNodeName = nul`
`305`	`305`	`{`
`306`	`306`	`$append = true;`
`307`	`307`
`308`		`- if (is_array($data) \|\| $data instanceof \Traversable) {`
	`308`	`+ if (is_array($data) \|\| ($data instanceof \Traversable && !$this->serializer->supportsNormalization($data, $this->format))) {`
`309`	`309`	`foreach ($data as $key => $data) {`
`310`	`310`	`//Ah this is the magic @ attribute types.`
`311`	`311`	`if (0 === strpos($key, '@') && is_scalar($data) && $this->isElementNameValid($attributeName = substr($key, 1))) {`