Дата обновления перевода 2021-06-08

Поле ChoiceType (выпадающие списки, селективные кнопки, чекбоксы)

Многоцелевое поле, используемое для позволения пользователю “выбирать” одну или больше опций. Может быть отображено как тег select, селективные кнопки или чекбоксы.

Чтобы использовать это поле, вы должны указать либо опцию choices, либо choice_loader.

Отображается как может быть разными тегами (см. ниже)
Опции
Переопределённые опции
Наследуемые опци
Недопустимое сообщение по умолчанию Сделанный выбор недопустим
Наследуемое недопустимое сообщение Значение {{ value }} недопустимо.
Родительский тип FormType
Класс ChoiceType

Tip

The full list of options defined and inherited by this form type is available running this command in your app:

1
2
# replace 'FooType' by the class name of your form type
$ php bin/console debug:form FooType

Пример применения

Простейший способ использовать это поле - определить опцию choices, чтобы указать выборы в виде ассоциативного массива, где ключи - это ярлыки, отображенные пользователям, а значения массива - внутренние значения, используемые в поле формы:

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('isAttending', ChoiceType::class, [
    'choices'  => [
        'Maybe' => null,
        'Yes' => true,
        'No' => false,
    ],
]);

Это создаст выпадающий список select:

../../../_images/choice-example1.png

Если пользователь выбирает No, то форма вернёт false для этого поля. Таким же образом, если начальные данные для этого поля - true, то будет автоматически выбран Yes. Другими словами, значение каждого объекта - это значение, которое вы хотите получить / установить в PHP-коде, в то время, как ключ - это то, что будет показано пользователю.

Продвинутый пример (с Объектами!)

Это поле имеет много опций и большинство контролируют то, как отображается поле. В этом примере, основоположные данные - некоторый объект Category, имеющий метод getName():

use App\Entity\Category;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('category', ChoiceType::class, [
    'choices' => [
        new Category('Cat1'),
        new Category('Cat2'),
        new Category('Cat3'),
        new Category('Cat4'),
    ],
    // "name" - это путь свойства, что означает, что Symfony будет искать публичное
    // свойство или метод вроде "getName()", чтобы определить значение строки ввода,
    // которое будет отправлено формой
    'choice_value' => 'name',
    // обратный вызов для возврата ярлыка для заданного выбора
    // если используется заполнитель, можно передать его пустое значение (null), но
    // его ярлык определяется его собственной опцией "placeholder"
    'choice_label' => function(?Category $category) {
        return $category ? strtoupper($category->getName()) : '';
    },
    // возвращает html атрибуты для каждого ввода опции (может быть селективной кнопкой/чекбоксом)
    'choice_attr' => function(?Category $category) {
        return $category ? ['class' => 'category_'.strtolower($category->getName())] : [];
    },
    // каждая опция может использовать путь свойства строки или любое вызываемое, которое
    // передается каждому выбору как аргументы, но это может не понадобиться
    'group_by' => function() {
        // рандомно распределить все в группы
        return rand(0, 1) == 1 ? 'Group A' : 'Group B';
    },
    // обратный вызов для возврата информации о том, какая категория является предпочтиетнльной
    'preferred_choices' => function(?Category $category) {
        return $category && 100 < $category->getArticleCounts();
    },
]);

Вы также можете настроить choice_name каждого выбора. Вы можете узнать больше обо всех этих опциях в разделах ниже.

Caution

Заполнитель - это определенное поле, когда выборы необязательны, первый объект в списке должен быть пустым, чтобы пользоатель мог отмениь выбор. Убедитесь в том, чтобы всегда обрабатывать пустой выбор как null при использовании обратных вызовов.

Select Tag, Checkboxes or Radio Buttons

This field may be rendered as one of several HTML fields, depending on the expanded and multiple options:

Element Type Expanded Multiple
select tag false false
select tag (with multiple attribute) false true
radio buttons true false
checkboxes true true

Настраивание текста каждой опции (ярлык)

Обычно, ключ массива каждого объекта в опции choices используется в качестве текста, отображаемого пользователю. Но это можно полностью настроить через опцию `choice_label`_. Посмотрите её, чтобы узнать больше.

Группирование опций

