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

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

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

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

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

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, чтобы указать выборы в виде ассоциативного массива, где ключи - это ярлыки, отображенные пользователям, а значения массива - внутренние значения, используемые в поле формы:

1
2
3
4
5
6
7
8
9
10
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

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

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

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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 при использовании обратных вызовов.

Тег выбора, чекбоксы или селективные кнопки

Это поле может быть отображено, как одно из нескольких разных HTML-полей, в зависимости от опций 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:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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',
        ],
    ],
]);

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

Опции поля

5.1

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

choices

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

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

1
2
3
4
5
6
7
8
9
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

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

choice_attr

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

Используйте это, чтобы добавить HTML-атрибуты к каждому варианту выбора. Это может быть массив атрибутов (если они одинаковы для каждого варианта), вызываемое или путь свойства (так же, как и choice_label).

Если это массив, то ключ массива choices должен быть использован, как ключи:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('attending', ChoiceType::class, array(
    'choices' => array(
        'Yes' => true,
        'No' => false,
        'Maybe' => null,
    ),
    'choice_attr' => function($val, $key, $index) {
        // добавляет класс типа attending_yes, attending_no, и т.д.
        return ['class' => 'attending_'.strtolower($key)];
    },
));

choice_label

тип: string, callable или false по умолчанию: null

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

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

        // или если вы хотите перевести некоторый ключ
        // вернуть 'form.choice.'.$key;
    },
));

Этот метод вызывается для каждого варианта, передавая вам выбор $value и $key из массива вариантов выбора ($index относится к choice_value). Это даст вам:

Если ваши значения выборов - объекты, то choice_label также может быть путём свойства. Представьте, что у вас есть некоторый класс Status с методом getDisplayName():

1
2
3
4
5
6
7
8
9
10
11
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

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

Если установлено, как false, то все ярлыки тегов для вводов чекбоксов или селективных кнопок будут отброшены. Вы также можете вернуть false из вызываемого, чтобы отбросить некоторые ярлыки.

choice_loader

тип: ChoiceLoaderInterface

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

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

1
2
3
4
5
6
7
8
9
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

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

Используйте это, чтобы добавить HTML-атрибуты к каждому варианту выбора. Это может быть массив атрибутов (если они одинаковы для каждого варианта), вызываемое или путь свойства (так же, как и choice_label).

Если это массив, то ключ массива choices должен быть использован, как ключи:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('attending', ChoiceType::class, array(
    'choices' => array(
        'Yes' => true,
        'No' => false,
        'Maybe' => null,
    ),
    'choice_attr' => function($val, $key, $index) {
        // добавляет класс типа attending_yes, attending_no, и т.д.
        return ['class' => 'attending_'.strtolower($key)];
    },
));

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:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
// 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:

1
2
3
4
5
6
7
// ...
$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:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// 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

тип: string, callable или false по умолчанию: null

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

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

        // или если вы хотите перевести некоторый ключ
        // вернуть 'form.choice.'.$key;
    },
));

Этот метод вызывается для каждого варианта, передавая вам выбор $value и $key из массива вариантов выбора ($index относится к choice_value). Это даст вам:

Если ваши значения выборов - объекты, то choice_label также может быть путём свойства. Представьте, что у вас есть некоторый класс Status с методом getDisplayName():

1
2
3
4
5
6
7
8
9
10
11
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

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

Если установлено, как false, то все ярлыки тегов для вводов чекбоксов или селективных кнопок будут отброшены. Вы также можете вернуть false из вызываемого, чтобы отбросить некоторые ярлыки.

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:

1
2
3
4
5
6
7
8
9
10
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:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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

тип: callable или string по умолчанию: null

Контролирует внутреннее имя поля варианта выбора. Обычно вам не нужно об этом думать, но в некоторых продвинутых случаях, может понадобиться. Например, это "имя" становится индексом просмотра вариантов в шаблоне.

Это может быть вызываемое или путь свойства. См. choice_label для схожих примеров использования. Если используется null, то в качестве имени используется приращенное целое число.

choice_translation_domain

type: string, boolean or null default: true

choice_translation_domain

тип: string, boolean или null

Эта опция определяет, должны ли быть переведены значения вариантов выбора и в каком домене переводов.

Значения опции choice_translation_domain могут быть: true (использовать текущий домен переводов повторно), false (отключить перевод), null (использует родительский домен переводов или домен по умолчанию) или строка, представляющая конкретный домен переводов для использования.

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
  • XML
  • PHP
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'

You can specify the placeholder values as follows:

