Поле FormType

Дата оновлення перекладу 2025-01-15

Поле FormType

FormType перевизначає декілька опцій, які потім доступні у всіх типах, батьками яких є FormType.

Дата оновлення перекладу 2025-02-21

Tip

Повний список опцій, визначених та успадкованих цим типом форми, доступний шляхом виконання цієї команди у вашому додатку:

1
2
# замініть 'FooType' імʼям класу вашого типу форми
$ php bin/console debug:form FooType

Опції поля

Дата оновлення перекладу 2022-12-21

action

тип: string за замовчуванням: порожній рядок

Ця опція вказує куди відправляти дані форми при відправці (зазвичай - URI). Її значення відображається як атрибут action елемента form. Порожнє значення вважаєтья посиланням на той же документ, тобто, форма буде відправлена за тим же URI, який відобразив форму.

allow_extra_fields

тип: boolean за замовчуванням: false

Зазвичай, якщо ви відправляєте додаткові поля, які не сконфігуровані у вашій формі, ви отримаєте помилку валідації "Ця форма не має містити додаткових полів".

Ви можете відключити цю помилку валідації, додавши у формі опцію allow_extra_fields.

Дата оновлення перекладу 2025-02-22

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

Якщо 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()).

Дата оновлення перекладу 2025-02-22

compound

тип: boolean за замовчуванням: true

Зіставна форма може бути або цілим елементом <form> або групою полів форми (відображених, наприклад, всередині елементів контейнера <div> або <tr>). Зіставні форми використовують DataMapperInterface для ініціалізації їх доньок або для зворотного написання їх відправлених даних.

Проста (не зіставна) форма відображається як будь-який з цих HTML-елементів: <input> (TextType, FileType, HiddenType), <textarea> (TextareaType) або <select> (ChoiceType).

Деякі основні типи, на кшталт типів, повʼязаних з датами, або ChoiceType можуть бути простими або зіставними, залежно від їх опцій (таких як expanded або widget). Вони будуть поводитися або як прості текстові поля, або як група текстових полів чи полів вибору.

Дата оновлення перекладу 2024-05-29

constraints

тип: array або Constraint за замовчуванням: []

Дозволяє додати одне або декілька обмежень валідації до певного поля. Для отримання додаткової інформації дивіться Додавання валідації . Ця опція додається у розширенні форми FormTypeValidatorExtension.

Дата оновлення перекладу 2025-01-15

data

тип: mixed за замовчуванням: За замовчуванням - поле вихідної структури.

Коли ви створюєте форму, кожне поле спочатку відображає значення відповідної властивості доменних даних форми (наприклад, якщо ви прив'язуєте об'єкт до форми). Якщо ви хочете замінити це початкове значення для форми або окремого поля,
ви можете задати його в опції даних:

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

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

Warning

