Deprecation based on the value must be triggered once

yceruto · yceruto · commit c19026d13633 · 2018-10-15T13:16:35.000-04:00
diff --git a/src/Symfony/Component/OptionsResolver/OptionsResolver.php b/src/Symfony/Component/OptionsResolver/OptionsResolver.php
@@ -798,7 +798,7 @@ public function offsetGet($option)
 
         // Shortcut for resolved options
         if (array_key_exists($option, $this->resolved)) {
-            if (isset($this->deprecated[$option])) {
+            if (isset($this->deprecated[$option]) && '' !== $this->deprecated[$option]) {
                 @trigger_error(strtr($this->deprecated[$option], array('%name%' => $option)), E_USER_DEPRECATED);
             }
 
@@ -948,14 +948,14 @@ public function offsetGet($option)
                 } finally {
                     unset($this->calling[$option]);
                 }
+
+                // Deprecation based on the value must be triggered once
+                $this->deprecated[$option] = '';
             }
 
             if ('' !== $deprecationMessage) {
                 @trigger_error(strtr($deprecationMessage, array('%name%' => $option)), E_USER_DEPRECATED);
             }
-
-            // Store result for next calls
-            $this->deprecated[$option] = $deprecationMessage ?: null;
         }
 
         // Normalize the validated option
diff --git a/src/Symfony/Component/OptionsResolver/Tests/OptionsResolverTest.php b/src/Symfony/Component/OptionsResolver/Tests/OptionsResolverTest.php
@@ -651,6 +651,31 @@ function (OptionsResolver $resolver) {
             1,
         );
 
+        yield 'It trigger deprecation based on the value once' => array(
+            function (OptionsResolver $resolver) {
+                $resolver
+                    ->setDefined('foo')
+                    ->setAllowedTypes('foo', array('null', 'bool'))
+                    ->setDeprecated('foo', function (Options $options, $value) {
+                        if (!\is_bool($value)) {
+                            return 'Passing a value different than true or false is deprecated.';
+                        }
+
+                        return '';
+                    })
+                    ->setDefault('bar', function (Options $options) {
+                        return $options['foo'];
+                    })
+                ;
+            },
+            array('foo' => null),
+            array(
+                'type' => E_USER_DEPRECATED,
+                'message' => 'Passing a value different than true or false is deprecated.',
+            ),
+            1,
+        );
+
         yield 'It ignores deprecation for missing option without default value' => array(
             function (OptionsResolver $resolver) {
                 $resolver

Original file line number	Diff line number	Diff line change
`@@ -798,7 +798,7 @@ public function offsetGet($option)`
`798`	`798`
`799`	`799`	`// Shortcut for resolved options`
`800`	`800`	`if (array_key_exists($option, $this->resolved)) {`
`801`		`- if (isset($this->deprecated[$option])) {`
	`801`	`+ if (isset($this->deprecated[$option]) && '' !== $this->deprecated[$option]) {`
`802`	`802`	`@trigger_error(strtr($this->deprecated[$option], array('%name%' => $option)), E_USER_DEPRECATED);`
`803`	`803`	`}`
`804`	`804`
`@@ -948,14 +948,14 @@ public function offsetGet($option)`
`948`	`948`	`} finally {`
`949`	`949`	`unset($this->calling[$option]);`
`950`	`950`	`}`
	`951`	`+`
	`952`	`+ // Deprecation based on the value must be triggered once`
	`953`	`+ $this->deprecated[$option] = '';`
`951`	`954`	`}`
`952`	`955`
`953`	`956`	`if ('' !== $deprecationMessage) {`
`954`	`957`	`@trigger_error(strtr($deprecationMessage, array('%name%' => $option)), E_USER_DEPRECATED);`
`955`	`958`	`}`
`956`		`-`
`957`		`- // Store result for next calls`
`958`		`- $this->deprecated[$option] = $deprecationMessage ?: null;`
`959`	`959`	`}`
`960`	`960`
`961`	`961`	`// Normalize the validated option`