currency Field Type
Edit this pageWarning: You are browsing the documentation for Symfony 2.3, which is no longer maintained.
Read the updated version of this page for Symfony 6.3 (the current stable version).
currency Field Type
The currency
type is a subset of the
choice type that allows the user
to select from a large list of 3-letter ISO 4217 currencies.
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 currencies. 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 choice Field Type) |
Overridden options | |
Inherited options | from the choice type - empty_value - error_bubbling - expanded - multiple - preferred_choices from the form type - data - disabled - empty_data - label - label_attr - mapped - read_only - required |
Parent type | choice |
Class | CurrencyType |
Overridden Options
choices
default: Symfony\Component\Intl\Intl::getCurrencyBundle()->getCurrencyNames()
The choices option defaults to all currencies.
Inherited Options
These options inherit from the choice type:
empty_value
2.3
Since Symfony 2.3, empty values are also supported if the expanded
option is set to true.
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
$builder->add('states', 'choice', array( 'empty_value' => 'Choose an option', ));
Guarantee that no "empty" value option is displayed:
1 2 3
$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:
1 2 3 4
// a blank (with no text) option will be added
$builder->add('states', 'choice', array(
'required' => false,
));
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.
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.
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.
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:
1 2 3 4
$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:
1
{{ form_widget(form.foo_choices, { 'separator': '=====' }) }}
1 2 3
<?php echo $view['form']->widget($form['foo_choices'], array(
'separator' => '====='
)) ?>
These options inherit from the form type:
data
type: mixed
default: Defaults to field of the underlying object (if there is one)
When you create a form, each field initially displays the value of the corresponding property of the form's domain object (if an object is bound to the form). If you want to override the initial value for the form or just an individual field, you can set it in the data option:
1 2 3
$builder->add('token', 'hidden', array(
'data' => 'abcdef',
));
Note
The default values for form fields are taken directly from the underlying
data structure (e.g. an entity or an array). The data
option overrides
this default value.
disabled
2.1
The disabled
option was introduced in Symfony 2.1.
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
DEFAULT_PLACEHOLDER
This option determines what value the field will return when the submitted value is empty.
But you can customize this to your needs. For example, if you want the
gender
choice field to be explicitly set to null
when no value is
selected, you can do it like this:
1 2 3 4 5 6 7 8 9
$builder->add('gender', 'choice', array(
'choices' => array(
'm' => 'Male',
'f' => 'Female'
),
'required' => false,
'empty_value' => 'Choose your gender',
'empty_data' => null
));
Note
If you want to set the empty_data
option for your entire form class,
see the cookbook article How to Configure empty Data for a Form Class.
:end-before: DEFAULT_PLACEHOLDER
The actual default value of this option depends on other field options:
- If
multiple
isfalse
andexpanded
isfalse
, then''
(empty string); - Otherwise
array()
(empty array).
empty_data
type: mixed
DEFAULT_PLACEHOLDER
This option determines what value the field will return when the submitted value is empty.
But you can customize this to your needs. For example, if you want the
gender
choice field to be explicitly set to null
when no value is
selected, you can do it like this:
1 2 3 4 5 6 7 8 9
$builder->add('gender', 'choice', array(
'choices' => array(
'm' => 'Male',
'f' => 'Female'
),
'required' => false,
'empty_value' => 'Choose your gender',
'empty_data' => null
));
Note
If you want to set the empty_data
option for your entire form class,
see the cookbook article How to Configure empty Data for a Form Class.
:start-after: DEFAULT_PLACEHOLDER
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:
1
{{ form_label(form.name, 'Your name') }}
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:
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'))
);
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
.
read_only
type: boolean
default: false
If this option is true, the field will be rendered with the readonly
attribute so that the field is not editable.
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.