Поле EntityType

Поле EntityType

Специальное поле ChoiceType, которое создано для загрузки опций из сущности Doctrine. Например, еслиу вас есть сущность Category, то вы могли бы использовать это поле для отображения поля select всех или некоторых объектов Category из БД.

Отображается как может быть разными тегами (см. Select Tag, Checkboxes or Radio Buttons)
Опции | - choice_label

Переопределённые | - choice_name опции | - choice_value

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

из ChoiceType:

из FormType:

Родительский тип ChoiceType
Класс EntityType

Базовое применение

Тип entity имеет только одну обязательную опцию: сущность, которая должна быть указана внутри поля выбора:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
use Symfony\Bridge\Doctrine\Form\Type\EntityType;
// ...

$builder->add('users', EntityType::class, array(
    // запрос выборов из этой сущности
    'class' => 'AppBundle:User',

    // использовать свойство имени пользователя User в качестве видимой строки опции
    'choice_label' => 'username',

    // используется для отображения поля выбора, кнопок-флажков или селективных кнопок
    // 'multiple' => true,
    // 'expanded' => true,
));

Это построит выпадающее меню select, содержащее все объекты User в БД. Чтобы вмето этого отобразить селективные кнопки или кнопки-флажки, измените опции multiple и expanded.

Использование пользовательского запроса для сущностей

Если вы хотите создать пользовательский запрос для использования при вызове сущностей (например, вы хотите только вернуть некоторые сущности, или вам нужно упорядочить их), используйте опцию query_builder:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
use Doctrine\ORM\EntityRepository;
use Symfony\Bridge\Doctrine\Form\Type\EntityType;
// ...

$builder->add('users', EntityType::class, array(
    'class' => 'AppBundle:User',
    'query_builder' => function (EntityRepository $er) {
        return $er->createQueryBuilder('u')
            ->orderBy('u.username', 'ASC');
    },
    'choice_label' => 'username',
));

Использование выборов

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

Например, если у вас есть переменная $group (возможно переданная в вашу форму, как опция формы) и getUsers() возвращает коллекцию сущностей User, то вы можете предоставить опцию choices напрямую:

1
2
3
4
5
6
7
use Symfony\Bridge\Doctrine\Form\Type\EntityType;
// ...

$builder->add('users', EntityType::class, array(
    'class' => 'AppBundle:User',
    'choices' => $group->getUsers(),
));

Select Tag, Checkboxes or Radio Buttons

This field may be rendered as one of several different HTML fields, depending on the expanded and multiple options:

Element Type Expanded Multiple
select tag false false
select tag (with multiple attribute) false true
radio buttons true false
checkboxes true true

Опции поля

choice_label

тип: string, callable или PropertyPath

Это свойство, которое должно быть использовано для отображеия сущностей, как текста в HTML-элементе:

1
2
3
4
5
6
7
use Symfony\Bridge\Doctrine\Form\Type\EntityType;
// ...

$builder->add('category', EntityType::class, array(
    'class' => 'AppBundle:Category',
    'choice_label' => 'displayName',
));

Если оставить пустым, то объект сущности будет преобразован в строку и должен иметь метод __toString(). Вы также можете передать функцию обратного вызова для большего контроля:

1
2
3
4
5
6
7
8
9
use Symfony\Bridge\Doctrine\Form\Type\EntityType;
// ...

$builder->add('category', EntityType::class, array(
    'class' => 'AppBundle:Category',
    'choice_label' => function ($category) {
        return $category->getDisplayName();
    }
));

Метод вызывается для каждой сущности в списке ипередаётся функции. Чтобы узнать больше, см. главную документацию choice_label.

Note

При передаче строки, опция choice_label - это путь свойства. Так что вы можете использовать что угодно, поддерживаемое компонентом PropertyAccessor

Например, если свойство переводов на самом деле - ассоциативный массив объектов, каждый с именем свойства, то вы можете сделать это:

1
2
3
4
5
6
7
use Symfony\Bridge\Doctrine\Form\Type\EntityType;
// ...

$builder->add('genre', EntityType::class, array(
   'class' => 'MyBundle:Genre',
   'choice_label' => 'translations[en].name',
));

class

тип: string обязательно

Класс вашей сущности (например, AppBundle:Category). Может быть полным именем класса (например, AppBundle\Entity\Category) или коротким дополнительным именем (как было показано ранее).

