choices

тип: 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,
    ],
]);

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

Дата обновления перевода 2023-09-25

choice_attr

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

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

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

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

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'],
    ],
]);

// или используйте вызываемое
$builder->add('attending', ChoiceType::class, [
    'choices' => [
        'Yes' => true,
        'No' => false,
        'Maybe' => null,
    ],
    'choice_attr' => function ($choice, string $key, mixed $value) {
        // добавляет класс типа attending_yes, attending_no, и т.д.
        return ['class' => 'attending_'.strtolower($key)];
    },
]);

1
2
3
4
5
6
7
8
9

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

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

Дата обновления перевода 2024-07-27

choice_filter

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

При использовании предварительно определённых типов выбора из ядра Symfony или библиотек поставщика (т.е. CountryType) эта опция позволяет вам определить вызываемое, которое принимает каждый выбор как единственный аргумент и должно возвращать true для сохранения или false для сброса:

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): void
    {
        $resolver
            ->setDefaults([
                // включите этот тип, чтобы принимать ограниченный набор стран
                'allowed_countries' => null,
            ])
        ;
    }

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

        $builder
            // ...
            ->add('country', CountryType::class, [
                // если передана опция AddressType "allowed_countries",
                // используйте её, чтобы создать фильтр
                'choice_filter' => $allowedCountries ? function ($countryCode) use ($allowedCountries): bool {
                    return in_array($countryCode, $allowedCountries, true);
                } : null,

            ])
        ;
    }

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

1
2
3
4
5
6
7

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

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(
    // передать тип как первый аргумент
    $this,
    function (string $countryCode) use ($allowedCountries): bool {
        return in_array($countryCode, $allowedCountries, true);
    },
    // передать опцию, которая заставляет фильтр "изменяться", чтобы вычислить уникальный хеш
    $allowedCountries
) : null,
// ...

Дата обновления перевода 2024-07-26

choice_label

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

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

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

        return strtoupper($key);

        // или если вы хотите перевести некоторый ключ
        // вернуть 'form.choice.'.$key;
        // вернуть новый TranslatableMessage($key, false === $choice ? [] : ['%status%' => $value], 'store');
    },
]);

Этот метод вызывается для каждого варианта, передавая вам выбор $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, [
    'choices' => [
        new Status(Status::YES),
        new Status(Status::NO),
        new Status(Status::MAYBE),
    ],
    'choice_label' => 'displayName',
]);

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

1
2
3
4
5
6

use Symfony\Component\Form\ChoiceList\ChoiceList;

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

Дата обновления перевода 2024-07-36

choice_loader

тип: ChoiceLoaderInterface

Опция choice_loader может быть использована вместо опции choices. Она позволяет создать ссписок лениво или частично при извлечении только выборов для набора отправленных данных (т.е. запрос в поисковую систему вроде ElasticSearch может быть тяжелым процессом).

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

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(static function (): array {
        return StaticClass::getConstants();
    }),
]);

Это приведет к тому, что вызов StaticClass::getConstants() не произойдет, если запрос перенапрравлен и если отсутствуют предустановленные или отправленные данные. Иначе опции выбора нужно будет решить, что пиведет к запуску обратного вызова.

Если встроенный CallbackChoiceLoader не подходит для ваших нужд, вы можете создать свой собственный загрузчик, реализовав ChoiceLoaderInterface или расширив AbstractChoiceLoader. Этот абстрактный класс избавит вас от лишней работы, реализовав некоторые методы интерфейса. интерфейса, так что вам нужно будет реализовать только метод loadChoices(), чтобы иметь полностью функциональный загрузчик вариантов.

Когда вы определяете пользовательский тип выбора, который может быть повторно использован во многих полях (вроде записей коллекции) или повторно использован во многих формах одновременно, вы должны ипользовать статичные методы ChoiceList, чтобы обернуть загрузчик и сделать список выборов кешируемым для лучшей производительности:

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
42

