Merge branch '3.3' into 3.4

nicolas-grekas · nicolas-grekas · commit 6ab0fde00fb0 · 2017-11-05T17:10:10.000+01:00
* 3.3:
  [Serializer] Fix extra attributes when no group specified
  [Intl] Make intl-data tests pass and save language aliases again
  [Console] Fix CommandTester::setInputs() docblock
  [Serializer] readd default argument value
  [VarDumper] fix trailling comma when dumping an exception
  Remove useless docblocks
  [FrameworkBundle] Fix docblocks
  [PropertyInfo] Remove useless docblocks
diff --git a/Encoder/DecoderInterface.php b/Encoder/DecoderInterface.php
@@ -25,7 +25,7 @@ interface DecoderInterface
      *
      * @param string $data    Data to decode
      * @param string $format  Format name
-     * @param array  $context options that decoders have access to
+     * @param array  $context Options that decoders have access to
      *
      * The format parameter specifies which format the data is in; valid values
      * depend on the specific implementation. Authors implementing this interface
@@ -41,7 +41,7 @@ public function decode($data, $format, array $context = array());
     /**
      * Checks whether the deserializer can decode from given format.
      *
-     * @param string $format format name
+     * @param string $format Format name
      *
      * @return bool
      */
diff --git a/Encoder/EncoderInterface.php b/Encoder/EncoderInterface.php
@@ -25,7 +25,7 @@ interface EncoderInterface
      *
      * @param mixed  $data    Data to encode
      * @param string $format  Format name
-     * @param array  $context options that normalizers/encoders have access to
+     * @param array  $context Options that normalizers/encoders have access to
      *
      * @return scalar
      *
@@ -36,7 +36,7 @@ public function encode($data, $format, array $context = array());
     /**
      * Checks whether the serializer can encode to given format.
      *
-     * @param string $format format name
+     * @param string $format Format name
      *
      * @return bool
      */
