Добавление и удаление объектов

Если 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()).

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

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

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

error_bubbling

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

Если 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',
    ),
));

Дата обновления перевода 2023-01-12

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.

Дата обновления перевода 2023-01-12

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