[Serializer] add a contruct key to return always as collection for XmlEncoder

Amrouche Hamza · Amrouche Hamza · commit 658fb0ee9bed · 2017-12-09T09:00:20.000+01:00
diff --git a/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php b/src/Symfony/Component/Serializer/Encoder/XmlEncoder.php
@@ -37,17 +37,18 @@ class XmlEncoder implements EncoderInterface, DecoderInterface, NormalizationAwa
     private $context;
     private $rootNodeName = 'response';
     private $loadOptions;
+    private $alwaysCollection;
 
     /**
      * Construct new XmlEncoder and allow to change the root node element name.
      *
-     * @param string   $rootNodeName
-     * @param int|null $loadOptions  A bit field of LIBXML_* constants
+     * @param int|null $loadOptions A bit field of LIBXML_* constants
      */
-    public function __construct(string $rootNodeName = 'response', int $loadOptions = null)
+    public function __construct(string $rootNodeName = 'response', int $loadOptions = null, bool $alwaysCollection = false)
     {
         $this->rootNodeName = $rootNodeName;
         $this->loadOptions = null !== $loadOptions ? $loadOptions : LIBXML_NONET | LIBXML_NOBLANKS;
+        $this->alwaysCollection = $alwaysCollection;
     }
 
     /**
@@ -335,7 +336,7 @@ private function parseXmlValue(\DOMNode $node, array $context = array())
         }
 
         foreach ($value as $key => $val) {
-            if (is_array($val) && 1 === count($val)) {
+            if (is_array($val) && 1 === count($val) && (!$this->alwaysCollection || !is_array($val[0]))) {
                 $value[$key] = current($val);
             }
         }
diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php
@@ -515,6 +515,33 @@ public function testDecodeIgnoreWhiteSpace()
         $this->assertEquals($expected, $this->encoder->decode($source, 'xml'));
     }
 
+    public function testDecodeAlwaysAsCollection()
+    {
+        $this->encoder = new XmlEncoder('response', null, true);
+        $serializer = new Serializer(array(new CustomNormalizer()), array('xml' => new XmlEncoder()));
+        $this->encoder->setSerializer($serializer);
+
+        $source = <<<'XML'
+<?xml version="1.0"?>
+<order_rows nodeType="order_row" virtualEntity="true">
+    <order_row>
+        <id><![CDATA[16]]></id>
+        <test><![CDATA[16]]></test>
+    </order_row>
+</order_rows>
+XML;
+        $expected = array(
+            '@nodeType' => 'order_row',
+            '@virtualEntity' => 'true',
+            'order_row' => array(array(
+                'id' => 16,
+                'test' => 16,
+            )),
+        );
+
+        $this->assertEquals($expected, $this->encoder->decode($source, 'xml'));
+    }
+
     public function testDecodeWithoutItemHash()
     {
         $obj = new ScalarDummy();

Original file line number	Diff line number	Diff line change
`@@ -37,17 +37,18 @@ class XmlEncoder implements EncoderInterface, DecoderInterface, NormalizationAwa`
`37`	`37`	`private $context;`
`38`	`38`	`private $rootNodeName = 'response';`
`39`	`39`	`private $loadOptions;`
	`40`	`+ private $alwaysCollection;`
`40`	`41`
`41`	`42`	`/**`
`42`	`43`	`* Construct new XmlEncoder and allow to change the root node element name.`
`43`	`44`	`*`
`44`		`- * @param string $rootNodeName`
`45`		`- * @param int\|null $loadOptions A bit field of LIBXML_* constants`
	`45`	`+ * @param int\|null $loadOptions A bit field of LIBXML_* constants`
`46`	`46`	`*/`
`47`		`- public function __construct(string $rootNodeName = 'response', int $loadOptions = null)`
	`47`	`+ public function __construct(string $rootNodeName = 'response', int $loadOptions = null, bool $alwaysCollection = false)`
`48`	`48`	`{`
`49`	`49`	`$this->rootNodeName = $rootNodeName;`
`50`	`50`	`$this->loadOptions = null !== $loadOptions ? $loadOptions : LIBXML_NONET \| LIBXML_NOBLANKS;`
	`51`	`+ $this->alwaysCollection = $alwaysCollection;`
`51`	`52`	`}`
`52`	`53`
`53`	`54`	`/**`
`@@ -335,7 +336,7 @@ private function parseXmlValue(\DOMNode $node, array $context = array())`
`335`	`336`	`}`
`336`	`337`
`337`	`338`	`foreach ($value as $key => $val) {`
`338`		`- if (is_array($val) && 1 === count($val)) {`
	`339`	`+ if (is_array($val) && 1 === count($val) && (!$this->alwaysCollection \|\| !is_array($val[0]))) {`
`339`	`340`	`$value[$key] = current($val);`
`340`	`341`	`}`
`341`	`342`	`}`