diff --git a/Encoder/JsonDecode.php b/Encoder/JsonDecode.php
@@ -20,24 +20,12 @@
  */
 class JsonDecode implements DecoderInterface
 {
-    /**
-     * Specifies if the returned result should be an associative array or a nested stdClass object hierarchy.
-     *
-     * @var bool
-     */
-    private $associative;
+    protected $serializer;
 
-    /**
-     * Specifies the recursion depth.
-     *
-     * @var int
-     */
+    private $associative;
     private $recursionDepth;
-
     private $lastError = JSON_ERROR_NONE;
 
-    protected $serializer;
-
     /**
      * Constructs a new JsonDecode instance.
      *
diff --git a/Encoder/JsonEncoder.php b/Encoder/JsonEncoder.php
@@ -20,14 +20,7 @@ class JsonEncoder implements EncoderInterface, DecoderInterface
 {
     const FORMAT = 'json';
 
-    /**
-     * @var JsonEncode
-     */
     protected $encodingImpl;
-
-    /**
-     * @var JsonDecode
-     */
     protected $decodingImpl;
 
     public function __construct(JsonEncode $encodingImpl = null, JsonDecode $decodingImpl = null)
diff --git a/Encoder/XmlEncoder.php b/Encoder/XmlEncoder.php
@@ -159,7 +159,7 @@ public function supportsDecoding($format)
     /**
      * Sets the root node name.
      *
-     * @param string $name root node name
+     * @param string $name Root node name
      */
     public function setRootNodeName($name)
     {
@@ -257,8 +257,6 @@ final protected function isElementNameValid($name)
     /**
      * Parse the input DOMNode into an array or a string.
      *
-     * @param \DOMNode $node xml to parse
-     *
      * @return array|string
      */
     private function parseXml(\DOMNode $node, array $context = array())
@@ -293,8 +291,6 @@ private function parseXml(\DOMNode $node, array $context = array())
     /**
      * Parse the input DOMNode attributes into an array.
      *
-     * @param \DOMNode $node xml to parse
-     *
      * @return array
      */
     private function parseXmlAttributes(\DOMNode $node, array $context = array())
@@ -328,8 +324,6 @@ private function parseXmlAttributes(\DOMNode $node, array $context = array())
     /**
      * Parse the input DOMNode value (content and children) into an array or a string.
      *
-     * @param \DOMNode $node xml to parse
-     *
      * @return array|string
      */
     private function parseXmlValue(\DOMNode $node, array $context = array())
@@ -543,7 +537,7 @@ private function resolveXmlTypeCastAttributes(array $context = array())
     /**
      * Create a DOM document, taking serializer options into account.
      *
-     * @param array $context options that the encoder has access to
+     * @param array $context Options that the encoder has access to
      *
      * @return \DOMDocument
      */
diff --git a/Mapping/Loader/FileLoader.php b/Mapping/Loader/FileLoader.php
@@ -20,9 +20,6 @@
  */
 abstract class FileLoader implements LoaderInterface
 {
-    /**
-     * @var string
-     */
     protected $file;
 
     /**
diff --git a/Mapping/Loader/LoaderChain.php b/Mapping/Loader/LoaderChain.php
@@ -27,9 +27,6 @@
  */
 class LoaderChain implements LoaderInterface
 {
-    /**
-     * @var LoaderInterface[]
-     */
     private $loaders;
 
     /**
diff --git a/NameConverter/CamelCaseToSnakeCaseNameConverter.php b/NameConverter/CamelCaseToSnakeCaseNameConverter.php
@@ -18,14 +18,7 @@
  */
 class CamelCaseToSnakeCaseNameConverter implements NameConverterInterface
 {
-    /**
-     * @var array|null
-     */
     private $attributes;
-
-    /**
-     * @var bool
-     */
     private $lowerCamelCase;
 
     /**
diff --git a/Normalizer/AbstractNormalizer.php b/Normalizer/AbstractNormalizer.php
@@ -33,6 +33,7 @@ abstract class AbstractNormalizer extends SerializerAwareNormalizer implements N
     const OBJECT_TO_POPULATE = 'object_to_populate';
     const GROUPS = 'groups';
     const ATTRIBUTES = 'attributes';
+    const ALLOW_EXTRA_ATTRIBUTES = 'allow_extra_attributes';
 
     /**
      * @var int
@@ -81,7 +82,7 @@ public function __construct(ClassMetadataFactoryInterface $classMetadataFactory
     /**
      * Set circular reference limit.
      *
-     * @param int $circularReferenceLimit limit of iterations for the same object
+     * @param int $circularReferenceLimit Limit of iterations for the same object
      *
      * @return self
      */
@@ -109,7 +110,7 @@ public function setCircularReferenceHandler(callable $circularReferenceHandler)
     /**
      * Set normalization callbacks.
      *
-     * @param callable[] $callbacks help normalize the result
+     * @param callable[] $callbacks Help normalize the result
      *
      * @return self
      *
@@ -203,7 +204,14 @@ protected function handleCircularReference($object)
      */
     protected function getAllowedAttributes($classOrObject, array $context, $attributesAsString = false)
     {
-        if (!$this->classMetadataFactory || !isset($context[static::GROUPS]) || !is_array($context[static::GROUPS])) {
+        if (!$this->classMetadataFactory) {
+            return false;
+        }
+
+        $groups = false;
+        if (isset($context[static::GROUPS]) && is_array($context[static::GROUPS])) {
+            $groups = $context[static::GROUPS];
+        } elseif (!isset($context[static::ALLOW_EXTRA_ATTRIBUTES]) || $context[static::ALLOW_EXTRA_ATTRIBUTES]) {
             return false;
         }
 
@@ -212,7 +220,7 @@ protected function getAllowedAttributes($classOrObject, array $context, $attribu
             $name = $attributeMetadata->getName();
 
             if (
-                count(array_intersect($attributeMetadata->getGroups(), $context[static::GROUPS])) &&
+                (false === $groups || count(array_intersect($attributeMetadata->getGroups(), $groups))) &&
                 $this->isAllowedAttribute($classOrObject, $name, null, $context)
             ) {
                 $allowedAttributes[] = $attributesAsString ? $name : $attributeMetadata;
diff --git a/Normalizer/AbstractObjectNormalizer.php b/Normalizer/AbstractObjectNormalizer.php
@@ -110,7 +110,7 @@ public function normalize($object, $format = null, array $context = array())
      *
      * @return string[]
      */
-    protected function getAttributes($object, $format, array $context)
+    protected function getAttributes($object, $format = null, array $context)
     {
         $class = get_class($object);
         $key = $class.'-'.$context['cache_key'];
diff --git a/Normalizer/DenormalizableInterface.php b/Normalizer/DenormalizableInterface.php
@@ -32,7 +32,7 @@ interface DenormalizableInterface
      * @param array|scalar          $data         The data from which to re-create the object
      * @param string|null           $format       The format is optionally given to be able to denormalize differently
      *                                            based on different input formats
-     * @param array                 $context      options for denormalizing
+     * @param array                 $context      Options for denormalizing
      *
      * @return object
      */
diff --git a/Normalizer/DenormalizerInterface.php b/Normalizer/DenormalizerInterface.php
@@ -28,10 +28,10 @@ interface DenormalizerInterface
     /**
      * Denormalizes data back into an object of the given class.
      *
-     * @param mixed  $data    data to restore
-     * @param string $class   the expected class to instantiate
-     * @param string $format  format the given data was extracted from
-     * @param array  $context options available to the denormalizer
+     * @param mixed  $data    Data to restore
+     * @param string $class   The expected class to instantiate
+     * @param string $format  Format the given data was extracted from
+     * @param array  $context Options available to the denormalizer
      *
      * @return object
      *
diff --git a/Normalizer/NormalizableInterface.php b/Normalizer/NormalizableInterface.php
@@ -27,11 +27,11 @@ interface NormalizableInterface
      * It is important to understand that the normalize() call should normalize
      * recursively all child objects of the implementor.
      *
-     * @param NormalizerInterface $normalizer the normalizer is given so that you
+     * @param NormalizerInterface $normalizer The normalizer is given so that you
      *                                        can use it to normalize objects contained within this object
-     * @param string|null         $format     the format is optionally given to be able to normalize differently
+     * @param string|null         $format     The format is optionally given to be able to normalize differently
      *                                        based on different output formats
-     * @param array               $context    options for normalizing this object
+     * @param array               $context    Options for normalizing this object
      *
      * @return array|scalar
      */
diff --git a/Normalizer/NormalizerInterface.php b/Normalizer/NormalizerInterface.php
@@ -25,8 +25,8 @@ interface NormalizerInterface
     /**
      * Normalizes an object into a set of arrays/scalars.
      *
-     * @param object $object  object to normalize
-     * @param string $format  format the normalization result will be encoded as
+     * @param object $object  Object to normalize
+     * @param string $format  Format the normalization result will be encoded as
      * @param array  $context Context options for the normalizer
      *
      * @return array|scalar
diff --git a/Normalizer/ObjectNormalizer.php b/Normalizer/ObjectNormalizer.php
@@ -26,9 +26,6 @@
  */
 class ObjectNormalizer extends AbstractObjectNormalizer
 {
-    /**
-     * @var PropertyAccessorInterface
-     */
     protected $propertyAccessor;
 
     public function __construct(ClassMetadataFactoryInterface $classMetadataFactory = null, NameConverterInterface $nameConverter = null, PropertyAccessorInterface $propertyAccessor = null, PropertyTypeExtractorInterface $propertyTypeExtractor = null)
diff --git a/Serializer.php b/Serializer.php
@@ -230,9 +230,9 @@ public function supportsDenormalization($data, $type, $format = null/*, array $c
     /**
      * Returns a matching normalizer.
      *
-     * @param mixed  $data    data to get the serializer for
-     * @param string $format  format name, present to give the option to normalizers to act differently based on formats
-     * @param array  $context options available to the normalizer
+     * @param mixed  $data    Data to get the serializer for
+     * @param string $format  Format name, present to give the option to normalizers to act differently based on formats
+     * @param array  $context Options available to the normalizer
      *
      * @return NormalizerInterface|null
      */
@@ -248,10 +248,10 @@ private function getNormalizer($data, $format, array $context)
     /**
      * Returns a matching denormalizer.
      *
-     * @param mixed  $data    data to restore
-     * @param string $class   the expected class to instantiate
-     * @param string $format  format name, present to give the option to normalizers to act differently based on formats
-     * @param array  $context options available to the denormalizer
+     * @param mixed  $data    Data to restore
+     * @param string $class   The expected class to instantiate
+     * @param string $format  Format name, present to give the option to normalizers to act differently based on formats
+     * @param array  $context Options available to the denormalizer
      *
      * @return DenormalizerInterface|null
      */
diff --git a/SerializerInterface.php b/SerializerInterface.php
@@ -21,9 +21,9 @@ interface SerializerInterface
     /**
      * Serializes data in the appropriate format.
      *
-     * @param mixed  $data    any data
-     * @param string $format  format name
-     * @param array  $context options normalizers/encoders have access to
+     * @param mixed  $data    Any data
+     * @param string $format  Format name
+     * @param array  $context Options normalizers/encoders have access to
      *
      * @return string
      */
diff --git a/Tests/Normalizer/AbstractObjectNormalizerTest.php b/Tests/Normalizer/AbstractObjectNormalizerTest.php
@@ -11,7 +11,10 @@
 
 namespace Symfony\Component\Serializer\Tests\Normalizer;
 
+use Doctrine\Common\Annotations\AnnotationReader;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Serializer\Mapping\Factory\ClassMetadataFactory;
+use Symfony\Component\Serializer\Mapping\Loader\AnnotationLoader;
 use Symfony\Component\Serializer\Normalizer\AbstractObjectNormalizer;
 
 class AbstractObjectNormalizerTest extends TestCase
@@ -51,6 +54,21 @@ public function testDenormalizeWithExtraAttributes()
             array('allow_extra_attributes' => false)
         );
     }
+
+    /**
+     * @expectedException \Symfony\Component\Serializer\Exception\ExtraAttributesException
+     * @expectedExceptionMessage Extra attributes are not allowed ("fooFoo", "fooBar" are unknown).
+     */
+    public function testDenormalizeWithExtraAttributesAndNoGroupsWithMetadataFactory()
+    {
+        $normalizer = new AbstractObjectNormalizerWithMetadata();
+        $normalizer->denormalize(
+            array('fooFoo' => 'foo', 'fooBar' => 'bar', 'bar' => 'bar'),
+            Dummy::class,
+            'any',
+            array('allow_extra_attributes' => false)
+        );
+    }
 }
 
 class AbstractObjectNormalizerDummy extends AbstractObjectNormalizer
@@ -85,3 +103,24 @@ class Dummy
     public $bar;
     public $baz;
 }
+
+class AbstractObjectNormalizerWithMetadata extends AbstractObjectNormalizer
+{
+    public function __construct()
+    {
+        parent::__construct(new ClassMetadataFactory(new AnnotationLoader(new AnnotationReader())));
+    }
+
+    protected function extractAttributes($object, $format = null, array $context = array())
+    {
+    }
+
+    protected function getAttributeValue($object, $attribute, $format = null, array $context = array())
+    {
+    }
+
+    protected function setAttributeValue($object, $attribute, $value, $format = null, array $context = array())
+    {
+        $object->$attribute = $value;
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ interface DecoderInterface`
`25`	`25`	`*`
`26`	`26`	`* @param string $data Data to decode`
`27`	`27`	`* @param string $format Format name`
`28`		`- * @param array $context options that decoders have access to`
	`28`	`+ * @param array $context Options that decoders have access to`
`29`	`29`	`*`
`30`	`30`	`* The format parameter specifies which format the data is in; valid values`
`31`	`31`	`* depend on the specific implementation. Authors implementing this interface`
`@@ -41,7 +41,7 @@ public function decode($data, $format, array $context = array());`
`41`	`41`	`/**`
`42`	`42`	`* Checks whether the deserializer can decode from given format.`
`43`	`43`	`*`
`44`		`- * @param string $format format name`
	`44`	`+ * @param string $format Format name`
`45`	`45`	`*`
`46`	`46`	`* @return bool`
`47`	`47`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ interface EncoderInterface`
`25`	`25`	`*`
`26`	`26`	`* @param mixed $data Data to encode`
`27`	`27`	`* @param string $format Format name`
`28`		`- * @param array $context options that normalizers/encoders have access to`
	`28`	`+ * @param array $context Options that normalizers/encoders have access to`
`29`	`29`	`*`
`30`	`30`	`* @return scalar`
`31`	`31`	`*`
`@@ -36,7 +36,7 @@ public function encode($data, $format, array $context = array());`
`36`	`36`	`/**`
`37`	`37`	`* Checks whether the serializer can encode to given format.`
`38`	`38`	`*`
`39`		`- * @param string $format format name`
	`39`	`+ * @param string $format Format name`
`40`	`40`	`*`
`41`	`41`	`* @return bool`
`42`	`42`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,6 @@`
`20`	`20`	`*/`
`21`	`21`	`abstract class FileLoader implements LoaderInterface`
`22`	`22`	`{`
`23`		`- /**`
`24`		`- * @var string`
`25`		`- */`
`26`	`23`	`protected $file;`
`27`	`24`
`28`	`25`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -27,9 +27,6 @@`
`27`	`27`	`*/`
`28`	`28`	`class LoaderChain implements LoaderInterface`
`29`	`29`	`{`
`30`		`- /**`
`31`		`- * @var LoaderInterface[]`
`32`		`- */`
`33`	`30`	`private $loaders;`
`34`	`31`
`35`	`32`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ public function normalize($object, $format = null, array $context = array())`
`110`	`110`	`*`
`111`	`111`	`* @return string[]`
`112`	`112`	`*/`
`113`		`- protected function getAttributes($object, $format, array $context)`
	`113`	`+ protected function getAttributes($object, $format = null, array $context)`
`114`	`114`	`{`
`115`	`115`	`$class = get_class($object);`
`116`	`116`	`$key = $class.'-'.$context['cache_key'];`