Опція data завжди перевизначає значення, взяте з даних домену (об'єкта) під час відображення. Це означає, що значення об'єкта також перевизначається,
коли форма редагує вже збережений об'єкт, що призводить до втрати
збереженого значення, коли форма буде відправлена.

Дата оновлення перекладу 2025-02-24

data_class

тип: string

Ця опція використовується для встановлення відповідного відображувача даних, який буде використовуватися формою. Таким чином, ви можете використовувати його для будь-якого типу поля форми, що вимагає об'єкта:

1
2
3
4
5
6
7
use App\Entity\Media;
use App\Form\MediaType;
// ...

$builder->add('media', MediaType::class, [
    'data_class' => Media::class,
]);

Дата оновлення перекладу 2025-01-15

Ця опція визначає, яке значення буде повертати поле, коли надіслане значення значення порожнє (або відсутнє). Вона не встановлює початкове значення, якщо його не було надано при відображенні форми у перегляді.

Це означає, що вона допомагає вам обробляти відправлення форм з порожніми полями. Наприклад, якщо ви хочете, щоб для поля name було явно встановлено значення
John Doe, коли не вибрано жодного значення, ви можете зробити це так:

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

Це все одно відобразить порожнє текстове поле, але після надсилання буде встановлено значення John Doe. Використовуйте опції data або placeholder, щоб показати це початкове значення у формі, що відображається.

Note

Якщо форма є складеною, ви можете встановити empty_data як масив, об'єкт або замикання. Ця опція може бути встановлена для всього класу форми, дивіться статтю Як сконфігурувати порожні дані для класу форми для отримання більш детальної інформації про ці опції.

Warning

Перетворювачі даних форми все одно будуть застосовані до значення empty_data. Це означає, що порожній рядок буде перетворено на null. Використовуйте власний перетворювач даних, якщо ви явно хочете повернути порожній рядок.

Справжнє значення цієї опції за замовчуванням залежить від інших опцій поля:

  • Якщо data_class встановлена, а required - true, то - new $data_class();
  • Якщо data_class встановлена, а required - false, то - null;
  • Якщо data_class не встановлена, а compound - true, то - array() (пустий масив);
  • Якщо data_class не встановлена, а compound - false, то - '' (пустий рядок).

Дата оновлення перекладу 2025-01-15

Ця опція визначає, яке значення буде повертати поле, коли надіслане значення значення порожнє (або відсутнє). Вона не встановлює початкове значення, якщо його не було надано при відображенні форми у перегляді.

Це означає, що вона допомагає вам обробляти відправлення форм з порожніми полями. Наприклад, якщо ви хочете, щоб для поля name було явно встановлено значення
John Doe, коли не вибрано жодного значення, ви можете зробити це так:

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

Це все одно відобразить порожнє текстове поле, але після надсилання буде встановлено значення John Doe. Використовуйте опції data або placeholder, щоб показати це початкове значення у формі, що відображається.

Note

Якщо форма є складеною, ви можете встановити empty_data як масив, об'єкт або замикання. Ця опція може бути встановлена для всього класу форми, дивіться статтю Як сконфігурувати порожні дані для класу форми для отримання більш детальної інформації про ці опції.

Warning

Перетворювачі даних форми все одно будуть застосовані до значення empty_data. Це означає, що порожній рядок буде перетворено на null. Використовуйте власний перетворювач даних, якщо ви явно хочете повернути порожній рядок.

is_empty_callback

тип: callable за замовчуванням: null

Це викличне бере дані форми та повертає, чи вважається значення порожніми.

Дата оновлення перекладу 2025-02-24

error_bubbling

тип: boolean за замовчуванням: false, якщо тільки форма не compound

Дата оновлення перекладу 2022-12-21

Якщо true, будь-які помилки цього поля будуть передані батьківському полю або формі. Наприклад, якщо встановлено true у нормальному полі, будь-які помилки цього поля будуть прикріплені до головної форми, а не до конкретного поля.

Дата оновлення перекладу 2024-05-30

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

Дата оновлення перекладу 2025-02-24

extra_fields_message

тип: string за замовчуванням: Ця форма не має містити зайвих полів.

Це повідомлення помилки валідації, яке використовується, якщо відправлені дані форми містять одне або більше полів, які не є частиною визначення форми. Заповнювач {{ extra_fields }} може бути використаний, щоб відобразити список відправлених імен зайвих полів, розділених комами.

Це повідомлення може бути множинним, див. форматування повідомлень у множині `
для отримання докладної інформації.

Дата оновлення перекладу 2025-02-24

form_attr

тип: boolean або string за замовчуванням: false

Якщо true і використовується в елементі форми, додає атрибут "form" до представлення поля HTML
з ідентифікатором HTML-форми. Таким чином, елемент форми може бути відображений поза HTML-формою, але при цьому працюватиме належним чином:

1
2
3
$builder->add('body', TextareaType::class, [
    'form_attr' => true,
]);

Це може бути корисно, коли вам потрібно вирішити проблеми з вкладеними формами.
Ви також можете встановити значення true для кореневої форми, щоб автоматично встановити атрибут "form" для всіх її дочірніх форм.

Note

Якщо коренева форма не має ідентифікатора, form_attr має бути рядковим ідентифікатором, який буде використано як ідентифікатор форми.

getter

тип: callable за замовчуванням: null

Якщо надано, це викличне буде викликано, щоб прочитати значення з вихідного обʼєкта, який буде використано для заповнення поля форми.

Більше інформації доступно у розділі про Як і коли використовувати мапувальники даних.

Дата оновлення перекладу 2024-05-30

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

Дата оновлення перекладу 2025-02-24

help_attr

тип: array за замовчуванням: []

Встановлює HTML-атрибути для елемента, що використовується для відображення повідомлення допомоги
у полі форми. Його значенням є асоціативним масивом з іменами HTML-атрибутів в якості ключів. Ці атрибути також можуть бути встановлені в шаблоні:

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

Дата оновлення перекладу 2025-02-24

help_html

тип: boolean за замовчуванням: false

За замовчуванням, зміст опції help екранується перед відображенням у шаблоні. Встановіть для цієї опції значення true, щоб не екранувати його, що може бути корисно, якщо довідка містить HTML-елементи.

Дата оновлення перекладу 2025-02-24

help_translation_parameters

тип: array за замовчуванням: []

Зміст опції help перекладається перед показом, тому вона може містити заповнювачі перекладу . Ця опція визначає значення, які буде використано для заміни цих заповнювачів.

Якщо надано таке повідомлення перекладу:

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

Ви можете вказати значення заповнювачів наступним чином:

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

Опція help_translation_parameters дочірніх полів об'єднана з такою самою опцією їхніх
батьків, тож дочірні поля можуть повторно використовувати та/або перевизначати будь-який із батьківських заповнювачів.

Дата оновлення перекладу 2025-01-15

inherit_data

тип: boolean за замовчуванням: false

Ця опція визначає, чи буде форма успадковувати дані з батьківської форми. Це може бути корисно, якщо у вас є набір полів, які дублюються у декількох формах. Дивіться Як зменшити дублювання коду за допомогою "inherit_data".

Warning

Коли для поля встановлено опцію inherit_data, воно використовує дані батьківської форми як є. Це означає, що Перетворювачі даних не
будуть застосовуватися до цього поля.

Дата оновлення перекладу 2025-02-24

invalid_message

тип: string за замовчуванням: Це значення не є валідним значение не валидно

Це повідомлення помилки валідації, яке використовується, якщо дані, введені у це поле, не мають сенсу (тобто валідація проходить невдало).

Це може трапитися, наприклад, якщо користувач вводить у поле TimeType асбурдний рядок, який не може бути конвертований в даний час, або якщо користувач вводить рядок (наприклад, apple) у числове поле.

Нормальна (програмний код) валідація (наприклад, встановлення мінімальної довжини для поля), має бути встановлена з використанням повідомлень валідації з вашими правилами валідації (довідник ).

Дата оновлення перекладу 2025-02-24

invalid_message_parameters

тип: array за замовчуванням: []

При встановленні опції invalid_message вам може знадобитися включити в рядок деякі змінні. Це можна зробити, додавши заповнювачі в цю опцію, та включивши змінні в цій опції:

1
2
3
4
$builder->add('someField', SomeFormType::class, [
    // ...
    'invalid_message' => 'Ви ввели невалідне значення, воно має містити %num% літер',
    'invalid_message_parameters' => ['%num%' => 6],

Дата оновлення перекладу 2025-02-24

label_attr

тип: array за замовчуванням: []

Встановлює HTML-атрибути для елемента <label>, який буде використаний при відображенні ярлика для поля. Це асоціативний масив із HTML-атрибутом в якості ключа. Цей атрибут може також бути встановлений прямо всередині шаблону:

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

Дата оновлення перекладу 2025-02-24

label_format

тип: string за замовчуванням: null

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

Якщо ви використовуєте повідомлення перекладів ключових слів як ярлики, то у вас часто буде кілька повідомлень із ключовим словом для одного й того самого ярлика (наприклад, profile_address_street, invoice_address_street). Це тому, що ярлик будується для кожного "шляху" до поля. Щоб уникнути повтору повідомлень ключових слів, ви можете конфігурувати формат ярлика як статичне значення, наприклад:

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

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

Ця опція успадковується дочірніми типами. З використанням вищенаписаного коду, ярлик поля street обох форм буде використовувати повідомлення з ключовим словом form.address.street.

У форматі ярлика доступні дві змінні:

%id%
Унікальний ідентифікатор для поля, що складається з повного шляху до поля та імені поля (наприклад, profile_address_street);
%name%
Ім'я поля (наприклад, street).

Значення за замовчуванням (null) призводить до `«людської» версії імені поля.

Note

Опція label_format оцінюється в темі форми. Переконайтеся в тому, що ви оновили ваші щаблони, у разі, якщо ви налаштовували темізацію форм.

Дата оновлення перекладу 2025-02-24

mapped

тип: boolean за замовчуванням: true

Якщо ви хочете, щоб поле було проігноровано при читанні або записі в нього обʼєкта, ви можете встановити опцію mapped як false.

Дата оновлення перекладу 2025-02-24

method

тип: string за замовчуванням: POST

Ця опція вказує HTTP-метод, використаний для надсилання даних форми. Його значення відображається, як атрибут method елемента form і використовується для того, щоб вирішити, чи обробляти відправлення форми в методі handleRequest() після її надсилання. Можливі значення:

  • POST
  • GET
  • PUT
  • DELETE
  • PATCH

Note

Коли метод - PUT, PATCH, або DELETE, Symfony автоматично відобразить приховане поле _method у вашій формі. Це використовується для "підробки" HTTP-методів, оскільки вони не підтримуються в стандартних браузерах. Це може бути корисно при використанні вимог маршрутизації методу .

Note

Метод PATCH дозволяє надсилання часткових даних. Іншими словами, якщо в даних відправленої форми відсутні певні поля, то вони будуть проігноровані, і будуть використані (якщо потрібно) значення за замовчуванням. З усіма іншими HTTP-методами, якщо в даних відправленої форми відсутні деякі поля, то ці поля встановлюються, як null.

Дата оновлення перекладу 2025-02-24

post_max_size_message

тип: string за замовчуванням: Завантажений файл був занадто великим. Будь ласка, спробуйте завантажити менший файл.

Це повідомлення помилки валідації, яке використовується, якщо дані форми POST перевищують директиву post_max_size php.ini. Заповнювач {{ max }} може бути використаний, щоб відобразити дозволений розмір.

Note

Валідація post_max_size відбувається лише у кореневій формі.

Дата оновлення перекладу 2025-02-24

property_path

тип: PropertyPathInterface|string|null за замовчуванням: null

Поля відображають значення властивості об'єкта домену форми за замовчуванням. Коли форма відправлена, відправлене значення записується назад в об'єкт.

Якщо ви хочете перевизначити властивість, з якої зчитує і в яку записує поле, то ви можете встановити опцію property_path. Її значення за замовчуванням - (null) - буде використовувати ім'я поля як властивість.

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

required

тип: boolean за замовчуванням: true

Якщо значення true, буде відображено обов'язковий атрибут HTML5. Відповідний label також буде відображено з класом required.

Це поверхнево і не залежить від валідації. У кращому випадку, якщо ви дозволите Symfony вгадати тип вашого поля, то значення цієї опції буде вгадано з вашої інформації валідації.

Note

Обов'язкова опція також впливає на те, як будуть оброблятися порожні дані для кожного поля. Для більш детальної інформації дивіться опцію empty_data.

setter

тип: callable за замовчуванням: null

Якщо надано, це зчислення буде викликано для мапування значення форми назад до вихідного обʼєкта.

Більше інформації доступно у розділі про Як і коли використовувати мапувальники даних.

Дата оновлення перекладу 2025-02-22

trim

тип: boolean за замовчуванням: true

Якщо "true", то вільний простір значення відправленого рядка буде відокремлено за допомогою функції trim, якщо дані прив'язані. Це гарантує, що якщо значення відправлено із зайвими вільними просторами, вони будуть видалені до того, як значення буде знову об'єднано з вихідним об'єктом.

Дата оновлення перекладу 2024-05-29

validation_groups

тип: array, string, callable, GroupSequence або null за замовчуванням: null

Ця опція валідна лише для кореневої форми і використовується, щоб вказати, які групи будуть використовуватися валідатором.

Для null валідатор буде використовувати групу Default.

Якщо ви вкажете групи у вигляді масиву або рядка, вони будуть використані валідатором як вони є:

1
2
3
4
5
6
public function configureOptions(OptionsResolver $resolver): void
{
    $resolver->setDefaults([
        'validation_groups' => 'Registration',
    ]);
}

Це еквівалентно передачі групи як масиву:

1
'validation_groups' => ['Registration'],

Дані форми будуть валідовані з усіма заданими групами.

Якщо групи валідації залежать від даних форми, можна передати викличне до опції. Тоді Symfony передасть формі при її виклику:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
use Symfony\Component\Form\FormInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;

// ...
public function configureOptions(OptionsResolver $resolver): void
{
    $resolver->setDefaults([
        'validation_groups' => function (FormInterface $form): array {
            $entity = $form->getData();

            return $entity->isUser() ? ['User'] : ['Company'];
        },
    ]);
}

See also

Ви можете прочитати більше про це в Як обирати групи валідації, засновані на відправлених даних.

Note

Якщо ваша форма містить кілька кнопок надсилання, ви можете змінити групу валідації залежно від того, яка кнопка використовується для відправлення форми.

Якщо вам потрібна просунута логіка для визначення груп валідації, подивіться на Як динамічно конфігурувати групи валідації форм.

У деяких випадках ви захочете валідувати групи крок за кроком. Для цього ви можете передати GroupSequence цій опції. Це дозволить вам виконувати валідувати з декількома групами, подібно до того, як ви передаєте декілька груп у масиві, але з тією різницею, що група буде валідована, тільки якщо попередні групи пройшли валідацію без помилок. Ось приклад:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Validator\Constraints\GroupSequence;
// ...

class MyType extends AbstractType
{
    // ...
    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'validation_groups' => new GroupSequence(['First', 'Second']),
        ]);
    }
}

