feature #31030 [Serializer] Deprecate calling createChildContext without the format parameter (dbu)

fabpot · fabpot · commit c5772ae9bc3d · 2019-05-15T11:58:17.000+02:00
This PR was submitted for the master branch but it was merged into the 4.3 branch instead (closes #31030). Discussion ---------- [Serializer] Deprecate calling createChildContext without the format parameter | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - as discussed in #30907 deprecate omitting the format parameter when extending the AbstractNormalizer. Commits ------- cb77902 deprecate calling createChildContext without the format parameter
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractNormalizer.php
@@ -555,8 +555,12 @@ protected function denormalizeParameter(\ReflectionClass $class, \ReflectionPara
      *
      * @internal
      */
-    protected function createChildContext(array $parentContext, $attribute/*, string $format = null */)
+    protected function createChildContext(array $parentContext, $attribute/*, ?string $format */)
     {
+        if (\func_num_args() < 3) {
+            @trigger_error(sprintf('Method "%s::%s()" will have a third "?string $format" argument in version 5.0; not defining it is deprecated since Symfony 4.3.', \get_class($this), __FUNCTION__), E_USER_DEPRECATED);
+            $format = null;
+        }
         if (isset($parentContext[self::ATTRIBUTES][$attribute])) {
             $parentContext[self::ATTRIBUTES] = $parentContext[self::ATTRIBUTES][$attribute];
         } else {
diff --git a/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php b/src/Symfony/Component/Serializer/Normalizer/AbstractObjectNormalizer.php
@@ -559,18 +559,19 @@ private function isMaxDepthReached(array $attributesMetadata, string $class, str
      * We must not mix up the attribute cache between parent and children.
      *
      * {@inheritdoc}
+     *
+     * @param string|null $format
      */
-    protected function createChildContext(array $parentContext, $attribute/*, string $format = null */)
+    protected function createChildContext(array $parentContext, $attribute/*, ?string $format */)
     {
         if (\func_num_args() >= 3) {
             $format = \func_get_arg(2);
         } else {
-            // will be deprecated in version 4
+            @trigger_error(sprintf('Method "%s::%s()" will have a third "?string $format" argument in version 5.0; not defining it is deprecated since Symfony 4.3.', \get_class($this), __FUNCTION__), E_USER_DEPRECATED);
             $format = null;
         }
 
         $context = parent::createChildContext($parentContext, $attribute, $format);
-        // format is already included in the cache_key of the parent.
         $context['cache_key'] = $this->getCacheKey($format, $context);
 
         return $context;

Original file line number	Diff line number	Diff line change
`@@ -555,8 +555,12 @@ protected function denormalizeParameter(\ReflectionClass $class, \ReflectionPara`
`555`	`555`	`*`
`556`	`556`	`* @internal`
`557`	`557`	`*/`
`558`		`- protected function createChildContext(array $parentContext, $attribute/, string $format = null /)`
	`558`	`+ protected function createChildContext(array $parentContext, $attribute/, ?string $format /)`
`559`	`559`	`{`
	`560`	`+ if (\func_num_args() < 3) {`
	`561`	`+ @trigger_error(sprintf('Method "%s::%s()" will have a third "?string $format" argument in version 5.0; not defining it is deprecated since Symfony 4.3.', \get_class($this), __FUNCTION__), E_USER_DEPRECATED);`
	`562`	`+ $format = null;`
	`563`	`+ }`
`560`	`564`	`if (isset($parentContext[self::ATTRIBUTES][$attribute])) {`
`561`	`565`	`$parentContext[self::ATTRIBUTES] = $parentContext[self::ATTRIBUTES][$attribute];`
`562`	`566`	`} else {`