[Serializer] add a context key to return always as collection for XmlEncoder #25369

Simperfit · 2017-12-07T07:58:30Z

Q	A
Branch?	4.1
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#25227
License	MIT
Doc PR

This PR add a new as_collection context key in order to return always as a collection instead of returning a single elements when there are only one array.

there are only one PR for the CsvEncoder don't wanted to have only One PR containing the two changes. It feel better to have two PR that fix the behaviour on two different things. it's easy to review and to revert if it break something (which should not since we are testing the behaviour).

Simperfit · 2017-12-07T09:12:27Z

Travis failure is unrelated.

nicolas-grekas · 2017-12-08T14:23:00Z

src/Symfony/Component/Serializer/Encoder/XmlEncoder.php


    /**
     * 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
     */
-    public function __construct(string $rootNodeName = 'response', int $loadOptions = null)
+    public function __construct(string $rootNodeName = 'response', int $loadOptions = null/*, bool $alwaysCollection = false */)


args can be appended to constructors, no need for the "BC layer"

nicolas-grekas · 2017-12-08T14:23:06Z

src/Symfony/Component/Serializer/Encoder/XmlEncoder.php

@@ -257,7 +262,6 @@ private function parseXml(\DOMNode $node, array $context = array())

        if (1 === count($value) && key($value)) {
            $data[key($value)] = current($value);
-


nicolas-grekas · 2017-12-08T14:23:36Z

src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php

@@ -515,6 +515,39 @@ public function testDecodeIgnoreWhiteSpace()
        $this->assertEquals($expected, $this->encoder->decode($source, 'xml'));
    }

+    /**
+     * @group collection


why adding this?

nicolas-grekas · 2017-12-08T14:24:48Z

src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php

+        $source = <<<'XML'
+<?xml version="1.0"?>
+ <order_rows nodeType="order_row" virtualEntity="true">
+                <order_row>


indentation is strange, is it normal?

nicolas-grekas · 2017-12-08T14:24:56Z

src/Symfony/Component/Serializer/Tests/Encoder/XmlEncoderTest.php

+        );
+
+        $this->assertEquals($expected, $this->encoder->decode($source, 'xml'));
+    }


missing blank line after

Simperfit · 2017-12-09T08:42:07Z

AppVeyor failure is not related.

Simperfit · 2017-12-09T16:02:50Z

Status: Needs Review

fabpot · 2018-01-03T07:52:02Z

src/Symfony/Component/Serializer/Encoder/XmlEncoder.php

     */
-    public function __construct(string $rootNodeName = 'response', int $loadOptions = null)
+    public function __construct(string $rootNodeName = 'response', int $loadOptions = null, bool $alwaysCollection = false)


$forceCollection?

dunglas · 2018-01-11T10:29:05Z

@Simperfit can you rebase to force the CI to run again?

Simperfit · 2018-01-11T11:15:09Z

done @dunglas

Simperfit · 2018-01-26T10:29:29Z

This is ready to be merged.

dunglas · 2018-01-26T14:46:16Z

src/Symfony/Component/Serializer/Encoder/XmlEncoder.php

