The hidden type represents a hidden input field.
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.
error_bubbling
default: true
Pass errors to the root form, otherwise they will not be visible.
required
default: false
Hidden fields cannot have a required attribute.
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:
$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.
error_mapping
New in version 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:
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
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:
$resolver->setDefaults(array(
'error_mapping' => array(
'.' => 'city',
),
));
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
.
property_path
type: any
default: the field's name
Fields display a property value of the form’s domain object by default.
When the form is submitted, the submitted value is written back into the
object.
If you want to override the property that a field reads from and writes
to, you can set the property_path
option. Its default value is the field’s
name.
If you wish the field to be ignored when reading or writing to the object
you can set the property_path
option to false
, but using
property_path
for this purpose is deprecated, you should use the
mapped
option.
New in version 2.1: The mapped
option was introduced in Symfony 2.1 for this use-case.