Вы можете группировать элементы <option> из <select> в <optgroup>, передавая многомерный массив choices:

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('stockStatus', ChoiceType::class, [
    'choices' => [
        'Main Statuses' => [
            'Yes' => 'stock_yes',
            'No' => 'stock_no',
        ],
        'Out of Stock Statuses' => [
            'Backordered' => 'stock_backordered',
            'Discontinued' => 'stock_discontinued',
        ],
    ],
]);
../../../_images/choice-example4.png

Чтобы сделать всё красивее, используйте опцию group_by.

Опции поля

New in version 5.1: Класс ChoiceList был представлен в Symfony 5.1, чтобы помочь с конфигурацией опций выбора.

choices

тип: array по умолчанию: array()

Это самый базовый способ указать варианты, которые должны быть использованы этим полем. Опция choices - это массив, где ключ массива - это ярлык объёкта, а значение массива - это значение объекта:

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('inStock', ChoiceType::class, [
    'choices' => [
        'In Stock' => true,
        'Out of Stock' => false,
    ],
]);

choice_attr

type: array, callable, string or PropertyPath default: []

Use this to add additional HTML attributes to each choice. This can be an associative array where the keys match the choice keys and the values are the attributes for each choice, a callable or a property path (just like `choice_label`_).

If an array, the keys of the choices array must be used as keys:

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('fruits', ChoiceType::class, [
    'choices' => [
        'Apple' => 1,
        'Banana' => 2,
        'Durian' => 3,
    ],
    'choice_attr' => [
        'Apple' => ['data-color' => 'Red'],
        'Banana' => ['data-color' => 'Yellow'],
        'Durian' => ['data-color' => 'Green'],
    ],
]);

// or use a callable
$builder->add('attending', ChoiceType::class, [
    'choices' => [
        'Yes' => true,
        'No' => false,
        'Maybe' => null,
    ],
    'choice_attr' => function($choice, $key, $value) {
        // adds a class like attending_yes, attending_no, etc
        return ['class' => 'attending_'.strtolower($key)];
    },
]);

Tip

When defining a custom type, you should use the ChoiceList class helper:

use App\Entity\Category;
use Symfony\Component\Form\ChoiceList\ChoiceList;

// ...
$builder->add('choices', ChoiceType::class, [
    'choice_attr' => ChoiceList::attr($this, function (?Category $category) {
        return $category ? ['data-uuid' => $category->getUuid()] : [];
    }),
]);

See the “choice_loader” option documentation.

choice_label

type: string, callable, false or PropertyPath default: null

By default, the array key of each item in the choices option is used as the text that’s shown to the user. The choice_label option allows you to take more control:

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('attending', ChoiceType::class, [
    'choices' => [
        'yes' => true,
        'no' => false,
        'maybe' => null,
    ],
    'choice_label' => function ($choice, $key, $value) {
        if (true === $choice) {
            return 'Definitely!';
        }

        return strtoupper($key);

        // or if you want to translate some key
        //return 'form.choice.'.$key;
    },
]);

This method is called for each choice, passing you the $choice and $key from the choices array (additional $value is related to choice_value). This will give you:

../../../_images/choice-example2.png

If your choice values are objects, then choice_label can also be a property path. Imagine you have some Status class with a getDisplayName() method:

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('attending', ChoiceType::class, [
    'choices' => [
        new Status(Status::YES),
        new Status(Status::NO),
        new Status(Status::MAYBE),
    ],
    'choice_label' => 'displayName',
]);

If set to false, all the tag labels will be discarded for radio or checkbox inputs. You can also return false from the callable to discard certain labels.

Tip

When defining a custom type, you should use the ChoiceList class helper:

use Symfony\Component\Form\ChoiceList\ChoiceList;

// ...
$builder->add('choices', ChoiceType::class, [
    'choice_label' => ChoiceList::label($this, 'displayName'),
]);

See the “choice_loader” option documentation.

choice_loader

тип: ChoiceLoaderInterface

choice_loader может быть использован только для частичной загрузки вариантов в случаях, когда загруженный полностью список не нужен. Это необходимо только в продвинутых случаях и заменяет опцию choices.

Вы можете использовать экземпляр CallbackChoiceLoader, если вы хотите воспользоваться преимуществами ленивой загрузки:

use Symfony\Component\Form\ChoiceList\Loader\CallbackChoiceLoader;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('constants', ChoiceType::class, array(
    'choice_loader' => new CallbackChoiceLoader(function() {
        return StaticClass::getConstants();
    }),
));