@@ -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->forceCollection || !is_array($val[0]))) {


After a second thought, wouldn't it be better to allow to change this behavior through the context instead of forcing to register a new instance of the class?

I think it will be easier to use if we don't create a new instance. Ill do the modification on both PRs

Simperfit · 2018-02-02T11:14:40Z

@dunglas it now use a context key.

nicolas-grekas · 2018-02-04T15:48:21Z

src/Symfony/Component/Serializer/Encoder/XmlEncoder.php

        foreach ($value as $key => $val) {
-            if (is_array($val) && 1 === count($val)) {
+            if (is_array($val) && 1 === count($val) && (!(isset($context['forceCollection']) && $context['forceCollection']) || !is_array($val[0]))) {


should use snake_case also I suppose

nicolas-grekas · 2018-02-04T15:48:38Z

src/Symfony/Component/Serializer/Encoder/XmlEncoder.php

@@ -333,9 +332,8 @@ private function parseXmlValue(\DOMNode $node, array $context = array())
                $value[$subnode->nodeName][] = $val;
            }
        }
-


let's keep this line :)

Simperfit · 2018-02-05T09:08:33Z

done @nicolas-grekas

nicolas-grekas · 2018-02-11T16:11:10Z

src/Symfony/Component/Serializer/Encoder/XmlEncoder.php

@@ -41,8 +41,7 @@ class XmlEncoder implements EncoderInterface, DecoderInterface, NormalizationAwa
    /**
     * 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


let's revert this: it's unrelated, and breaks merges

nicolas-grekas · 2018-02-11T16:13:40Z

src/Symfony/Component/Serializer/Encoder/XmlEncoder.php

@@ -335,7 +334,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) && (!(isset($context['as_collection']) && $context['as_collection']) || !is_array($val[0]))) {


using empty() would make the code simpler I suppose
I don't understand the last condition !is_array($val[0]) - it feels unrelated. Is it?

I just looked after it and !is_array($val[0]) makes it possible to return the value directly instead of having two arrays:

$expected = array( '@nodeType' => 'order_row', '@virtualEntity' => 'true', 'order_row' => array(array( 'id' => 16, 'test' => 16, )), );

vs

$expected = array( '@nodeType' => 'order_row', '@virtualEntity' => 'true', 'order_row' => array(array( 'id' => array(16), 'test' => array(16), )), );

Do you mean replacing

is_array($val) && 1 === count($val)

to

!empty($val)

it's not possible

…Encoder

nicolas-grekas

Please update the main description so that people looking at this PR can understand what's going on here.
Please also check if a doc PR should be done.

Simperfit · 2018-02-19T13:20:11Z

@nicolas-grekas done.

dunglas · 2018-02-19T13:49:32Z

Thank you @Simperfit.

…lection for XmlEncoder (Simperfit) This PR was merged into the 4.1-dev branch. Discussion ---------- [Serializer] add a context key to return always as collection for XmlEncoder | Q | A | ------------- | --- | Branch? | 4.1 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no  | Tests pass? | yes | Fixed tickets | #25227 | License | MIT | Doc PR | This PR add a new `as_collection` context key in order to return always as a collection instead of returning a single elements when there are only one array. there are only one PR for the CsvEncoder don't wanted to have only One PR containing the two changes. It feel better to have two PR that fix the behaviour on two different things. it's easy to review and to revert if it break something (which should not since we are testing the behaviour). Commits ------- adb428d [Serializer] add a context key to return always as collection for XmlEncoder

…default value (ogizanagi) This PR was merged into the 4.2-dev branch. Discussion ---------- [Serializer] Deprecate CsvEncoder as_collection false default value | Q | A | ------------- | --- | Branch? | master  | Bug fix? | no | New feature? | no  | BC breaks? | no  | Deprecations? | yes  | Tests pass? | yes  | Fixed tickets | N/A  | License | MIT | Doc PR | N/A As already expressed in #25369 and related issues, this behavior is quite counter-intuitive. It may be fine for write-API with a single document in the body but I think such CSV APIs are way less common than file-based ones, expecting collections. So I think this behavior should be opt-in explicitly in required cases, always dealing with collections by default. This is still an arbitrary decision, but trying to make it based on use-cases and user's experience with CSV. Note: perhaps we could find a better name for this as the semantic of setting `as_collection` to `false` to get the single row directly would not be really obvious. Also, it could throw an exception when getting multiple rows where only one was expected. Commits ------- bce59c8 [Serializer] Deprecate CsvEncoder as_collection false default value

nicolas-grekas added this to the 4.1 milestone Dec 8, 2017

nicolas-grekas requested changes Dec 8, 2017

View reviewed changes

carsonbot added the Status: Needs Work label Dec 8, 2017

Simperfit force-pushed the feature/add-a-constructor-arguement-to-return-xml-alsways-as-collection branch 2 times, most recently from 8dab446 to 658fb0e Compare December 9, 2017 08:00

carsonbot added Status: Needs Review and removed Status: Needs Work labels Dec 9, 2017

Simperfit force-pushed the feature/add-a-constructor-arguement-to-return-xml-alsways-as-collection branch from 658fb0e to a582455 Compare December 14, 2017 07:11

dunglas approved these changes Dec 20, 2017

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels Dec 20, 2017

fabpot reviewed Jan 3, 2018

View reviewed changes

Simperfit force-pushed the feature/add-a-constructor-arguement-to-return-xml-alsways-as-collection branch from a582455 to 6f749bc Compare January 5, 2018 12:07

Simperfit force-pushed the feature/add-a-constructor-arguement-to-return-xml-alsways-as-collection branch from 6f749bc to 7a3d918 Compare January 11, 2018 11:14

dunglas reviewed Jan 26, 2018

View reviewed changes

Simperfit force-pushed the feature/add-a-constructor-arguement-to-return-xml-alsways-as-collection branch 2 times, most recently from 89a4381 to f1daa3f Compare February 2, 2018 11:08

nicolas-grekas reviewed Feb 4, 2018

View reviewed changes

Simperfit force-pushed the feature/add-a-constructor-arguement-to-return-xml-alsways-as-collection branch 2 times, most recently from 8f3a88d to b0daf42 Compare February 5, 2018 09:08

Simperfit force-pushed the feature/add-a-constructor-arguement-to-return-xml-alsways-as-collection branch from b0daf42 to 7c8709e Compare February 5, 2018 09:10

javiereguiluz added the Feature label Feb 7, 2018

nicolas-grekas reviewed Feb 11, 2018

View reviewed changes

Simperfit force-pushed the feature/add-a-constructor-arguement-to-return-xml-alsways-as-collection branch from 7c8709e to 5319a86 Compare February 16, 2018 08:54

[Serializer] add a context key to return always as collection for Xml…

adb428d

…Encoder

Simperfit force-pushed the feature/add-a-constructor-arguement-to-return-xml-alsways-as-collection branch from 5319a86 to adb428d Compare February 16, 2018 09:06

nicolas-grekas approved these changes Feb 19, 2018

View reviewed changes

Simperfit changed the title ~~[Serializer] add a contruct key to return always as collection for XmlEncoder~~ [Serializer] add a context key to return always as collection for XmlEncoder Feb 19, 2018

dunglas merged commit adb428d into symfony:master Feb 19, 2018

javiereguiluz mentioned this pull request Mar 2, 2018

[Serializer] add a context key to return always as collection for XmlEncoder symfony/symfony-docs#9384

Closed

fabpot mentioned this pull request May 7, 2018

Release v4.1.0-BETA1 #27181

Merged

ogizanagi mentioned this pull request Jun 25, 2018

[Serializer] Deprecate CsvEncoder as_collection false default value #27715

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Serializer] add a context key to return always as collection for XmlEncoder #25369

[Serializer] add a context key to return always as collection for XmlEncoder #25369

Simperfit commented Dec 7, 2017 •

edited by nicolas-grekas

Loading

Simperfit commented Dec 7, 2017

nicolas-grekas Dec 8, 2017

nicolas-grekas Dec 8, 2017

nicolas-grekas Dec 8, 2017

nicolas-grekas Dec 8, 2017

nicolas-grekas Dec 8, 2017

Simperfit Dec 11, 2017

Simperfit commented Dec 9, 2017

Simperfit commented Dec 9, 2017

fabpot Jan 3, 2018

dunglas commented Jan 11, 2018

Simperfit commented Jan 11, 2018

Simperfit commented Jan 26, 2018

dunglas Jan 26, 2018

Simperfit Jan 26, 2018

Simperfit commented Feb 2, 2018

nicolas-grekas Feb 4, 2018

nicolas-grekas Feb 4, 2018

Simperfit commented Feb 5, 2018

nicolas-grekas Feb 11, 2018

nicolas-grekas Feb 11, 2018

Simperfit Feb 16, 2018 •

edited

Loading

nicolas-grekas left a comment

Simperfit commented Feb 19, 2018

dunglas commented Feb 19, 2018

		@@ -257,7 +262,6 @@ private function parseXml(\DOMNode $node, array $context = array())

		if (1 === count($value) && key($value)) {
		$data[key($value)] = current($value);

[Serializer] add a context key to return always as collection for XmlEncoder #25369

[Serializer] add a context key to return always as collection for XmlEncoder #25369

Conversation

Simperfit commented Dec 7, 2017 • edited by nicolas-grekas Loading

Simperfit commented Dec 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Simperfit commented Dec 9, 2017

Simperfit commented Dec 9, 2017

Choose a reason for hiding this comment

dunglas commented Jan 11, 2018

Simperfit commented Jan 11, 2018

Simperfit commented Jan 26, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Simperfit commented Feb 2, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Simperfit commented Feb 5, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Simperfit Feb 16, 2018 • edited Loading

Choose a reason for hiding this comment

nicolas-grekas left a comment

Choose a reason for hiding this comment

Simperfit commented Feb 19, 2018

dunglas commented Feb 19, 2018

Simperfit commented Dec 7, 2017 •

edited by nicolas-grekas

Loading

Simperfit Feb 16, 2018 •

edited

Loading