Поле FormType

Дата обновления перевода 2021-06-08

Поле FormType

FormType предопределяет несколько опций, которые потом доступны во всех типах, родителями которых является FormType.

Tip

The full list of options defined and inherited by this form type is available running this command in your app:

1
2
# replace 'FooType' by the class name of your form type
$ php bin/console debug:form FooType

Опции поля

action

тип: string default: пустая строка

Эта опция указывает, куда отправить данные формы при отправке (обычно URI). Её значение отображается как атрибут action элемента form. Пустое значение считается ссылкой на тот же документ, т.е. форма будет отправлена по тому же URI, что и отображённая форма.

allow_extra_fields

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

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

Вы можете отключить эту ошибку валидации, включив в форме опцию allow_extra_fields.

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

compound

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

Эта опция указывает, является ли форма составно. Это не зависит от того, есть ли у формы дочерние формы. Форма может быть составной, но не иметь дочерей вообще (например, пустая коллекция форм).

constraints

тип: array или Constraint по умолчанию: null

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

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

data_class

тип: string

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

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

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

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

Note

Если вы хотите установить опцию empty_data для всего вашего класса форм, см. статью Как сконфигурировать пустые данные для класса формы.

Caution

Преобразователи данных формы всё ещё будут применяться к значению empty_data. Это означает, что пустая строка будет преобразована в null. Используйте пользовательский преобразователь данных, если вы хотите ясно вернуть пустую строку.

:end-before: DEFAULT_PLACEHOLDER

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

  • Если data_class установлена, а required - true, то - new $data_class();
  • Если data_class установлена, а required - false, то - null;
  • Если data_class не установлена, а compound - true, то - array() (пустой массив);
  • Если data_class не установлена, а compound - 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 в качестве массива, объекта или замыкания. См. статью Как сконфигурировать пустые данные для класса формы , чтобы узнать больше об этих опциях.

Note

Если вы хотите установить опцию empty_data для всего вашего класса форм, см. статью Как сконфигурировать пустые данные для класса формы.

Caution

Преобразователи данных формы всё ещё будут применяться к значению empty_data. Это означает, что пустая строка будет преобразована в null. Используйте пользовательский преобразователь данных, если вы хотите ясно вернуть пустую строку.

:start-after: DEFAULT_PLACEHOLDER

error_bubbling

тип: boolean по умолчанию: false, кроме случаев, когда форма compound

Если true, то любые ошибки в этом поле будут переданы родительскому полю или форме. Например, если установлена, как true в нормальном поле, то любые ошибки для этого поля будут присоединены к главной форме, а не к конкретному полю.

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

extra_fields_message

тип: string по умолчанию: Эта форма не должна содержать лишних полей.

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

form_attr

type: boolean or string default: false

When true and used on a form element, it adds a "form" attribute to its HTML field representation with its HTML form id. By doing this, a form element can be rendered outside the HTML form while still working as expected:

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

This can be useful when you need to solve nested form problems. You can also set this to true on a root form to automatically set the "form" attribute on all its children.

Note

When the root form has no ID, form_attr is required to be a string identifier to be used as the form ID.

help

type: string or TranslatableInterface default: null

Allows you to define a help message for the form field, which by default is rendered below the field:

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

The support for TranslatableInterface objects as help contents was introduced in 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.

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.

inherit_data

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

Эта опция определяет, будет ли форма наследовать данные из родительской формы. Это может быть полезной, если у вас есть набор полей, которые повторяется в нескольких формах. См. Как уменьшить дублирование кода с помощью "inherit_data".

Caution

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

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

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

label_attr

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

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

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

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

Note

Опция label_format оценивается в теме формы. Убедитесь в том, что вы обновили ваши щаблоны, в случае, если вы настраивали темизацию форм.

mapped

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

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

method

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

Эта опция указывает HTTP-метод, использованный для отправки данных формы. Его значение отображается, как атрибут method элемента form и используется для того, чтобы решить, обрабатывать ли отправку формы в методе handleRequest() после её отправки. Возможные значения:

  • POST
  • GET
  • PUT
  • DELETE
  • PATCH

Note

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

Note

Метод PATCH позволяет отправку частичных данных. Другими словами, если в данных отправленной формы отсутствуют определённые поля, то они будут проигнорированы, и будут использованы (если нужно) значения по умолчанию. Со всеми другими HTTP-методами, если в данных отправленной формы отсутствуют некоторые поля, то эти поля устаналиваются, как null.

post_max_size_message

тип: string по умолчанию: Загруженный файл был слишком большой. Пожалуйста, попробуйте загрузить файл поменьше.

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

Note

Валидация post_max_size происходит только в корневой форме.

property_path

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

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

Если вы хотите переопределить свойство, из которого считывает и в которое записывает поле, то вы можете установить опцию property_path. Её значение по умолчанию - (null) - будет использовать имя поля в качестве свойства.

required

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

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

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

Note

Обязательная опция также влияет на то, как будут обработаны пустые данные для каждого поля. Чтобы узнать больше, см. опцию empty_data.

trim

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

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

validation_groups

type: array, string, callable, GroupSequence or null default: null

This option is only valid on the root form and is used to specify which groups will be used by the validator.

For null the validator will just use the Default group.

If you specify the groups as an array or string they will be used by the validator as they are:

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

This is equivalent to passing the group as array:

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

The form's data will be validated against all given groups.

If the validation groups depend on the form's data a callable may be passed to the option. Symfony will then pass the form when calling it:

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)
{
    $resolver->setDefaults([
        'validation_groups' => function (FormInterface $form) {
            $entity = $form->getData();

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

Note

When your form contains multiple submit buttons, you can change the validation group depending on which button is used to submit the form.

If you need advanced logic to determine the validation groups have a look at Как динамически конфигурировать группы валидации форм.

In some cases, you want to validate your groups step by step. To do this, you can pass a GroupSequence to this option. This enables you to validate against multiple groups, like when you pass multiple groups in an array, but with the difference that a group is only validated if the previous groups pass without errors. Here's an example:

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)
    {
        $resolver->setDefaults([
            'validation_groups' => new GroupSequence(['First', 'Second']),
        ]);
    }
}

Наследуемые опции

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

attr

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

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

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

auto_initialize

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

Внутренняя опция: устаналивает то, должна ли форма быть инициализирована автоматически. Из всех полей эта опция должна быть true лля корневых форм. Вам не нужно менять эту опцию и скорее всего не придётся о ней беспокоиться.

block_name

тип: string по умолчанию: имя формы (см. Как узнать, какой блок настраивать)

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

block_prefix

type: string or null default: null (see Knowing which block to customize)

Allows you to add a custom block prefix and override the block name used to render the form type. Useful for example if you have multiple instances of the same form and you need to personalize the rendering of all of them without the need to create a new form type.

disabled

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

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

label

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

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

  • Twig
  • PHP
1
{{ form_label(form.name, 'Your name') }}

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.

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.

translation_domain

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

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

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.

priority

type: integer default: 0

Fields are rendered in the same order as they are included in the form. This option changes the field rendering priority, allowing you to display fields earlier or later than their original order.

This option will affect the view order only. The higher this priority, the earlier the field will be rendered. Priority can also be negative and fields with the same priority will keep their original order.