Есть есть значения выборов, не являющиеся скалярными, или строковое представление неуникально, Symfony будет использовать приращиваемые числа в качестве значений. Когда форма отправляется, правильные значения с правильными типами будут назначены модели.

choice_attr

type: array, callable, string or PropertyPath default: []

Use this to add additional HTML attributes to each choice. This can be an associative array where the keys match the choice keys and the values are the attributes for each choice, a callable or a property path (just like `choice_label`_).

If an array, the keys of the choices array must be used as keys:

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('fruits', ChoiceType::class, [
    'choices' => [
        'Apple' => 1,
        'Banana' => 2,
        'Durian' => 3,
    ],
    'choice_attr' => [
        'Apple' => ['data-color' => 'Red'],
        'Banana' => ['data-color' => 'Yellow'],
        'Durian' => ['data-color' => 'Green'],
    ],
]);

// or use a callable
$builder->add('attending', ChoiceType::class, [
    'choices' => [
        'Yes' => true,
        'No' => false,
        'Maybe' => null,
    ],
    'choice_attr' => function($choice, $key, $value) {
        // adds a class like attending_yes, attending_no, etc
        return ['class' => 'attending_'.strtolower($key)];
    },
]);

Tip

When defining a custom type, you should use the ChoiceList class helper:

use App\Entity\Category;
use Symfony\Component\Form\ChoiceList\ChoiceList;

// ...
$builder->add('choices', ChoiceType::class, [
    'choice_attr' => ChoiceList::attr($this, function (?Category $category) {
        return $category ? ['data-uuid' => $category->getUuid()] : [];
    }),
]);

See the “choice_loader” option documentation.

choice_filter

type: callable, string or PropertyPath default: null

When using predefined choice types from Symfony core or vendor libraries (i.e. CountryType) this option lets you define a callable that takes each choice as the 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 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,
// ...

choice_label

type: string, callable, false or PropertyPath default: null

By default, the array key of each item in the choices option is used as the text that’s shown to the user. The choice_label option allows you to take more control:

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('attending', ChoiceType::class, [
    'choices' => [
        'yes' => true,
        'no' => false,
        'maybe' => null,
    ],
    'choice_label' => function ($choice, $key, $value) {
        if (true === $choice) {
            return 'Definitely!';
        }

        return strtoupper($key);

        // or if you want to translate some key
        //return 'form.choice.'.$key;
    },
]);

This method is called for each choice, passing you the $choice and $key from the choices array (additional $value is related to choice_value). This will give you:

../../../_images/choice-example2.png

If your choice values are objects, then choice_label can also be a property path. Imagine you have some Status class with a getDisplayName() method:

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('attending', ChoiceType::class, [
    'choices' => [
        new Status(Status::YES),
        new Status(Status::NO),
        new Status(Status::MAYBE),
    ],
    'choice_label' => 'displayName',
]);

If set to false, all the tag labels will be discarded for radio or checkbox inputs. You can also return false from the callable to discard certain labels.

Tip

When defining a custom type, you should use the ChoiceList class helper:

use Symfony\Component\Form\ChoiceList\ChoiceList;

// ...
$builder->add('choices', ChoiceType::class, [
    'choice_label' => ChoiceList::label($this, 'displayName'),
]);

See the “choice_loader” option documentation.

choice_loader

type: ChoiceLoaderInterface

The choice_loader option can be used instead of the choices option. It allows to create a list lazily or partially when fetching only the choices for a set of submitted values (i.e. querying a search engine like ElasticSearch can be a heavy process).

You can use an instance of CallbackChoiceLoader if you want to take advantage of lazy loading:

use App\StaticClass;
use Symfony\Component\Form\ChoiceList\Loader\CallbackChoiceLoader;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('loaded_choices', ChoiceType::class, [
    'choice_loader' => new CallbackChoiceLoader(function() {
        return StaticClass::getConstants();
    }),
]);

This will cause the call of StaticClass::getConstants() to not happen if the request is redirected and if there is no pre set or submitted data. Otherwise the choice options would need to be resolved thus triggering the callback.

When you’re defining a custom choice type that may be reused in many fields (like entries of a collection) or reused in multiple forms at once, you should use the ChoiceList static methods to wrap the loader and make the choice list cacheable for better performance:

use App\Form\ChoiceList\CustomChoiceLoader;
use App\StaticClass;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\ChoiceList\ChoiceList;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;

class ConstantsType extends AbstractType
{
    public function getParent(): string
    {
        return ChoiceType::class;
    }

    public function configureOptions(OptionsResolver $resolver)
    {
        $resolver->setDefaults([
            // the example below will create a CallbackChoiceLoader from the callable
            'choice_loader' => ChoiceList::lazy($this, function() {
                return StaticClass::getConstants();
            }),

            // you can pass your own loader as well, depending on other options
            'some_key' => null,
            'choice_loader' => function (Options $options) {
                return ChoiceList::loader(
                    // pass the instance of the type or type extension which is
                    // currently configuring the choice list as first argument
                    $this,
                    // pass the other option to the loader
                    new CustomChoiceLoader($options['some_key']),
                    // ensure the type stores a loader per key
                    // by using the special third argument "$vary"
                    // an array containing anything that "changes" the loader
                    [$options['some_key']]
                );
            },
        ]);
    }
}

choice_name

type: callable, string or PropertyPath default: null

Controls the internal field name of the choice. You normally don’t care about this, but in some advanced cases, you might. For example, this “name” becomes the index of the choice views in the template and is used as part of the field name attribute.

This can be a callable or a property path. See `choice_label`_ for similar usage. By default, the choice key or an incrementing integer may be used (starting at 0).

Tip

When defining a custom type, you should use the ChoiceList class helper:

use Symfony\Component\Form\ChoiceList\ChoiceList;

// ...
$builder->add('choices', ChoiceType::class, [
    'choice_name' => ChoiceList::fieldName($this, 'name'),
]);

See the “choice_loader” option documentation.

Caution

The configured value must be a valid form name. Make sure to only return valid names when using a callable. Valid form names must be composed of letters, digits, underscores, dashes and colons and must not start with a dash or a colon.

choice_translation_domain

type: string, boolean or null default: true

This option determines if the choice values should be translated and in which translation domain.

The values of the choice_translation_domain option can be true (reuse the current translation domain), false (disable translation), null (uses the parent translation domain or the default domain) or a string which represents the exact translation domain to use.

choice_translation_parameters

type: array, callable, string or PropertyPath default: []

The choice values are translated before displaying it, so it can contain translation placeholders. This option defines the values used to replace those placeholders. This can be an associative array where the keys match the choice keys and the values are the attributes for each choice, a callable or a property path (just like `choice_label`_).

Given this translation message:

  • YAML
    1
    2
    3
    # translations/messages.en.yaml
    form.order.yes: 'I confirm my order to the company %company%'
    form.order.no: 'I cancel my order'
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    <!-- translations/messages.en.xlf -->
    <?xml version="1.0"?>
    <xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">
        <file source-language="en" datatype="plaintext" original="file.ext">
            <body>
            <trans-unit id="form.order.yes">
                <source>form.order.yes</source>
                <target>I confirm my order to the company %company%</target>
            </trans-unit>
            <trans-unit id="form.order.no">
                <source>form.order.no</source>
                <target>I cancel my order</target>
            </trans-unit>
            </body>
        </file>
    </xliff>
    
  • PHP
    1
    2
    3
    4
    5
    // translations/messages.fr.php
    return [
        'form.order.yes' => "I confirm my order to the company %company%",
        'form.order.no' => "I cancel my order",
    ];
    

You can specify the placeholder values as follows:

$builder->add('id', null, [
    'choices' => [
        'form.order.yes' => true,
        'form.order.no' => false,
    ],
    'choice_translation_parameters' => function ($choice, $key, $value) {
        if (false === $choice) {
            return [];
        }

        return ['%company%' => 'ACME Inc.']
    },
]);

If an array, the keys of the choices array must be used as keys:

$builder->add('id', null, [
    'choices' => [
        'form.order.yes' => true,
        'form.order.no' => false,
    ],
    'choice_translation_parameters' => [
        'form.order.yes' => ['%company%' => 'ACME Inc.'],
        'form.order.no' => [],
    ],
]);

The translation parameters of child fields are merged with the same option of their parents, so children can reuse and/or override any of the parent placeholders.

choice_value

type: callable, string or PropertyPath default: null