em

тип: string | Doctrine\Common\Persistence\ObjectManager по умолчанию: менеджер сушностей по умолчанию

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

query_builder

тип: Doctrine\ORM\QueryBuilder или Closure по умолчанию: null

Позволяет вам создавать пользовательский запрос для ваших выборов. См. Использование пользовательского запроса для сущностей для примера.

Значение этой опции может быть либо объектом QueryBuilder, либо Закрытием, либо null (что будет загружать все сущности). При использовании Закрытия, вам будет передан EntityRepository сущности, как единственный аргумент, и он должен возвращать QueryBuilder. Возвращение null в Закрытии приведёт к загрузке всех сущностей.

Caution

Сущность, используемая в спецификаторе FROM опции query_builder всегда будет валидировано с классом, который вы указали в оцпии формы class. Если вы вернёте другую сущность вместо использованной в вашем спецификаторе FROM (например, если вы вернёте сущность из объёдинённой таблицы), то это нарушит валидацию.

Переопределённые опции

choice_name

type: callable or string default: null

Controls the internal field name of the choice. You normally don't care about this, but in some advanced cases, you might. For example, this "name" becomes the index of the choice views in the template.

This can be a callable or a property path. See choice_label for similar usage. If null is used, an incrementing integer is used as the name.

В EntityType, это по умолчанию приравнивается к id сущности, если он может быть прочитан. Иначе, используется резервный план в виде авто-приращивания чисел.

choice_value

type: callable or string default: null

Returns the string "value" for each choice. This is used in the value attribute in HTML and submitted in the POST/PUT requests. You don't normally need to worry about this, but it might be handy when processing an API request (since you can configure the value that will be sent in the API request).

This can be a callable or a property path. See choice_label for similar usage. If null is used, an incrementing integer is used as the name.

If you are using a callable to populate choice_value, you need to check for the case that the value of the field may be null.

Caution

In Symfony 2.7, there was a small backwards-compatibility break with how the value attribute of options is generated. This is not a problem unless you rely on the option values in JavaScript. See issue #14825 for details.

В EntityType, это переопределяется, чтобы использовать id по умолчанию. Когда используется id, Doctrine только запрашивает объекты на предмет id, которые действительно были отправлены.

choices

тип: array | \Traversable по умолчанию: null

Вместо позволения опциям class и query_builder вызывать сущности, чтобы включть их для вас, вы можете передвать опцию choices напрямую. См. Использование выборов.

data_class

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

Эта опция не используется,в пользу опции class, которая обязательна для запросов сущностей.

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

Эти опции наследуются из ChoiceType:

choice_attr

type: array, callable or string default: array()

Use this to add additional HTML attributes to each choice. This can be an array of attributes (if they are the same for each choice), a callable or a property path (just like choice_label).

If an array, the keys of the choices array must be used as keys:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('attending', ChoiceType::class, array(
    'choices' => array(
        'Yes' => true,
        'No' => false,
        'Maybe' => null,
    ),
    'choice_attr' => function($val, $key, $index) {
        // adds a class like attending_yes, attending_no, etc
        return ['class' => 'attending_'.strtolower($key)];
    },
));

choice_translation_domain

type: string, boolean or null

This option determines if the choice values should be translated and in which translation domain.

The values of the choice_translation_domain option can be true (reuse the current translation domain), false (disable translation), null (uses the parent translation domain or the default domain) or a string which represents the exact translation domain to use.

expanded

type: boolean default: false

If set to true, radio buttons or checkboxes will be rendered (depending on the multiple value). If false, a select element will be rendered.

group_by

type: array, callable or string default: null

You can easily "group" options in a select simply by passing a multi-dimensional array to choices. See the Grouping Options section about that.

The group_by option is an alternative way to group choices, which gives you a bit more flexibility.

Take the following example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('publishAt', ChoiceType::class, array(
    'choices' => array(
        'now' => new \DateTime('now'),
        'tomorrow' => new \DateTime('+1 day'),
        '1 week' => new \DateTime('+1 week'),
        '1 month' => new \DateTime('+1 month')
    ),
    'group_by' => function($val, $key, $index) {
        if ($val <= new \DateTime('+3 days')) {
            return 'Soon';
        } else {
            return 'Later';
        }
    },
));

