minor #10439 [OptionsResolver] Documenting Options argument for closure deprecation func (yceruto)

javiereguiluz · javiereguiluz · commit 82980e157c64 · 2018-10-12T09:33:20.000+02:00
This PR was merged into the master branch. Discussion ---------- [OptionsResolver] Documenting Options argument for closure deprecation func See symfony/symfony#28738 Commits ------- abb5189 Documenting Options argument for closure deprecation func
diff --git a/components/options_resolver.rst b/components/options_resolver.rst
@@ -660,13 +660,19 @@ This closure is useful to only deprecate some of the allowed types or values of
 the option::
 
     $resolver
+        ->setDefault('encryption', null)
         ->setDefault('port', null)
         ->setAllowedTypes('port', array('null', 'int'))
-        ->setDeprecated('port', function ($value) {
+        ->setDeprecated('port', function (Options $options, $value) {
             if (null === $value) {
                 return 'Passing "null" to option "port" is deprecated, pass an integer instead.';
             }
 
+            // deprecation may also depend on another option
+            if ('ssl' === $options['encryption'] && 456 !== $value) {
+                return 'Passing a different port than "456" when the "encryption" option is set to "ssl" is deprecated.';
+            }
+
             return '';
         })
     ;
