Skip to content

Document typed arrays in optionsresolver #6048

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

Closed
wants to merge 2 commits into from
Closed

Document typed arrays in optionsresolver #6048

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de86e70
Document typed arrays in optionsresolver
Dec 18, 2015
9ec14bf
Fix typo
Dec 21, 2015
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
37 changes: 37 additions & 0 deletions components/options_resolver.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,43 @@ to add additional allowed types without erasing the ones already set.
the values to be given as an array mapping option names to allowed types:
``$resolver->setAllowedTypes(array('port' => array('null', 'int')));``

You can specify an array of a specific type as an allowed option. The expected type is
validated in the same way as before (``is_<type>()`` or an ``instanceof`` check).
Only for an array, this is done recursively. If you expect an option to be an array of
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are those implementation details needed in the doc ? :/

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ogizanagi Well the existing documentation does mention the validation is done using the is_<type> functions, but we could leave it out here as an "implied implementation detail" or something.

``DateTime`` instances or a numeric array, you can specify this as follows::

// ...
class Mailer
{
// ...
public function configureOptions(OptionsResolver $resolver)
{
// ...
$resolver->setAllowedTypes('dates', 'DateTime[]');
$resolver->setAllowedTypes('ports', 'int[]');
}
}

Because the OptionsResolver will validate typed arrays recursively, it is possible to
resolve multi-dimensional arrays, too::

// ...
class Mailer
{
// ...
public function configureOptions(OptionsResolver $resolver)
{
// ...
//allowed type is a 2D array of string values
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would add a space between // and allowed

$resolver->setAllowedTypes('hosts', 'string[][]');
}
}

.. versionadded:: 3.1
Before Symfony 3.1, the allowed types had to be scalar values, qualified classes
or interfaces. The only way to ensure the values of an array were of the right type
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the last sentence sounds weird

was to use a normalizer.

Value Validation
~~~~~~~~~~~~~~~~

Expand Down