feature #27503 [Serializer] Allow to pass a single value for the groups opt (dunglas)

nicolas-grekas · nicolas-grekas · commit 80aa8dfcfd2f · 2018-07-01T08:57:58.000+02:00
This PR was merged into the 4.2-dev branch. Discussion ---------- [Serializer] Allow to pass a single value for the groups opt | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | n/a | License | MIT | Doc PR | todo Shortcut syntax similar to #20509 but for the context: allows to pass a string instead of an array of string in the serialization context when only one group if used. Before: ```php $serializer->serialize($foo, 'json', ['groups' => ['myGroup']]; /** @ApiResource(normalizationContext={"groups"={"myGroup"}}) */ ``` After: ```php $serializer->serialize($foo, 'json', ['groups' => 'myGroup']; /** @ApiResource(normalizationContext={"groups"="myGroup") */ ``` Commits ------- 5b39203 [Serializer] Allow to pass a single value for the groups opt
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php
@@ -227,8 +227,8 @@ protected function getAllowedAttributes($classOrObject, array $context, $attribu
         }
 
         $groups = false;
-        if (isset($context[static::GROUPS]) && \is_array($context[static::GROUPS])) {
-            $groups = $context[static::GROUPS];
+        if (isset($context[static::GROUPS]) && (\is_array($context[static::GROUPS]) || is_scalar($context[static::GROUPS]))) {
+            $groups = (array) $context[static::GROUPS];
         } elseif (!isset($context[static::ALLOW_EXTRA_ATTRIBUTES]) || $context[static::ALLOW_EXTRA_ATTRIBUTES]) {
             return false;
         }
diff --git a/src/Symfony/Component/Serializer/Tests/Normalizer/AbstractNormalizerTest.php b/src/Symfony/Component/Serializer/Tests/Normalizer/AbstractNormalizerTest.php
@@ -92,6 +92,9 @@ public function testGetAllowedAttributesAsObjects()
         $result = $this->normalizer->getAllowedAttributes('c', array(AbstractNormalizer::GROUPS => array('test')), false);
         $this->assertEquals(array($a2, $a4), $result);
 
+        $result = $this->normalizer->getAllowedAttributes('c', array(AbstractNormalizer::GROUPS => 'test'), false);
+        $this->assertEquals(array($a2, $a4), $result);
+
         $result = $this->normalizer->getAllowedAttributes('c', array(AbstractNormalizer::GROUPS => array('other')), false);
         $this->assertEquals(array($a3, $a4), $result);
     }

Original file line number	Diff line number	Diff line change
`@@ -227,8 +227,8 @@ protected function getAllowedAttributes($classOrObject, array $context, $attribu`
`227`	`227`	`}`
`228`	`228`
`229`	`229`	`$groups = false;`
`230`		`- if (isset($context[static::GROUPS]) && \is_array($context[static::GROUPS])) {`
`231`		`- $groups = $context[static::GROUPS];`
	`230`	`+ if (isset($context[static::GROUPS]) && (\is_array($context[static::GROUPS]) \|\| is_scalar($context[static::GROUPS]))) {`
	`231`	`+ $groups = (array) $context[static::GROUPS];`
`232`	`232`	`} elseif (!isset($context[static::ALLOW_EXTRA_ATTRIBUTES]) \|\| $context[static::ALLOW_EXTRA_ATTRIBUTES]) {`
`233`	`233`	`return false;`
`234`	`234`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,6 +92,9 @@ public function testGetAllowedAttributesAsObjects()`
`92`	`92`	`$result = $this->normalizer->getAllowedAttributes('c', array(AbstractNormalizer::GROUPS => array('test')), false);`
`93`	`93`	`$this->assertEquals(array($a2, $a4), $result);`
`94`	`94`
	`95`	`+ $result = $this->normalizer->getAllowedAttributes('c', array(AbstractNormalizer::GROUPS => 'test'), false);`
	`96`	`+ $this->assertEquals(array($a2, $a4), $result);`
	`97`	`+`
`95`	`98`	`$result = $this->normalizer->getAllowedAttributes('c', array(AbstractNormalizer::GROUPS => array('other')), false);`
`96`	`99`	`$this->assertEquals(array($a3, $a4), $result);`
`97`	`100`	`}`