See also

Прочитайте статтю Як послідовно застосовувати групи валідації, щоб дізнатися більше про це.

Успадковані опції

Наступні опції визначені в класі BaseType. Клас BaseType - це батьківський клас і для типу form, і для ButtonType, але це не частина дерева типу форми (тобто не може бути використаний в якості типу формі сам по собі).

Дата оновлення перекладу 2025-02-21

attr

тип: array за замовчуванням: []

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

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

See also

Використовуйте опцію row_attr, якщо ви хочете додати ці атрибути до елементу рядку типу форми .

Дата оновлення перекладу 2025-02-21

auto_initialize

тип: boolean за замовчуванням: true

Внутрішня опція: встановлює те, чи повинна форма бути ініціалізована автоматично. З усіх полів ця опція має бути true для кореневих форм. Вам не потрібно змінювати цю опцію і швидше за все не доведеться про неї турбуватися.

Дата оновлення перекладу 2025-02-21

block_name

тип: string за замовчуванням: імʼя форми (див. Як дізнатися, який блок налаштовувати )

Дозволяє вам перевизначити ім'я блоку, що використовується для відображення типу форми. Корисна, наприклад, якщо у вас є кілька примірників однієї й тієї самої форми, і вам потрібно персоналізувати відображення форм індивідуально.

