integer 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).
integer Field Type
Renders an input "number" field. Basically, this is a text field that's
good at handling data that's in an integer form. The input number
field
looks like a text box, except that - if the user's browser supports HTML5
- it will have some extra front-end functionality.
This field has different options on how to handle input values that aren't integers. By default, all non-integer values (e.g. 6.78) will round down (e.g. 6).
Rendered as | input number field |
Options | |
Overridden options | |
Inherited options | |
Parent type | form |
Class | IntegerType |
Field Options
grouping
type: integer
default: false
This value is used internally as the NumberFormatter::GROUPING_USED
value when using PHP's NumberFormatter
class. Its documentation is
non-existent, but it appears that if you set this to true
, numbers will
be grouped with a comma or period (depending on your locale): 12345.123
would display as 12,345.123
.
precision
type: integer
default: Locale-specific (usually around 3
)
This specifies how many decimals will be allowed until the field rounds
the submitted value (via rounding_mode
). For example, if precision
is set to 2
, a submitted value of 20.123
will be rounded to,
for example, 20.12
(depending on your rounding_mode
).
rounding_mode
type: integer
default: IntegerToLocalizedStringTransformer::ROUND_DOWN
By default, if the user enters a non-integer number, it will be rounded down. There are several other rounding methods and each is a constant on the IntegerToLocalizedStringTransformer:
IntegerToLocalizedStringTransformer::ROUND_DOWN
Rounding mode to round towards zero.IntegerToLocalizedStringTransformer::ROUND_FLOOR
Rounding mode to round towards negative infinity.IntegerToLocalizedStringTransformer::ROUND_UP
Rounding mode to round away from zero.IntegerToLocalizedStringTransformer::ROUND_CEILING
Rounding mode to round towards positive infinity.
Overridden Options
compound
type: boolean
default: false
This option specifies whether the type contains child types or not. This option is managed internally for built-in types, so there is no need to configure it explicitly.
Inherited Options
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 default value is ''
(the empty string).
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
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
2.1
The error_mapping
option was introduced in Symfony 2.1.
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 setDefaultOptions(OptionsResolverInterface $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
orArrayAccess
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',
),
));
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 time 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).
invalid_message_parameters
type: array
default: array()
When setting the invalid_message
option, you may need to
include some variables in the string. This can be done by adding placeholders
to that option and including the variables in this option:
1 2 3 4 5
$builder->add('some_field', 'some_type', array(
// ...
'invalid_message' => 'You entered an invalid value, it should include %num% letters',
'invalid_message_parameters' => array('%num%' => 6),
));
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.