This groups the dates that are within 3 days into "Soon" and everything else into a "Later" group:

../../../_images/choice-example5.png

If you return null, the option won't be grouped. You can also pass a string "property path" that will be called to get the group. See the choice_label for details about using a property path.

multiple

type: boolean default: false

If true, the user will be able to select multiple options (as opposed to choosing just one option). Depending on the value of the expanded option, this will render either a select tag or checkboxes if true and a select tag or radio buttons if false. The returned value will be an array.

Note

Если вы работаете с коллекцией сущностей Doctrine, то будет полезно также прочитать документацию CollectionType Field. Кроме того, в статье How to Embed a Collection of Forms есть полный пример.

placeholder

type: string or boolean

This option determines whether or not a special "empty" option (e.g. "Choose an option") will appear at the top of a select widget. This option only applies if the multiple option is set to false.

  • Add an empty value with "Choose an option" as the text:

    1
    2
    3
    4
    5
    6
    use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
    // ...
    
    $builder->add('states', ChoiceType::class, array(
        'placeholder' => 'Choose an option',
    ));
    
  • Guarantee that no "empty" value option is displayed:

    1
    2
    3
    4
    5
    6
    use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
    // ...
    
    $builder->add('states', ChoiceType::class, array(
        'placeholder' => false,
    ));
    

If you leave the placeholder option unset, then a blank (with no text) option will automatically be added if and only if the required option is false:

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

// a blank (with no text) option will be added
$builder->add('states', ChoiceType::class, array(
    'required' => false,
));

preferred_choices

type: array, callable or string default: array()

This option allows you to move certain choices to the top of your list with a visual separator between them and the rest of the options. If you have a form of languages, you can list the most popular on top, like Bork Bork and Pirate:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('language', ChoiceType::class, array(
    'choices' => array(
        'English' => 'en',
        'Spanish' => 'es',
        'Bork'   => 'muppets',
        'Pirate' => 'arr'
    ),
    'preferred_choices' => array('muppets', 'arr')
));

This options can also be a callback function to give you more flexibility. This might be especially useful if your values are objects:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('publishAt', ChoiceType::class, array(
    'choices' => array(
        'now' => new \DateTime('now'),
        'tomorrow' => new \DateTime('+1 day'),
        '1 week' => new \DateTime('+1 week'),
        '1 month' => new \DateTime('+1 month')
    ),
    'preferred_choices' => function ($val, $key) {
        // prefer options within 3 days
        return $val <= new \DateTime('+3 days');
    },
));

This will "prefer" the "now" and "tomorrow" choices only:

../../../_images/choice-example3.png

Finally, if your values are objects, you can also specify a property path string on the object that will return true or false.

The preferred choices are only meaningful when rendering a select element (i.e. expanded false). The preferred choices and normal choices are separated visually by a set of dotted lines (i.e. -------------------). This can be customized when rendering the field:

  • Twig
    1
    {{ form_widget(form.publishAt, { 'separator': '=====' }) }}
    
  • PHP
    1
    2
    3
    <?php echo $view['form']->widget($form['publishAt'], array(
              'separator' => '====='
    )) ?>
    

Note

Эта опция ожидает массив объектов сущностей (что на самом деле то же самое, что и с полем ChoiceType, которое требует массив предпочитаемых "значений").

translation_domain

type: string default: messages

In case choice_translation_domain is set to true or null, this configures the exact translation domain that will be used for any labels or options that are rendered for this field

Эти опции наследуют из типа form:

data

type: mixed default: Defaults to field of the underlying structure.

When you create a form, each field initially displays the value of the corresponding property of the form's domain data (e.g. if you bind an object to the form). If you want to override this initial value for the form or an individual field, you can set it in the data option:

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

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

Caution

The data option always overrides the value taken from the domain data (object) when rendering. This means the object value is also overriden when the form edits an already persisted object, causing it to lose it's persisted value when the form is submitted.

disabled

type: boolean default: false

If you don't want a user to modify the value of a field, you can set the disabled option to true. Any submitted value will be ignored.

empty_data

