Додавання та видалення об'єктів

Якщо allow_add встановлено як true, то при відправленні будь-яких непізнаних об'єктів, вони будуть непомітно додані до масиву об'єктів. В теорії це чудово, але на практиці потребує трохи більше зусиль, щоб отримати правильний клієнтський JavaScript.

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

1
2

<input type="email" id="form_emails_0" name="form[emails][0]" value="foo@foo.com" />
<input type="email" id="form_emails_1" name="form[emails][1]" value="bar@bar.com" />

Щоб дозволити вашому користувачу додати ще одну адресу, просто встановіть allow_add як true і через JavaScript відобразіть інше поле з іменем form[emails][2] (і так далі для більшої кількості полів).

Щоб полегшити це, установка опції prototype яак true дозволяє вам відобразити поле "шаблону", яке ви потім можете використовувати у вашому JavaScript, щоб допомогти вам динамічно створювати ці нові поля. Відображене поле прототипу виглядатиме так:

1
2
3
4
5

<input type="email"
    id="form_emails___name__"
    name="form[emails][__name__]"
    value=""
/>

Замінивши __name__ деяким унікальним значенням (наприклад, 2), ви можете побудувати та вставити нові HTML-поля у вашу форму.

Використовуючи jQuery, простий приклад може виглядати так. Якщо ви відображаєте всі ваші поля колекції одночасно (наприклад, form_row(form.emails)), то все ще простіше, так як атрибут data-prototype відображається автоматично для вас (з невеличкою різницею - див. нижче), і все, що вам потрібно - це такий код JavaScript:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

// add-collection-widget.js
jQuery(document).ready(function () {
    jQuery('.add-another-collection-widget').click(function (e) {
        var list = jQuery(jQuery(this).attr('data-list-selector'));
        // Спробуйте знайти лічильник списку або використайте довжину списку
        var counter = list.data('widget-counter') || list.children().length;

        // візьміть шаблон прототипу
        var newWidget = list.attr('data-prototype');
        // замініть "__name__", яке використовується в id і назві прототипу,
        // числом, унікальним для ваших електронних адрес
        // кінцеве ім'я атрибуту виглядає як name="contact[emails][2]"
        newWidget = newWidget.replace(/__name__/g, counter);
        // Збільшіть лічильник
        counter++;
        // І збережіть його, довжина не може бути використана, якщо дозволено видалення віджетів
        list.data(' widget-counter', counter);

        // створіть новий елемент списку і додайте його у список
        var newElem = jQuery(list.attr('data-widget-tags')).html(newWidget);
        newElem.appendTo(list);
    });
});

Та оновіть шаблон наступним чином:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

{{ form_start(form) }}
    {# ... #}

    {# збережіть прототип в атрибуті data-prototype #}
    <ul id="email-fields-list"
        data-prototype="{{ form_widget(form.emails.vars.prototype)|e }}"
        data-widget-tags="{{ '<li></li>'|e }}"
        data-widget-counter="{{ form.emails|length }}">
    {% for emailField in form.emails %}
        <li>
            {{ form_errors(emailField) }}
            {{ form_widget(emailField) }}
        </li>
    {% endfor %}
    </ul>

    <button type="button"
        class="add-another-collection-widget"
        data-list-selector="#email-fields-list">Add another email</button>

    {# ... #}
{{ form_end(form) }}

<script src="add-collection-widget.js"></script>

allow_add

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

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

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

allow_delete

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

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

Щоб отримати більше інформації, див. .

delete_empty

тип: Boolean або callable за замовчуванням: false

Якщо ви хочете чітко видалити абсолютно пусті записи колекцій з вашої форми, то вам потрібно встановити цю опцію як true. Однак, існуючі записи колекції будуть видалені лише якщо у вас увімкнена опція allow_delete. Інакше пусті значення залишаться.

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

1
2
3
4
5
6
7
8
9

use Symfony\Component\Form\Extension\Core\Type\CollectionType;
// ...

$builder->add('users', CollectionType::class, [
    // ...
    'delete_empty' => function (User $user = null) {
        return null === $user || empty($user->getFirstName());
    },
]);

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

entry_options

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

use Symfony\Component\Form\Extension\Core\Type\CollectionType;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('favorite_cities', CollectionType::class, array(
    'entry_type'   => ChoiceType::class,
    'entry_options'  => array(
        'choices'  => array(
            'Nashville' => 'nashville',
            'Paris'     => 'paris',
            'Berlin'    => 'berlin',
            'London'    => 'london',
        ),
    ),
));

entry_type

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

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

prototype

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

Ця опція корисна при використанні опції allow_add. Якщо true (і якщо allow_add також true), буде доступний спеціальний атрибут "прототипу", щоб ви могли відобразити приклад "Шаблону" того, як має виглядати новий елемент на вашій сторінці. Атрибут name, наданий цьому елементу - __name__. Це дозволяє вам додавати кнопку "додати ще" через JavaScript, який зчитує прототип, замінює __name__ деяким унікальним ім'ям або числом, та відображає його всередині вашої форми. При відправленні, він буде доданий у ваш основний масив завдяки опції allow_add.

Поле прототипу може бути відображено через змінну prototype у полі колекції:

1

{{ form_row(form.emails.vars.prototype) }}

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

Щоб дізнатися деталі про те, як дійсно використовувати цю опцію, див. приклад вище, а також .

prototype_data

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

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

1
2
3
4
5
6
7
8
9
10

use Symfony\Component\Form\Extension\Core\Type\CollectionType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
// ...

$builder->add('tags', CollectionType::class, [
    'entry_type' => TextType::class,
    'allow_add' => true,
    'prototype' => true,
    'prototype_data' => 'New Tag Placeholder',
]);

prototype_name

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

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

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

attr

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

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

1
2
3

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

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

This option determines what value the field will return when the submitted value is empty (or missing). It does not set an initial value if none is provided when the form is rendered in a view.

This means it helps you handling form submission with blank fields. For example, if you want the name field to be explicitly set to John Doe when no value is selected, you can do it like this:

1
2
3
4

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

This will still render an empty text box, but upon submission the John Doe value will be set. Use the data or placeholder options to show this initial value in the rendered form.

If a form is compound, you can set empty_data as an array, object or closure. See the Як сконфігурувати порожні дані для класу форми article for more details about these options.

Значення за замовчуванням - [] (пустий масив).

This option determines what value the field will return when the submitted value is empty (or missing). It does not set an initial value if none is provided when the form is rendered in a view.

This means it helps you handling form submission with blank fields. For example, if you want the name field to be explicitly set to John Doe when no value is selected, you can do it like this:

1
2
3
4

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

This will still render an empty text box, but upon submission the John Doe value will be set. Use the data or placeholder options to show this initial value in the rendered form.

If a form is compound, you can set empty_data as an array, object or closure. See the Як сконфігурувати порожні дані для класу форми article for more details about these options.

error_bubbling

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

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

Якщо 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',
    ),
));

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

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.

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

1
2
3
4

echo $view['form']->label(
    $form['name'],
    'Your name'
);

label_attr

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

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

1
2
3

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

1
2
3
4
5

echo $view['form']->label(
    $form['name'],
    'Your name',
    array('label_attr' => array('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) приводит к "человеческой" версии имени поля.

mapped

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

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

required

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

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

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

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