locale Field Type¶

The locale type is a subset of the ChoiceType that allows the user to select from a large list of locales (language+country). As an added bonus, the locale names are displayed in the language of the user.

The “value” for each locale is either the two letter ISO639-1 language code (e.g. fr), or the language code followed by an underscore (_), then the ISO3166 country code (e.g. fr_FR for French/France).

Note

The locale of your user is guessed using Locale::getDefault()

Unlike the choice type, you don’t need to specify a choices or choice_list option as the field type automatically uses a large list of locales. You can specify either of these options manually, but then you should just use the choice type directly.

Rendered as	can be various tags (see Select tag, Checkboxes or Radio Buttons)
Inherited options	multiple expanded preferred_choices empty_value error_bubbling required label read_only
Parent type	choice
Class	`Symfony\Component\Form\Extension\Core\Type\LanguageType`

Inherited options¶

These options inherit from the choice type:

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.

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.

preferred_choices¶

type: array default: array()

If this option is specified, then a sub-set of all of the options will be moved to the top of the select menu. The following would move the “Baz” option to the top, with a visual separator between it and the rest of the options:

$builder->add('foo_choices', 'choice', array(
    'choices' => array('foo' => 'Foo', 'bar' => 'Bar', 'baz' => 'Baz'),
    'preferred_choices' => array('baz'),
));

Note that preferred choices are only meaningful when rendering as a select element (i.e. expanded is 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

{{ form_widget(form.foo_choices, { 'separator': '=====' }) }}

PHP

<?php echo $view['form']->widget($form['foo_choices'], array('separator' => '=====')) ?>

empty_value¶

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 both the expanded and multiple options are set to false.

Add an empty value with “Choose an option” as the text:

$builder->add('states', 'choice', array(
    'empty_value' => 'Choose an option',
));

Guarantee that no “empty” value option is displayed:

$builder->add('states', 'choice', array(
    'empty_value' => false,
));

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

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

error_bubbling¶

type: Boolean default: false

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.

These options inherit from the field type:

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.

label¶

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

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

{{ form_label(form.name, 'Your name') }}

read_only¶

type: Boolean default: false

If this option is true, the field will be rendered with the disabled attribute so that the field is not editable.