use App\Form\ChoiceList\CustomChoiceLoader;
use App\StaticClass;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\ChoiceList\ChoiceList;
use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
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): void
    {
        $resolver->setDefaults([
            // пример ниже создаст CallbackChoiceLoader из вызываемого
            'choice_loader' => ChoiceList::lazy($this, function () {
                return StaticClass::getConstants();
            }),

            // вы можете также передать собственный загрузчик, в зависимости от других опций
            'some_key' => null,
            'choice_loader' => function (Options $options): ChoiceLoaderInterface {
                return ChoiceList::loader(
                    // передать экземпляр типа или расширение типа, которое на данный момент
                    // конфигурирует список выборов, в качестве первого аргумента
                    $this,
                    // передать другую опцию загрузчику
                    new CustomChoiceLoader($options['some_key']),
                    // гарантировать, что тип сохраняет по загрузчику на ключ,
                    // используя специальный третий аргумент "$vary"
                    // массив, содержащий все, что "изменяет" загрузчик
                    [$options['some_key']]
                );
            },
        ]);
    }
}

choice_name

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

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

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

Дата обновления перевода 2023-01-12

choice_translation_domain

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

Дата обновления перевода 2023-01-12

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

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

Дата обновления перевода 2023-09-25

choice_translation_parameters

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

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

Имея такое сообщение перевода:

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'

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>

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",
];

Вы можете указать значения заполнителя таким образом:

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, string $key, mixed $value): array {
        if (false === $choice) {
            return [];
        }

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

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

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' => [],
    ],
]);

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

choice_value

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

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

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

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

'choice_value' => function (?MyOptionEntity $entity): string {

return $entity ? $entity->getId() : '';

},

1
2
3
4
5
6

use Symfony\Component\Form\ChoiceList\ChoiceList;

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

Дата обновления перевода 2024-07-26

duplicate_preferred_choices

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

При использовании опции preferred_choices, эти предпочтительные варианты отображаются по умолчанию дважды: в верхней части списка и в полном списке ниже. Установите эту опцию в значение false, чтобы отображать предпочтительные варианты только в верхней части списка:

1
2
3
4
5
6
7
8
9
10
11
12
13

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'],
    'duplicate_preferred_choices' => false,
]);

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.

Дата обновления перевода 2024-07-26

group_by

тип: array, callable или PropertyPath по умолчанию: 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, [
    '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';
    },
]);

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

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

1
2
3
4
5
6

use Symfony\Component\Form\ChoiceList\ChoiceList;

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

multiple

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

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

Дата обновления перевода 2024-07-26

placeholder

тип: string, или TranslatableMessage, или boolean

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

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

  1
  2
  3
  4
  5
  6
  7
  8
  9

  use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
  // ...
  
  $builder->add('states', ChoiceType::class, [
      'placeholder' => 'Choose an option',
  
      // или, если вы хотите перевести текст
      'placeholder' => new TranslatableMessage('form.placeholder.select_option', [], 'form'),
  ]);

• Гарантировать, что не отображается ни одна "пустая" опция значения:

  1
  2
  3
  4
  5
  6

  use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
  // ...
  
  $builder->add('states', ChoiceType::class, [
      '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, [
    'required' => false,
));

Дата обновления перевода 2024-07-26

placeholder_attr

тип: array по умолчанию: []

Используется для добавления дополнительных HTML-атрибутов к выбору заполнителя:

1
2
3
4
5
6
7
8
9
10

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

$builder->add('fruits', ChoiceType::class, [
    // ...
    'placeholder' => '...',
    'placeholder_attr' => [
        ['title' => 'Choose an option'],
    ],
]);

Дата обновления перевода 2024-07-26

preferred_choices

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

Эта опция позволяет вам передвигать определённые варианты кверху вашего списка с визуальным разделителем между ними, и другими опциями. Если у вас есть форма языков, вы можете перечислить наиболее популярные наверху, например Bork Bork и 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'],
]);

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

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): bool {
        // предполчитать опции в течение 3 дней
        return $val <= new \DateTime('+3 days');
    },
));

