Skip to content

[OptionsResolver] Documenting Options argument for closure deprecation func #10439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 12, 2018
Merged

[OptionsResolver] Documenting Options argument for closure deprecation func #10439

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion components/options_resolver.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 '';
})
;
Expand Down