Поле RepeatedType

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

Поле RepeatedType

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

?????????????? ?? ???? ???????? text ?? ?????????????, ??? ???. ????? type
???????????? ???????????? ?? ????????????? ???????? ?? ???????????.
???????????? ??? FormType
???? RepeatedType

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

Tip

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

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

Приклад використання

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

$builder->add('password', RepeatedType::class, [
    'type' => PasswordType::class,
    'invalid_message' => 'The password fields must match.',
    'options' => ['attr' => ['class' => 'password-field']],
    'required' => true,
    'first_options'  => ['label' => 'Password'],
    'second_options' => ['label' => 'Repeat Password'],
]);

При успішному відправленні форми, значення, введене в обидва поля "пароль" стає даними ключа password. Іншими словами, хоча відображаються два поля, кінцеві дані форми - одне значення (зазвичай рядок), яке вам потрібно.

Найважливіша опція - type, яка може бути будь-яким типом поля та визначає справжній тип двох основних полів. Опція options передається кожному з цих індивідуальних полів, що означає (у цьому прикладі), що будь-яка опція, підтримувана PasswordType може бути передана у цей масив.

Відображення

Повторюваний тип поля насправді - два поля, що лежать в основі, які ви можете відображати одночасно або по черзі. Щоб відобразити їх одночасно, використайте щось на кшталт:

1
{{ form_row(form.password) }}

Щоб відобразити кожне поле індивідуально, використайте щось на кшталт:

{# .first і .second у вас можуть відрізнятися - див. примітку нижче #} {{ form_row(form.password.first) }} {{ form_row(form.password.second) }}

Note

Імена first і second - це імена за замовчуванням для двох підполів. Однак, ці імена можна контролювати через опції first_name і second_name. Якщо ви встановили ці опції, то вкористовуйте ці два значення замість first і second при відображенні.

Валідація

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

invalid_message використовується для налаштування помилки, яка буде відображена, коли два поля не будуть співпадати.

Note

Опція mapped завжди true для обох полів для того, щоб тип працював правильно.

Опції поля

first_name

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

Це справжнє імʼя поля, яке буде використано для першого поля. В основному це марно, однак, дані, введені в обидва поля, будуть доступні під ключем, призначеним самому полю RepeatedType (наприклад, password). Однак, якщо ви не вкажете ярлик, імʼя цього поля буде використано для "визначення" ярлику для вас.

first_options

тип: array за замовчуванням: array()

Додаткові опції (будуть обʼєднані в options нижче), які повинні бути передані лише першому полю. Це дуже корисно для налаштування ярлику:

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

$builder->add('password', RepeatedType::class, array(
    'first_options'  => array('label' => 'Password'),
    'second_options' => array('label' => 'Repeat Password'),
));

options

тип: array за замовчуванням: array()

Цей масив опцій буде переданий кожному з двох основних полів. Іншими словами, це ті опції, які налаштовують індивідуальні типи полів. Наприклад, якщо опція type встановлена як password, то цей масив може містити опції always_empty або required - обидві опції, які підтримуються полем PasswordType.

second_name

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

Те ж саме, що і first_name, але для другого поля.

second_options

тип: array за замовчуванням: array()

Додаткові опції (будуть обʼєднані в options нижче), які повинні бути передані лише другому полю. Це дуже корисно для налаштування ярлику (див. first_options).

type

тип: string за замовчуванням: Symfony\Component\Form\Extension\Core\Type\TextType

Два основних поля будуть цим типом поля. Наприклад, передача PasswordType::class відобразить два поля паролів.

Перевизначені опції

error_bubbling

за замовчуванням: false

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

invalid_message

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

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

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

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

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

Ці опції наслідуються з FormType:

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

attr

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

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

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

See also

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

Дата оновлення перекладу 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 завжди перевизначає значення, взяте з даних домену (об'єкта) під час відображення. Це означає, що значення об'єкта також перевизначається,
коли форма редагує вже збережений об'єкт, що призводить до втрати
збереженого значення, коли форма буде відправлена.

Дата оновлення перекладу 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',
    ],
]);

Дата оновлення перекладу 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

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

mapped

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

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

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

row_attr

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

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

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

See also

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