Якщо ви, наприклад, встановите цю опцію як my_custom_name і поле матиме тип text, Symfony використовуватиме такі імена (і в цьому порядку), щоб знайти блок, який використовується для відображення віджета поля: _my_custom_name_widget, text_widget і form_widget.

Дата оновлення перекладу 2025-02-22

block_prefix

тип: string або null за замовчуванням: null (див Як дізнатися, який блок налаштовувати )

Дозволяє додати користувацький префікс блоку та перевизначити ім'я блоку, що використовується для відображення типу форми. Корисно, наприклад, якщо у вас є кілька екземплярів однієї і тієї ж форми і вам потрібно персоналізувати відображення для кожного з них, без необхідності створювати новий тип форми.

Дата обновления перевода 2025-02-24

disabled

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

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

Дата оновлення перекладу 2022-12-21

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') }}

Дата оновлення перекладу 2025-02-24

label_html

тип: boolean за замовчуванням: false

За замовчуванням, зміст опції label екранується перед відображенням у шаблоні. Встановіть для цієї опції значення true, щоб не екранувати її, що може бути корисно, коли ярлик містить HTML-елементи.

Дата оновлення перекладу 2025-02-24

row_attr

тип: array за замовчуванням: []

Асоціативний масив атрибутів HTML, що додаються до елементу, який використовується для відображення рядка типу форми :

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