type: mixed

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

  • Если multiple - false, а expanded - false, то - '' (пустая строка);
  • Иначе - array() (пустой массив).

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, array(
    '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 How to Configure empty Data for a Form Class article for more details about these options.

Note

If you want to set the empty_data option for your entire form class, see the How to Configure empty Data for a Form Class article.

Caution

Form data transformers will still be applied to the empty_data value. This means that an empty string will be cast to null. Use a custom data transformer if you explicitly want to return the empty string.

error_bubbling

type: boolean default: false unless the form is compound

If true, any errors for this field will be passed to the parent field or form. For example, if set to true on a normal field, any errors for that field will be attached to the main form, not to the specific field.

error_mapping

type: array default: array()

This option allows you to modify the target of a validation error.

Imagine you have a custom method named matchingCityAndZipCode() that validates whether the city and zip code match. Unfortunately, there is no "matchingCityAndZipCode" field in your form, so all that Symfony can do is display the error on top of the form.

With customized error mapping, you can do better: map the error to the city field so that it displays above it:

1
2
3
4
5
6
7
8
public function configureOptions(OptionsResolver $resolver)
{
    $resolver->setDefaults(array(
        'error_mapping' => array(
            'matchingCityAndZipCode' => 'city',
        ),
    ));
}

Here are the rules for the left and the right side of the mapping:

  • The left side contains property paths;
  • If the violation is generated on a property or method of a class, its path is simply propertyName;
  • If the violation is generated on an entry of an array or ArrayAccess object, the property path is [indexName];
  • You can construct nested property paths by concatenating them, separating properties by dots. For example: addresses[work].matchingCityAndZipCode;
  • The right side contains simply the names of fields in the form.

By default, errors for any property that is not mapped will bubble up to the parent form. You can use the dot (.) on the left side to map errors of all unmapped properties to a particular field. For instance, to map all these errors to the city field, use:

1
2
3
4
5
$resolver->setDefaults(array(
    'error_mapping' => array(
        '.' => 'city',
    ),
));

label

type: string default: The label is "guessed" from the field name

Sets the label that will be used when rendering the field. Setting to false will suppress the label. The label can also be directly set inside the template:

  • Twig
    1
    {{ form_label(form.name, 'Your name') }}
    
  • PHP
    1
    2
    3
    4
    echo $view['form']->label(
        $form['name'],
        'Your name'
    );
    

label_attr

type: array default: array()

Sets the HTML attributes for the <label> element, which will be used when rendering the label for the field. It's an associative array with HTML attribute as a key. This attributes can also be directly set inside the template:

  • Twig
    1
    2
    3
    {{ form_label(form.name, 'Your name', {
           'label_attr': {'class': 'CUSTOM_LABEL_CLASS'}
    }) }}
    
  • PHP
    1
    2
    3
    4
    5
    echo $view['form']->label(
        $form['name'],
        'Your name',
        array('label_attr' => array('class' => 'CUSTOM_LABEL_CLASS'))
    );
    

label_format

type: string default: null

Configures the string used as the label of the field, in case the label option was not set. This is useful when using keyword translation messages.

If you're using keyword translation messages as labels, you often end up having multiple keyword messages for the same label (e.g. profile_address_street, invoice_address_street). This is because the label is build for each "path" to a field. To avoid duplicated keyword messages, you can configure the label format to a static value, like:

1
2
3
4
5
6
7
8
// ...
$profileFormBuilder->add('address', new AddressType(), array(
    'label_format' => 'form.address.%name%',
));

$invoiceFormBuilder->add('invoice', new AddressType(), array(
    'label_format' => 'form.address.%name%',
));

This option is inherited by the child types. With the code above, the label of the street field of both forms will use the form.address.street keyword message.

Two variables are available in the label format:

%id%
A unique identifier for the field, consisting of the complete path to the field and the field name (e.g. profile_address_street);
%name%
The field name (e.g. street).

The default value (null) results in a "humanized" version of the field name.

Note

The label_format option is evaluated in the form theme. Make sure to update your templates in case you customized form theming.

mapped

type: boolean default: true

If you wish the field to be ignored when reading or writing to the object, you can set the mapped option to false.

required

type: boolean default: true

If true, an HTML5 required attribute will be rendered. The corresponding label will also render with a required class.

This is superficial and independent from validation. At best, if you let Symfony guess your field type, then the value of this option will be guessed from your validation information.

Note

The required option also affects how empty data for each field is handled. For more details, see the empty_data option.

Эта документация является переводом официальной документации Symfony и предоставляется по свободной лицензии CC BY-SA 3.0.