checkbox Field Type

CAUTION: You are browsing the documentation for Symfony 2.1 which is not maintained anymore. Consider upgrading your projects to Symfony 3.2.

checkbox Field Type

Creates a single input checkbox. This should always be used for a field that has a Boolean value: if the box is checked, the field will be set to true, if the box is unchecked, the value will be set to false.

Rendered as input checkbox field
Options
Inherited options
Parent type field
Class CheckboxType

Example Usage

1
2
3
4
$builder->add('public', 'checkbox', array(
    'label'     => 'Show this entry publicly?',
    'required'  => false,
));

Field Options

value

type: mixed default: 1

The value that's actually used as the value for the checkbox. This does not affect the value that's set on your object.

Inherited options

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:

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

read_only

2.1The read_only option was changed in 2.1 to render as a readonly HTML attribute. Previously, it rendered as a disabled attribute. Use the disabled option if you need the old behavior.

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.

disabled

2.1The disabled option is new in version 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.

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.

2.1The error_mapping option is new to Symfony 2.1.

error_mapping

type: array default: empty

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 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 left side of the error mapping also accepts a dot ., which refers to the field itself. That means that any error added to the field is added to the given nested field instead.
  • The right side contains simply the names of fields in the form.

mapped

type: boolean

If you wish the field to be ignored when reading or writing to the object, you can set the mapped option to false.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.