See also

Використовуйте опцію attr, якщо ви хочете додати ці атрибути до елементу віджета типу форми .

Дата оновлення перекладу 2025-02-22

translation_domain

тип: string, null або false за замовчуванням: null

Це домен перекладу, який буде використаний для будь-якого ярлика або опції, відображених для цього поля. Використовуйте null, щоб повторно використовувати домен перекладу в батьківській формі (або домен перекладача за замовчуванням для кореневої форми). Використовуйте false, щоб вимкнути переклади.

Дата оновлення перекладу 2025-02-24

label_translation_parameters

тип: array за замовчуванням: []

Зміст опції label перекладається перед відображенням, тому вона може містити заповнювачі перекладу . Ця опція визначає значення, що використовуються для заміни цих заповнювачів.

Враховуючи це повідомлення перекладу:

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

Ви можете вказати значення заповнювачів наступним чином:

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

Опція label_translation_parameters дочірніх полів об'єднана з опцією їхніх батьків, тож дочірні поля можуть повторно використовувати та/або перевизначати будь-який із батьківських заповнювачів.

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.

Дата оновлення перекладу 2025-02-24

priority

тип: integer за замовчуванням: 0

Поля відображаються в тому ж порядку, в якому вони включені у форму. Ця опція змінює пріоритет відображення полів, дозволяючи вам відображати поля раніше або пізніше початкового порядку.

Ця опція впливає лише на порядок перегляду. Чим вищий цей пріоритет, тим раніше буде відображено поле. Пріоритет також може бути від'ємним, а поля з однаковим пріоритетом збережуть свій початковий порядок.