Skip to content

[Form] added the "choice_filter" option #13223

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
Apr 12, 2020
Merged

[Form] added the "choice_filter" option #13223

Show file tree
Hide file tree
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
3 changes: 3 additions & 0 deletions reference/forms/types/choice.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ To use this field, you must specify *either* ``choices`` or ``choice_loader`` op
+-------------+------------------------------------------------------------------------------+
| Options | - `choices`_ |
| | - `choice_attr`_ |
| | - `choice_filter`_ |
| | - `choice_label`_ |
| | - `choice_loader`_ |
| | - `choice_name`_ |
Expand Down Expand Up @@ -212,6 +213,8 @@ correct types will be assigned to the model.

.. include:: /reference/forms/types/options/choice_attr.rst.inc

.. include:: /reference/forms/types/options/choice_filter.rst.inc

.. _reference-form-choice-label:

.. include:: /reference/forms/types/options/choice_label.rst.inc
Expand Down
82 changes: 82 additions & 0 deletions reference/forms/types/options/choice_filter.rst.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
``choice_filter``
~~~~~~~~~~~~~~~~~

**type**: ``callable``, ``string`` or :class:`Symfony\\Component\\PropertyAccess\\PropertyPath` **default**: ``null``

.. versionadded:: 5.1

The ``choice_filter`` option has been introduced in Symfony 5.1.

When using predefined choice types from Symfony core or vendor libraries (i.e.
:doc:`CountryType </reference/forms/types/country>`) this option lets you
define a callable that take each choice as only argument and must return
``true`` to keep it or ``false`` to discard it::

// src/Form/Type/AddressType.php
namespace App\Form\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\CountryType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

class AddressType extends AbstractType
{
public function configureOptions(OptionsResolver $resolver)
{
$resolver
->setDefaults([
// enable this type to accept a limited set of countries
'allowed_countries' => null,
])
;
}

public function buildForm(FormBuilderInterface $builder, array $options)
{
$allowedCountries = $options['allowed_countries'];

$builder
// ...
->add('country', CountryType::class, [
// if the AddressType "allowed_countries" option is passed,
// use it to create a filter
'choice_filter' => $allowedCountries ? function ($countryCode) use ($allowedCountries) {
return in_array($countryCode, $allowedCountries, true);
} : null,

])
;
}

The option can be a callable or a property path when choices are objects::

// ...
$builder
->add('category', ChoiceType::class, [
// ...
'choice_filter' => 'isSelectable',
])
;

.. tip::

Considering this ``AddressType`` could be an entry of a ``CollectionType``
you should use the :class:`Symfony\\Component\\Form\\ChoiceList\\ChoiceList`
class helper to enable caching::

// src/Form/Type/AddressType.php
// ...
use Symfony\Component\Form\ChoiceList\ChoiceList;

// ...
'choice_filter' => $allowedCountries ? ChoiceList::filter(
// pass the type as first argument
$this,
function ($countryCode) use ($allowedCountries) {
return in_array($countryCode, $allowedCountries, true);
},
// pass the option that makes the filter "vary" to compute a unique hash
$allowedCountries
) : null,
// ...