search Field Type
search Field Type¶
This renders an <input type="search" />
field, which is a text box with
special functionality supported by some browsers.
Read about the input search field at DiveIntoHTML5.info
Rendered as | input search field |
Inherited options | |
Parent type | text |
Class | Symfony\Component\Form\Extension\Core\Type\SearchType |
Inherited Options¶
These options inherit from the form type:
disabled¶
New in version 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
The default value is ''
(the empty string).
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:
$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.
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¶
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
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:
$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')) );
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
.
max_length¶
type: integer
default: null
If this option is not null, an attribute maxlength
is added, which
is used by some browsers to limit the amount of text in a field.
This is just a browser validation, so data must still be validated server-side.
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.
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.