Returns the string “value” for each choice, which must be unique across all choices. This is used in the value attribute in HTML and submitted in the POST/PUT requests. You don’t normally need to worry about this, but it might be handy when processing an API request (since you can configure the value that will be sent in the API request).

This can be a callable or a property path. By default, the choices are used if they can be casted to strings. Otherwise an incrementing integer is used (starting at 0).

If you pass a callable, it will receive one argument: the choice itself. When using the EntityType Field, the argument will be the entity object for each choice or null in a placeholder is used, which you need to handle:

'choice_value' => function (?MyOptionEntity $entity) {
    return $entity ? $entity->getId() : '';
},

Tip

When defining a custom type, you should use the ChoiceList class helper:

use Symfony\Component\Form\ChoiceList\ChoiceList;

// ...
$builder->add('choices', ChoiceType::class, [
    'choice_value' => ChoiceList::value($this, 'uuid'),
]);

See the “choice_loader” option documentation.

expanded

type: boolean default: false

If set to true, radio buttons or checkboxes will be rendered (depending on the multiple value). If false, a select element will be rendered.

group_by

type: string, callable or PropertyPath default: null

You can group the <option> elements of a <select> into <optgroup> by passing a multi-dimensional array to choices. See the Grouping Options section about that.

The group_by option is an alternative way to group choices, which gives you a bit more flexibility.

Take the following example:

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('publishAt', ChoiceType::class, [
    'choices' => [
        'now' => new \DateTime('now'),
        'tomorrow' => new \DateTime('+1 day'),
        '1 week' => new \DateTime('+1 week'),
        '1 month' => new \DateTime('+1 month'),
    ],
    'group_by' => function($choice, $key, $value) {
        if ($choice <= new \DateTime('+3 days')) {
            return 'Soon';
        }

        return 'Later';
    },
]);

This groups the dates that are within 3 days into “Soon” and everything else into a “Later” <optgroup>:

../../../_images/choice-example5.png

If you return null, the option won’t be grouped. You can also pass a string “property path” that will be called to get the group. See the `choice_label`_ for details about using a property path.

Tip

When defining a custom type, you should use the ChoiceList class helper:

use Symfony\Component\Form\ChoiceList\ChoiceList;

// ...
$builder->add('choices', ChoiceType::class, [
    'group_by' => ChoiceList::groupBy($this, 'category'),
]);

See the “choice_loader” option documentation.

multiple

type: boolean default: false

If true, the user will be able to select multiple options (as opposed to choosing just one option). Depending on the value of the expanded option, this will render either a select tag or checkboxes if true and a select tag or radio buttons if false. The returned value will be an array.

placeholder

type: string or boolean

This option determines whether or not a special “empty” option (e.g. “Choose an option”) will appear at the top of a select widget. This option only applies if the multiple option is set to false.

  • Add an empty value with “Choose an option” as the text:

    use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
    // ...
    
    $builder->add('states', ChoiceType::class, [
        'placeholder' => 'Choose an option',
    ]);
    
  • Guarantee that no “empty” value option is displayed:

    use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
    // ...
    
    $builder->add('states', ChoiceType::class, [
        'placeholder' => false,
    ]);
    

If you leave the placeholder option unset, then a blank (with no text) option will automatically be added if and only if the required option is false:

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

// a blank (with no text) option will be added
$builder->add('states', ChoiceType::class, [
    'required' => false,
]);

preferred_choices

type: array, callable, string or PropertyPath default: []

This option allows you to display certain choices at the top of your list with a visual separator between them and the complete list of options. If you have a form of languages, you can list the most popular on top, like Bork and Pirate:

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('language', ChoiceType::class, [
    'choices' => [
        'English' => 'en',
        'Spanish' => 'es',
        'Bork' => 'muppets',
        'Pirate' => 'arr',
    ],
    'preferred_choices' => ['muppets', 'arr'],
]);

This options can also be a callback function to give you more flexibility. This might be especially useful if your values are objects:

use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('publishAt', ChoiceType::class, [
    'choices' => [
        'now' => new \DateTime('now'),
        'tomorrow' => new \DateTime('+1 day'),
        '1 week' => new \DateTime('+1 week'),
        '1 month' => new \DateTime('+1 month'),
    ],
    'preferred_choices' => function ($choice, $key, $value) {
        // prefer options within 3 days
        return $choice <= new \DateTime('+3 days');
    },
]);

This will “prefer” the “now” and “tomorrow” choices only:

../../../_images/choice-example3.png

Finally, if your values are objects, you can also specify a property path string on the object that will return true or false.

The preferred choices are only meaningful when rendering a select element (i.e. expanded false). The preferred choices and normal choices are separated visually by a set of dotted lines (i.e. -------------------). This can be customized when rendering the field:

  • Twig
    1
    {{ form_widget(form.publishAt, { 'separator': '=====' }) }}
    
  • PHP
    1
    2
    3
    <?= $view['form']->widget($form['publishAt'], [
        'separator' => '=====',
    ]) ?>
    

Tip

When defining a custom type, you should use the ChoiceList class helper:

use Symfony\Component\Form\ChoiceList\ChoiceList;

// ...
$builder->add('choices', ChoiceType::class, [
    'preferred_choices' => ChoiceList::preferred($this, 'taggedAsFavorite'),
]);

See the “choice_loader” option documentation.

Переопределённые опции

compound

тип: boolean по умолчанию: то же значение, что и опция expanded

Эта опция указывает, является ли форма составной. Значение по умолчанию переопределяется значением опции expanded.

Настоящее значение этой опции по умолчанию зависит от других опций поля:

  • Если multiple - false, а expanded - false, то '' (пустая строка);
  • Иначе - [] (пустой массив).

error_bubbling

тип: boolean по умолчанию: false

Настройте так, чтобы ошибка в этом поле была присоединена к полю, а не к родительскому полю (в большинстве случаев - форме).

trim

type: boolean default: false

Trimming is disabled by default because the selected value or values must match the given choice values exactly (and they could contain whitespaces).

invalid_message

type: string default: This value is not valid

This is the validation error message that’s used if the data entered into this field doesn’t make sense (i.e. fails validation).

This might happen, for example, if the user enters a nonsense string into a TimeType field that cannot be converted into a real time or if the user enters a string (e.g. apple) into a number field.

Normal (business logic) validation (such as when setting a minimum length for a field) should be set using validation messages with your validation rules (reference).

Наследуемые опции

Эти опции наследуются из FormType:

attr

type: array default: []

If you want to add extra attributes to an HTML field representation you can use the attr option. It’s an associative array with HTML attributes as keys. This can be useful when you need to set a custom class for some widget:

$builder->add('body', TextareaType::class, [
    'attr' => ['class' => 'tinymce'],
]);

See also

Use the row_attr option if you want to add these attributes to the form type row element.

by_reference

type: boolean default: true

In most cases, if you have an author field, then you expect setAuthor() to be called on the underlying object. In some cases, however, setAuthor() may not be called. Setting by_reference to false ensures that the setter is called in all cases.

To explain this further, here’s a simple example:

use Symfony\Component\Form\Extension\Core\Type\EmailType;
use Symfony\Component\Form\Extension\Core\Type\FormType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
// ...

$builder = $this->createFormBuilder($article);
$builder
    ->add('title', TextType::class)
    ->add(
        $builder->create('author', FormType::class, ['by_reference' => ?])
            ->add('name', TextType::class)
            ->add('email', EmailType::class)
    )

If by_reference is true, the following takes place behind the scenes when you call submit() (or handleRequest()) on the form:

$article->setTitle('...');
$article->getAuthor()->setName('...');
$article->getAuthor()->setEmail('...');

Notice that setAuthor() is not called. The author is modified by reference.

If you set by_reference to false, submitting looks like this:

$article->setTitle('...');
$author = clone $article->getAuthor();
$author->setName('...');
$author->setEmail('...');
$article->setAuthor($author);

So, all that by_reference=false really does is that it clones the object, which enforces the framework to call the setter on the parent object.

Similarly, if you’re using the CollectionType field where your underlying collection data is an object (like with Doctrine’s ArrayCollection), then by_reference must be set to false if you need the adder and remover (e.g. addAuthor() and removeAuthor()) to be called.

data

type: mixed default: Defaults to field of the underlying structure.

When you create a form, each field initially displays the value of the corresponding property of the form’s domain data (e.g. if you bind an object to the form). If you want to override this initial value for the form or an individual field, you can set it in the data option:

use Symfony\Component\Form\Extension\Core\Type\HiddenType;
// ...

$builder->add('token', HiddenType::class, [
    'data' => 'abcdef',
]);

Caution