1
2
3
4
5
6
7
8
9
10
11
12
13
$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:

1
2
3
4
5
6
7
8
9
10
$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

тип: callable или string по умолчанию: null

Возвращает "значение" строки для каждого варианта выбора, которое должно быть уникальным для всех вариантов выбора.Это используется в атрибуте "значения" в HTML и отправляется по запросам POST/PUT. Обычно вам не нужно волноваться об этом, но это может быть полезным при обработке API-запроса (так как вы можете сконфигурировать значение, которое будет отправлено по API-запросу).

Это может быть вызываемое или путь свойства. Если задан null, то в качестве значения используется прямое число.

Если вы передаёте вызываемое, то оно получит один аргумент: сам вариант. При использовании Поле EntityType, аргумент будет объектом сущности для каждого варианта, или, в некоторых случаях, null, что вам нужно обработать:

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

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

тип: array, callable или string по умолчанию: null

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

Опция group_by это альтернативный способ группировать варианты, что даёт вам немного больше гибкости.

Возьмите следующий пример:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

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

Это группирует данные, которые находятся в диапазоне 3 дней в группу "Soon", а всё остальное в группу "Later":

Если вы вернёете null, то опция не будет сгруппирована. Вы также можете передать строку "property path", которая будет вызвана, чтобы получить группу. См. choice_label, чтобы узнать детали об использовании пути свойства.

multiple

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

Если "true", то пользователь сможет выбирать несколько опций (а не только одну). В зависимости от значения опции expanded, это будет отображаться либо как тег выбора, либо как чекбоксы если "true" и тег выбора, либо селективные кнопки, если "false". Возвращённое значение будет массивом.

placeholder

тип: string или boolean

