minor #22555 [Serializer] Add missing normalizer options constants (ogizanagi)

fabpot · fabpot · commit 5863e4b6a1fa · 2017-04-29T08:51:18.000-07:00
This PR was merged into the 3.3-dev branch. Discussion ---------- [Serializer] Add missing normalizer options constants | Q | A | ------------- | --- | Branch? | master (3.3) | Bug fix? | not really | New feature? | yesish, but for 3.3 as those options were added on this branch and not released yet | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #22537 (comment) | License | MIT | Doc PR | N/A As seen in #22537 (comment). @dunglas : I'm not sure about the exposing the `key_type` option as a constant in `ArrayDenormalizer`/`AbstractObjectNormalizer`, as it looks more or less like a detail of the AbstractObjectNormalizer implementation, but anyway it should be in 3.2 if we add it, so I haven't included it here. However, I wonder if this option shouldn't directly accept a string too, rather than just a `Symfony\Component\PropertyInfo\Type` instance if we want to consider this option "public"? Commits ------- b0c414f [Serializer] Add missing normalizer options constants
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php
@@ -30,6 +30,7 @@ abstract class AbstractNormalizer extends SerializerAwareNormalizer implements N
     const CIRCULAR_REFERENCE_LIMIT = 'circular_reference_limit';
     const OBJECT_TO_POPULATE = 'object_to_populate';
     const GROUPS = 'groups';
+    const ATTRIBUTES = 'attributes';
 
     /**
      * @var int
@@ -240,13 +241,13 @@ protected function isAllowedAttribute($classOrObject, $attribute, $format = null
             return false;
         }
 
-        if (isset($context['attributes'][$attribute])) {
+        if (isset($context[self::ATTRIBUTES][$attribute])) {
             // Nested attributes
             return true;
         }
 
-        if (isset($context['attributes']) && is_array($context['attributes'])) {
-            return in_array($attribute, $context['attributes'], true);
+        if (isset($context[self::ATTRIBUTES]) && is_array($context[self::ATTRIBUTES])) {
+            return in_array($attribute, $context[self::ATTRIBUTES], true);
         }
 
         return true;
@@ -396,8 +397,8 @@ protected function instantiateObject(array &$data, $class, array &$context, \Ref
      */
     protected function createChildContext(array $parentContext, $attribute)
     {
-        if (isset($parentContext['attributes'][$attribute])) {
-            $parentContext['attributes'] = $parentContext['attributes'][$attribute];
+        if (isset($parentContext[self::ATTRIBUTES][$attribute])) {
+            $parentContext[self::ATTRIBUTES] = $parentContext[self::ATTRIBUTES][$attribute];
         }
 
         return $parentContext;
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php
@@ -32,6 +32,7 @@ abstract class AbstractObjectNormalizer extends AbstractNormalizer
 {
     const ENABLE_MAX_DEPTH = 'enable_max_depth';
     const DEPTH_KEY_PATTERN = 'depth_%s::%s';
+    const ALLOW_EXTRA_ATTRIBUTES = 'allow_extra_attributes';
 
     private $propertyTypeExtractor;
     private $attributesCache = array();
@@ -189,7 +190,7 @@ public function denormalize($data, $class, $format = null, array $context = arra
             }
 
             if (($allowedAttributes !== false && !in_array($attribute, $allowedAttributes)) || !$this->isAllowedAttribute($class, $attribute, $format, $context)) {
-                if (isset($context['allow_extra_attributes']) && !$context['allow_extra_attributes']) {
+                if (isset($context[self::ALLOW_EXTRA_ATTRIBUTES]) && !$context[self::ALLOW_EXTRA_ATTRIBUTES]) {
                     $extraAttributes[] = $attribute;
                 }
 

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ abstract class AbstractNormalizer extends SerializerAwareNormalizer implements N`
`30`	`30`	`const CIRCULAR_REFERENCE_LIMIT = 'circular_reference_limit';`
`31`	`31`	`const OBJECT_TO_POPULATE = 'object_to_populate';`
`32`	`32`	`const GROUPS = 'groups';`
	`33`	`+ const ATTRIBUTES = 'attributes';`
`33`	`34`
`34`	`35`	`/**`
`35`	`36`	`* @var int`
`@@ -240,13 +241,13 @@ protected function isAllowedAttribute($classOrObject, $attribute, $format = null`
`240`	`241`	`return false;`
`241`	`242`	`}`
`242`	`243`
`243`		`- if (isset($context['attributes'][$attribute])) {`
	`244`	`+ if (isset($context[self::ATTRIBUTES][$attribute])) {`
`244`	`245`	`// Nested attributes`
`245`	`246`	`return true;`
`246`	`247`	`}`
`247`	`248`
`248`		`- if (isset($context['attributes']) && is_array($context['attributes'])) {`
`249`		`- return in_array($attribute, $context['attributes'], true);`
	`249`	`+ if (isset($context[self::ATTRIBUTES]) && is_array($context[self::ATTRIBUTES])) {`
	`250`	`+ return in_array($attribute, $context[self::ATTRIBUTES], true);`
`250`	`251`	`}`
`251`	`252`
`252`	`253`	`return true;`
`@@ -396,8 +397,8 @@ protected function instantiateObject(array &$data, $class, array &$context, \Ref`
`396`	`397`	`*/`
`397`	`398`	`protected function createChildContext(array $parentContext, $attribute)`
`398`	`399`	`{`
`399`		`- if (isset($parentContext['attributes'][$attribute])) {`
`400`		`- $parentContext['attributes'] = $parentContext['attributes'][$attribute];`
	`400`	`+ if (isset($parentContext[self::ATTRIBUTES][$attribute])) {`
	`401`	`+ $parentContext[self::ATTRIBUTES] = $parentContext[self::ATTRIBUTES][$attribute];`
`401`	`402`	`}`
`402`	`403`
`403`	`404`	`return $parentContext;`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ abstract class AbstractObjectNormalizer extends AbstractNormalizer`
`32`	`32`	`{`
`33`	`33`	`const ENABLE_MAX_DEPTH = 'enable_max_depth';`
`34`	`34`	`const DEPTH_KEY_PATTERN = 'depth_%s::%s';`
	`35`	`+ const ALLOW_EXTRA_ATTRIBUTES = 'allow_extra_attributes';`
`35`	`36`
`36`	`37`	`private $propertyTypeExtractor;`
`37`	`38`	`private $attributesCache = array();`
`@@ -189,7 +190,7 @@ public function denormalize($data, $class, $format = null, array $context = arra`
`189`	`190`	`}`
`190`	`191`
`191`	`192`	`if (($allowedAttributes !== false && !in_array($attribute, $allowedAttributes)) \|\| !$this->isAllowedAttribute($class, $attribute, $format, $context)) {`
`192`		`- if (isset($context['allow_extra_attributes']) && !$context['allow_extra_attributes']) {`
	`193`	`+ if (isset($context[self::ALLOW_EXTRA_ATTRIBUTES]) && !$context[self::ALLOW_EXTRA_ATTRIBUTES]) {`
`193`	`194`	`$extraAttributes[] = $attribute;`
`194`	`195`	`}`
`195`	`196`