Поле RepeatedType

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

Поле 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) }}

Чтобы отобразить каждое поле индивидуально, используйте что-то вроде:

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

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-02-05

data

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

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

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

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

Warning

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

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

Дата обновления перевода 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, если вы хотите добавить эти атрибуты к к элементу виджета типа формы .