The data option always overrides the value taken from the domain data (object) when rendering. This means the object value is also overridden when the form edits an already persisted object, causing it to lose its persisted value when the form is submitted.

disabled

type: boolean default: false

If you don’t want a user to modify the value of a field, you can set the disabled option to true. Any submitted value will be ignored.

error_mapping

type: array default: []

This option allows you to modify the target of a validation error.

Imagine you have a custom method named matchingCityAndZipCode() that validates whether the city and zip code match. Unfortunately, there is no matchingCityAndZipCode field in your form, so all that Symfony can do is display the error on top of the form.

With customized error mapping, you can do better: map the error to the city field so that it displays above it:

public function configureOptions(OptionsResolver $resolver)
{
    $resolver->setDefaults([
        'error_mapping' => [
            'matchingCityAndZipCode' => 'city',
        ],
    ]);
}

Here are the rules for the left and the right side of the mapping:

  • The left side contains property paths;
  • If the violation is generated on a property or method of a class, its path is the propertyName;
  • If the violation is generated on an entry of an array or ArrayAccess object, the property path is [indexName];
  • You can construct nested property paths by concatenating them, separating properties by dots. For example: addresses[work].matchingCityAndZipCode;
  • The right side contains the names of fields in the form.

By default, errors for any property that is not mapped will bubble up to the parent form. You can use the dot (.) on the left side to map errors of all unmapped properties to a particular field. For instance, to map all these errors to the city field, use:

$resolver->setDefaults([
    'error_mapping' => [
        '.' => 'city',
    ],
]);

help

type: string or TranslatableMessage default: null

Allows you to define a help message for the form field, which by default is rendered below the field:

use Symfony\Component\Translation\TranslatableMessage;

$builder
    ->add('zipCode', null, [
        'help' => 'The ZIP/Postal code for your credit card\'s billing address.',
    ])

    // ...

    ->add('status', null, [
        'help' => new TranslatableMessage('order.status', ['%order_id%' => $order->getId()], 'store'),
    ])
;

help_attr

type: array default: []

Sets the HTML attributes for the element used to display the help message of the form field. Its value is an associative array with HTML attribute names as keys. These attributes can also be set in the template:

1
2
3
{{ form_help(form.name, 'Your name', {
    'help_attr': {'class': 'CUSTOM_LABEL_CLASS'}
}) }}

help_html

type: boolean default: false

By default, the contents of the help option are escaped before rendering them in the template. Set this option to true to not escape them, which is useful when the help contains HTML elements.

inherit_data

type: boolean default: false

This option determines if the form will inherit data from its parent form. This can be useful if you have a set of fields that are duplicated across multiple forms. See How to Reduce Code Duplication with “inherit_data”.

Caution

When a field has the inherit_data option set, it uses the data of the parent form as is. This means that Data Transformers won’t be applied to that field.

label

type: string default: The label is “guessed” from the field name

Sets the label that will be used when rendering the field. Setting to false will suppress the label. The label can also be set in the template:

  • Twig
    1
    {{ form_label(form.name, 'Your name') }}
    
  • PHP
    1
    2
    3
    4
    echo $view['form']->label(
        $form['name'],
        'Your name'
    );
    

label_attr

type: array default: []

Sets the HTML attributes for the <label> element, which will be used when rendering the label for the field. It’s an associative array with HTML attribute as a key. This attributes can also be directly set inside the template:

  • Twig
    1
    2
    3
    {{ form_label(form.name, 'Your name', {
        'label_attr': {'class': 'CUSTOM_LABEL_CLASS'}
    }) }}
    
  • PHP
    1
    2
    3
    4
    5
    echo $view['form']->label(
        $form['name'],
        'Your name',
        ['label_attr' => ['class' => 'CUSTOM_LABEL_CLASS']]
    );
    

label_format

type: string default: null

Configures the string used as the label of the field, in case the label option was not set. This is useful when using keyword translation messages.

If you’re using keyword translation messages as labels, you often end up having multiple keyword messages for the same label (e.g. profile_address_street, invoice_address_street). This is because the label is built for each “path” to a field. To avoid duplicated keyword messages, you can configure the label format to a static value, like:

// ...
$profileFormBuilder->add('address', AddressType::class, [
    'label_format' => 'form.address.%name%',
]);

$invoiceFormBuilder->add('invoice', AddressType::class, [
    'label_format' => 'form.address.%name%',
]);

