Поле RepeatedType

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

Поле RepeatedType

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

?????????????? ?? ???? ???????? text ?? ?????????????, ??? ???. ????? type
???????????? ???????????? ?? ????????????? ???????? ?? ???????????.
??????????? ???????????? ???????????? ???????? {{ value }} ?? ? ????????.
???????????? ??? FormType
???? RepeatedType

Дата оновлення перекладу 2022-12-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\RepeatedType;
use Symfony\Component\Form\Extension\Core\Type\PasswordType;
// ...

$builder->add('password', RepeatedType::class, array(
    'type' => PasswordType::class,
    'invalid_message' => 'Поля паролів мають співпадати.',
    'options' => array('attr' => array('class' => 'password-field')),
    'required' => true,
    'first_options'  => array('label' => 'Password'),
    'second_options' => array('label' => 'Repeat Password'),
));

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

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

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

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

1
{{ form_row(form.password) }}

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

1
2
3
{# .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

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

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 всегда переопределяет значение, взятое из данных домена (объекта) при отображении. Это означает, что значение объекта также переопределяется, когда форма редактирует уже существующий сохранённый объект, что приводит к потере сохранённого значения при отправке формы.

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

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

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

6.2

Підтримка обʼєктів TranslatableInterface в якості змісту допомоги була представлена в 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.

invalid_message_parameters

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

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

1
2
3
4
5
$builder->add('some_field', SomeFormType::class, array(
    // ...
    'invalid_message' => 'Вы ввели невалидное значение, оно должносодержать %num% букв',
    'invalid_message_parameters' => array('%num%' => 6),
));

mapped

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

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

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.