8000 [OptionResolver] Document the OptionConfigurator by lmillucci · Pull Request #12426 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

[OptionResolver] Document the OptionConfigurator #12426

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
Feb 19, 2020
+32 −0
Merged

[OptionResolver] Document the OptionConfigurator #12426

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
[OptionResolver] Document the OptionConfigurator
  • Loading branch information
@lmillucci @OskarStark
lmillucci authored and OskarStark committed Feb 19, 2020
commit 921c73f7476126ec40eb39d6f957c5f3df3f55cb
32 changes: 32 additions & 0 deletions components/options_resolver.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -782,6 +782,38 @@ the option::
This closure receives as argument the value of the option after validating it
and before normalizing it when the option is being resolved.

Chaining option configurations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In many cases you may need to define multiple configurations for each option.
For example, suppose the ``Mailer`` class has an ``host`` option that is required
and a ``transport`` option which can be one of ``sendmail``, ``mail`` and ``smtp``.
You can improve the readability of the code avoiding to duplicate option name for
each configuration using the method
:method:`Symfony\\Component\\OptionsResolver\\OptionsResolver::define``::

// ...
class Mailer
{
// ...
public function configureOptions(OptionsResolver $resolver)
{
// ...
$resolver->define('host')
->required()
->default('smtp.example.org')
->allowedTypes('string');
$resolver->define('transport')
->required()
->default('transport')
->allowedValues(['sendmail', 'mail', 'smtp']);
}
}

.. versionadded:: 5.1

The ``define()`` method was introduced in Symfony 5.1.

Performance Tweaks
~~~~~~~~~~~~~~~~~~

Expand Down
0