This option is inherited by the child types. With the code above, the label of the street field of both forms will use the form.address.street keyword message.

Two variables are available in the label format:

%id%
A unique identifier for the field, consisting of the complete path to the field and the field name (e.g. profile_address_street);
%name%
The field name (e.g. street).

The default value (null) results in a “humanized” version of the field name.

Note

The label_format option is evaluated in the form theme. Make sure to update your templates in case you customized form theming.

mapped

type: boolean default: true

If you wish the field to be ignored when reading or writing to the object, you can set the mapped option to false.

required

type: boolean default: true

If true, an HTML5 required attribute will be rendered. The corresponding label will also render with a required class.

This is superficial and independent of validation. At best, if you let Symfony guess your field type, then the value of this option will be guessed from your validation information.

Note

The required option also affects how empty data for each field is handled. For more details, see the `empty_data`_ option.

row_attr

type: array default: []

An associative array of the HTML attributes added to the element which is used to render the form type row:

$builder->add('body', TextareaType::class, [
    'row_attr' => ['class' => 'text-editor', 'id' => '...'],
]);

See also

Use the attr option if you want to add these attributes to the form type widget element.

translation_domain

type: string default: messages

In case choice_translation_domain is set to true or null, this configures the exact translation domain that will be used for any labels or options that are rendered for this field.

label_translation_parameters

type: array default: []

The content of the label option is translated before displaying it, so it can contain translation placeholders. This option defines the values used to replace those placeholders.

Given this translation message:

1
2
# translations/messages.en.yaml
form.order.id: 'Identifier of the order to %company%'

You can specify the placeholder values as follows:

$builder->add('id', null, [
    'label' => 'form.order.id',
    'label_translation_parameters' => [
        '%company%' => 'ACME Inc.',
    ],
]);

The label_translation_parameters option of children fields is merged with the same option of their parents, so children can reuse and/or override any of the parent placeholders.

attr_translation_parameters

type: array default: []

The content of the title and placeholder values defined in the attr option is translated before displaying it, so it can contain translation placeholders. This option defines the values used to replace those placeholders.

Given this translation message:

1
2
3
# translations/messages.en.yaml
form.order.id.placeholder: 'Enter unique identifier of the order to %company%'
form.order.id.title: 'This will be the reference in communications with %company%'

You can specify the placeholder values as follows:

$builder->add('id', null, [
    'attr' => [
        'placeholder' => 'form.order.id.placeholder',
        'title' => 'form.order.id.title',
    ],
    'attr_translation_parameters' => [
        '%company%' => 'ACME Inc.',
    ],
]);

The attr_translation_parameters option of children fields is merged with the same option of their parents, so children can reuse and/or override any of the parent placeholders.

help_translation_parameters

type: array default: []

The content of the help option is translated before displaying it, so it can contain translation placeholders. This option defines the values used to replace those placeholders.

Given this translation message:

1
2
# translations/messages.en.yaml
form.order.id.help: 'This will be the reference in communications with %company%'

You can specify the placeholder values as follows:

$builder->add('id', null, [
    'help' => 'form.order.id.help',
    'help_translation_parameters' => [
        '%company%' => 'ACME Inc.',
    ],
]);

The help_translation_parameters option of children fields is merged with the same option of their parents, so children can reuse and/or override any of the parent placeholders.

Переменные поля

Переменная Тип Использование
multiple boolean Значение опции multiple.
expanded boolean Значение опции expanded.
preferred_choices array Вложенный массив, содержащий объекты ChoiceView вариантов, которые должны быть представлены пользователю с приоритетом.
choices array Вложенный массив, содержащий объекты ChoiceView оставшихся вариантов.
separator string Разделитель между группами вариантов.
placeholder mixed Пустое значение, если его ещё нет в списке, иначе - null.
choice_translation_domain mixed boolean, null или string, чтобы определить значение для перевода.
is_selected callable Вызываемое, которое берёт ChoiceView и выбранное знечение(я) и возвращает выбор выбранного значения(ий).
placeholder_in_choices boolean Есть ли пустое значение в списке вариантов.

Tip

Вместо этого намного быстрее использовать тест selectedchoice(selected_value) при использовании Twig.

Эта документация является переводом официальной документации Symfony и предоставляется по свободной лицензии CC BY-SA 3.0.