Explicitly ignores a depreciation (useful for BC layer)

yceruto · yceruto · commit c47fd5f82e39 · 2018-10-21T18:36:06.000-04:00
diff --git a/src/Symfony/Component/OptionsResolver/Options.php b/src/Symfony/Component/OptionsResolver/Options.php
@@ -16,6 +16,8 @@
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
  * @author Tobias Schultze <http://tobion.de>
+ *
+ * @method mixed offsetGet(string $option, bool $triggerDeprecation = true)
  */
 interface Options extends \ArrayAccess, \Countable
 {
diff --git a/src/Symfony/Component/OptionsResolver/OptionsResolver.php b/src/Symfony/Component/OptionsResolver/OptionsResolver.php
@@ -790,15 +790,17 @@ public function resolve(array $options = array())
      * @throws OptionDefinitionException If there is a cyclic dependency between
      *                                   lazy options and/or normalizers
      */
-    public function offsetGet($option)
+    public function offsetGet($option/*, bool $triggerDeprecation = true*/)
     {
         if (!$this->locked) {
             throw new AccessException('Array access is only supported within closures of lazy options and normalizers.');
         }
 
+        $triggerDeprecation = 1 === \func_num_args() || \func_get_arg(1);
+
         // Shortcut for resolved options
         if (array_key_exists($option, $this->resolved)) {
-            if (isset($this->deprecated[$option]) && \is_string($this->deprecated[$option])) {
+            if ($triggerDeprecation && isset($this->deprecated[$option]) && \is_string($this->deprecated[$option])) {
                 @trigger_error(strtr($this->deprecated[$option], array('%name%' => $option)), E_USER_DEPRECATED);
             }
 
@@ -931,7 +933,7 @@ public function offsetGet($option)
 
         // Check whether the option is deprecated
         // and it is provided by the user or is being called from a lazy evaluation
-        if (isset($this->deprecated[$option]) && (isset($this->given[$option]) || $this->calling)) {
+        if ($triggerDeprecation && isset($this->deprecated[$option]) && (isset($this->given[$option]) || $this->calling)) {
             $deprecationMessage = $this->deprecated[$option];
 
             if ($deprecationMessage instanceof \Closure) {
diff --git a/src/Symfony/Component/OptionsResolver/Tests/OptionsResolverTest.php b/src/Symfony/Component/OptionsResolver/Tests/OptionsResolverTest.php
@@ -750,6 +750,21 @@ function (OptionsResolver $resolver) {
             null,
             0,
         );
+
+        yield 'It explicitly ignores a depreciation.' => array(
+            function (OptionsResolver $resolver) {
+                $resolver
+                    ->setDefault('foo', null)
+                    ->setDeprecated('foo')
+                    ->setDefault('bar', function (Options $options) {
+                        return $options->offsetGet('foo', false);
+                    })
+                ;
+            },
+            array(),
+            null,
+            0,
+        );
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@`
`16`	`16`	`*`
`17`	`17`	`* @author Bernhard Schussek <[email protected]>`
`18`	`18`	`* @author Tobias Schultze <http://tobion.de>`
	`19`	`+ *`
	`20`	`+ * @method mixed offsetGet(string $option, bool $triggerDeprecation = true)`
`19`	`21`	`*/`
`20`	`22`	`interface Options extends \ArrayAccess, \Countable`
`21`	`23`	`{`