Так будут "предпочитаться" только варианты "now" (сейчас) и "tomorrow" (завтра):

Наконец, если ваши значения являются объектами, вы также можете указать строку пути свойства в объекте, который будет возвращать "true" или "false".

Предпочитаемые варианты имеют смысл только при отображении элемента select (т.е. expanded - "false"). Предпочитаемые варианты и обычные варианты визуально разделяются пунктирной линией (т.е. -------------------). Это можно настроить при отображении поля:

1

{{ form_widget(form.publishAt, { 'separator': '=====' }) }}

1
2
3

<?= $view['form']->widget($form['publishAt'], [
    'separator' => '=====',
]) ?>

1
2
3
4
5
6

use Symfony\Component\Form\ChoiceList\ChoiceList;

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

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

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

• Если 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 в качестве массива, объекта или замыкания. См. статью Как сконфигурировать пустые данные для класса формы , чтобы узнать больше об этих опциях.

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 ).

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',
));

disabled

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

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

Дата обновления перевода 2024-07-26

error_mapping

тип: array по умолчанию: []

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

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

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

1
2
3
4
5
6
7
8

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

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

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

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

1
2
3
4
5

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

Дата обновления перевода 2024-07-26

help

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

Позволяет вам определять сообщение помощи для поля формы, которое по умолчанию отображается под полем:

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'),
    ])
;

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".

Дата обновления перевода 2023-01-12

label

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

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

1
2
3
4
5
6
7
8

use Symfony\Component\Translation\TranslatableMessage;

$builder
    ->add('zipCode', null, [
        'label' => 'The ZIP/Postal code',
        // по желанию, вы можете использовать объекты TranslatableMessage как содержание ярлыка
        'label' => new TranslatableMessage('address.zipCode', ['%country%' => $country], 'address'),
    ])

Ярлык также может быть установлен внутри шаблона:

1

{{ form_label(form.name, 'Your name') }}

1
2
3
4

echo $view['form']->label(
    $form['name'],
    'Your name'
);

label_attr

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

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

1
2
3

{{ form_label(form.name, 'Your name', {
       'label_attr': {'class': 'CUSTOM_LABEL_CLASS'}
}) }}

1
2
3
4
5

echo $view['form']->label(
    $form['name'],
    'Your name',
    array('label_attr' => array('class' => 'CUSTOM_LABEL_CLASS'))
);

label_html

type: boolean default: false

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

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) приводит к "человеческой" версии имени поля.

mapped

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

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

Дата обновления перевода 2023-09-25

required

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

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

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

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' => '...'],
]);

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.

Получение доступа к данным выбора формы

Переменная form.vars каждой записи выбора содержит данные, такие как, был ли сделан выбор, или нет. Если вам нужно получить полный список данных выбора и значений, используйте переменную choices из родительской формы записи выбора (которая есть самим ChoiceType) с form.parent.vars.choices:

1
2
3
4
5
6
7
8

{# `true` или `false`, в зависимости от того, выбран ли текущий выбор как радио-кнопка или чекбокс #}
{{ form.vars.data }}

{# текущее значение выбора (т.е. имя категории, когда `'choice_value' => 'name'`) #}
{{ form.vars.value }}

{# отображение экземпляров `ChoiceView` или `ChoiceGroupView`, проиндексированных по значениям выбора или именам групп #}
{{ form.parent.vars.choices }}

Следуя тому же продвинутому примеру, что и выше (где значения выбора являются сущностями), объект Category находится внутри form.parent.vars.choices[key].data:

1
2
3
4
5
6
7
8
9
10
11

{% block _form_categories_entry_widget %}
    {% set entity = form.parent.vars.choices[form.vars.value].data %}

    <tr>
        <td>{{ form_widget(form) }}</td>
        <td>{{ form.vars.label }}</td>
        <td>
            {{ entity.name }} | {{ entity.group }}
        </td>
    </tr>
{% endblock %}