Эта опция определяет, появится ли специальная опция "empty" (например, "Выберите опцию" сверху виджета выбора. Эта опция применяется только если опция multiple установлена, как "false".

  • Добавить пустое значение с текстом "Выберите опцию" в качестве текста:

    1
    2
    3
    4
    5
    6
    use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
    // ...
    
    $builder->add('states', ChoiceType::class, array(
        'placeholder' => 'Choose an option',
    ));
  • Гарантировать, что не отображается ни одна "пустая" опция значения:

    1
    2
    3
    4
    5
    6
    use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
    // ...
    
    $builder->add('states', ChoiceType::class, array(
        'placeholder' => false,
    ));

Если вы оставите опцию placeholder неустановленной, то пустая (без текста) опция, будет автоматически добавлена только, если опция required установлена, как "false":

1
2
3
4
5
6
7
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

// будет добавлена пустая (без текста) опция
$builder->add('states', ChoiceType::class, array(
    '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:

1
2
3
4
5
6
7
8
9
10
11
12
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:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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:

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
  • PHP
1
{{ form_widget(form.publishAt, { 'separator': '=====' }) }}

Tip

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

1
2
3
4
5
6
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.

empty_data

тип: mixed

.. Этот файл должен быть включен только с "началом после" или "окончанием до",
установленными в значении заполнителя. Его цель - позволить нам включать только часть этого файла.

DEFAULT_PLACEHOLDER

Эта опция определяет, какое значение вернёт поле, если отправленное значение пустое (или отсутствует). Она не устаналивает изначальное значение, если оно не предоставлено, когда форма отображается для просмотра.

Это означает, что вам помогают обрабатывать отправку формы с пустыми полями. Например, если вы хотите, чтобы поле name было ясно установлено, как John Doe, когда значение не выбрано, вы можете сделать это так:

1
2
3
4
$builder->add('name', null, array(
    'required'   => false,
    'empty_data' => 'John Doe',
));

Это всё ещё будет отображать пустое текстовое поле, но при отправке будет установлено значение John Doe. Используйте опции data или placeholder, чтобы показать это изначальное значение в отображённой форме.

Если форма составная, то вы можете установить empty_data в качестве массива, объекта или замыкания. См. статью Как сконфигурировать пустые данные для класса формы , чтобы узнать больше об этих опциях.

Note

Если вы хотите установить опцию empty_data для всего вашего класса форм, см. статью Как сконфигурировать пустые данные для класса формы.

Caution

Преобразователи данных формы всё ещё будут применяться к значению empty_data. Это означает, что пустая строка будет преобразована в null. Используйте пользовательский преобразователь данных, если вы хотите ясно вернуть пустую строку.

:end-before: DEFAULT_PLACEHOLDER

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

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

empty_data

тип: mixed

.. Этот файл должен быть включен только с "началом после" или "окончанием до",
установленными в значении заполнителя. Его цель - позволить нам включать только часть этого файла.

DEFAULT_PLACEHOLDER

Эта опция определяет, какое значение вернёт поле, если отправленное значение пустое (или отсутствует). Она не устаналивает изначальное значение, если оно не предоставлено, когда форма отображается для просмотра.

Это означает, что вам помогают обрабатывать отправку формы с пустыми полями. Например, если вы хотите, чтобы поле name было ясно установлено, как John Doe, когда значение не выбрано, вы можете сделать это так:

1
2
3
4
$builder->add('name', null, array(
    'required'   => false,
    'empty_data' => 'John Doe',
));

Это всё ещё будет отображать пустое текстовое поле, но при отправке будет установлено значение John Doe. Используйте опции data или placeholder, чтобы показать это изначальное значение в отображённой форме.

Если форма составная, то вы можете установить empty_data в качестве массива, объекта или замыкания. См. статью Как сконфигурировать пустые данные для класса формы , чтобы узнать больше об этих опциях.

Note

Если вы хотите установить опцию empty_data для всего вашего класса форм, см. статью Как сконфигурировать пустые данные для класса формы.

Caution

Преобразователи данных формы всё ещё будут применяться к значению empty_data. Это означает, что пустая строка будет преобразована в null. Используйте пользовательский преобразователь данных, если вы хотите ясно вернуть пустую строку.

:start-after: DEFAULT_PLACEHOLDER

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

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

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

1
2
3
$builder->add('body', TextareaType::class, array(
    'attr' => array('class' => 'tinymce'),
));

by_reference

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

В большинстве случаев, если у вас есть поле author, то вы ожидаете, что в основоположном объекте будет вызван setAuthor(). Однако, в некоторых случаях, setAuthor() может быть не вызван. Установив by_reference, как false, вы гарантируете, что сеттер будет вызван в любом случае.

Чтобы объяснить это детальнее, вот простой пример:

1
2
3
4
5
6
7
8
9
10
11
12
13
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\Extension\Core\Type\EmailType;
use Symfony\Component\Form\Extension\Core\Type\FormType;
// ...

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

Если by_reference - "true", то следующее происходит за кулисами, когда вы вызываете submit() (или handleRequest()) в форме:

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

Заметьте, что setAuthor() не вызывается. Автор изменяется ссылкой.

Если вы установили by_reference, как "false", отправка выглядит так:

1
2
3
4
5
$article->setTitle('...');
$author = clone $article->getAuthor();
$author->setName('...');
$author->setEmail('...');
$article->setAuthor($author);

Поэтому, всё, что на самом деле делает by_reference=false - это заставляет фреймворк вызать сеттер в родительском объекте.

Похожим образом, если вы используете поле CollectionType, где ваша основоположная коллекция данных является объектом (как с ArrayCollection в Doctrine), то by_reference должна быть установлена, как false, если вам нужно, чтобы был вызван добавитель или уиичтожитель (например, addAuthor() и removeAuthor()).

data

тип: mixed по умолчанию : По умолчанию является полем основоположной структуры.

Когда вы создаёте форму, каждое поле изначально отображает значение соотствующего свойства данных домена формы (например, если вы привязываете объект к форме). Если вы хотите переопределить эти изначальные значения для формы или индивидуального поля, вы можете установить это в опции данных:

1
2
3
4
5
6
use Symfony\Component\Form\Extension\Core\Type\HiddenType;
// ...

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

Caution

Опция data всегда переопределяет значение, взятое из данных домена (объекта) при отображении. Это означает, что значение объекта также переопределяется, когда форма редактирует уже существующий сохранённый объект, что приводит к потере сохранённого значения при отправке формы.

disabled

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

Если вы не хотите, чтобы пользователь изменял значение поля, то вы можете установить опцию отключения, как "true". Любые отправленные данные будут проигнорированы.

error_mapping

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

Эта опция позволяет вам изменять цель ошибки валидации.

Представьте, что у вас есть пользовательский метод под именем matchingCityAndZipCode(), который валидирует, совпадает ли город и почтовый индекс. К сожалению, поля "matchingCityAndZipCode" в вашей форме нет, поэтому всё, что Symfony может сделать - это отобразить ошибку наверху формы.

С настроенным отображением ошибок вы можете сделать лучше: привяжите ошибку к полю города, чтобы она отображалась над ним:

1
2
3
4
5
6
7
8
public function configureOptions(OptionsResolver $resolver)
{
    $resolver->setDefaults(array(
        'error_mapping' => array(
            'matchingCityAndZipCode' => 'city',
        ),
    ));
}

Вот правила для лево- и правостороннего отображения:

  • Левая сторона содержит пути свойств;
  • Если наружение генерируется в свойств или методе класс, то его путь - это просто propertyName;
  • Вы можете создать вложенные пути свойств, соединив их, разделяя свойства точками. Например: addresses[work].matchingCityAndZipCode;
  • Правая сторона содержит просто имена полей в форме.

По умолчанию, ошибки любого свойства, которое не отображенно, соберутся в родительской форме. Вы можете использовать точку (.) в левой части, чтобы привязать ошибки всех неотображённых свойств к конкретному полю. Например, чтобы привязать эти ошибки к полю city, используйте:

1
2
3
4
5
$resolver->setDefaults(array(
    'error_mapping' => array(
        '.' => 'city',
    ),
));

help

type: string or TranslatableInterface default: null

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

1
2
3
4
5
6
7
8
9
10
11
12
13
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'),
    ])
;

6.2

The support for TranslatableInterface objects as help contents was introduced in Symfony 6.2.

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

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

Эта опция определяет, будет ли форма наследовать данные из родительской формы. Это может быть полезной, если у вас есть набор полей, которые повторяется в нескольких формах. См. Как уменьшить дублирование кода с помощью "inherit_data".

Caution

Когда поле имеет установленную опцию inherit_data, оно использует данные родительской формы так, как они есть. Это означает, что Преобразователи Данных не будут применяться к этому полю.

label

тип: string по умолчанию: Ярлык "угадывается" из имени поля

Устанавливает ярлык, который будет использован при отображении поля. Установка, как "false" гасить ярлык. Ярлык также может быть установлен прямо внутри шаблона:

  • Twig
  • PHP
1
{{ form_label(form.name, 'Your name') }}

label_attr

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

Устанавливает HTML-атрибуты для элемента <label>, который будет использован при отображении ярлыка для поля. Это ассоциативный массив с HTML-атрибутом в качестве ключа. Этот атрибут может также быть установлен прямо внутри шаблона:

  • Twig
  • PHP
1
2
3
{{ form_label(form.name, 'Your name', {
       'label_attr': {'class': 'CUSTOM_LABEL_CLASS'}
}) }}

label_format

тип: string по умолчанию: null

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

Если вы используете сообщения переводов ключевых слов в качестве ярлыков, то у вас часто будет несколько сообщений с ключевым словом для одного и того же ярлыка (например, profile_address_street, invoice_address_street). Это потому, что ярлык строится для каждого "пути" к полю. Чтобы избежать повтора сообщений ключевых слов, вы можете сконфигурировать формат ярлыка в качестве статичного значения, например:

1
2
3
4
5
6
7
8
// ...
$profileFormBuilder->add('address', AddressType::class, array(
    'label_format' => 'form.address.%name%',
));

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

Эта опция наследуется дочерними типами. С использованием вышенаписанного кода, ярлык поля street обеих форм будет использовать сообщение с ключевым словом form.address.street.

В формате ярлыка доступны две переменные:

%id%
Уникальный идентификатор для поля, состоящий из полного пути к полю и имени поля (например, profile_address_street);
%name%
Имя поля (например, street).

Значение по умолчанию (null) приводит к "человеческой" версии имени поля.

Note

Опция label_format оценивается в теме формы. Убедитесь в том, что вы обновили ваши щаблоны, в случае, если вы настраивали темизацию форм.

mapped

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

Если вы хотите, чтобы поле было проигнорировано про чтении или записи в него объетка, вы можете установить опцию mapped, как false.

required

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

Если "true", то будет отображён обязательный атрибут HTML5. Соответствующий label также отобразится с классом required.

Эта опция внешняя и не зависит от валидации. В лучшем случае, если вы позволите Symfony отгадать ваш тип поля, тогда значение этой опции будет угадано из вашей информации о валидации.

Note

Обязательная опция также влияет на то, как будут обработаны пустые данные для каждого поля. Чтобы узнать больше, см. опцию empty_data.

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:

1
2
3
$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

тип: string по умолчанию: messages

В случае, если choice_translation_domain установлен, как true или null, это конфигурирует точный домен переводов, который будет использован для любых ярлыков или опций, отображённых для этого поля.

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:

1
2
3
4
5
6
$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:

1
2
3
4
5
6
7
8
9
$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:

1
2
3
4
5
6
$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

Вместо этого намного быстрее использовать тест Справочник функций и переменных форм шаблонов Twig при использовании Twig.