BoundsType Field

Rendering

The bounds field type is actually two underlying fields, which you can render all at once, or individually. To render all at once, use something like:

1

{{ form_row(form.price) }}

To render each field individually, use something like this:

1
2

{{ form_row(form.price.from) }}
{{ form_row(form.price.to) }}

The row of the field only renders the rows of the two bounds, so the label, help and errors of the field itself are not displayed. Use the from_options and to_options options to define the label and help of each bound.

Validation

When the compare option is enabled, an error is displayed if the lower bound is greater than the upper bound (both bounds can be equal).

The errors of the field itself, such as the ones caused by the validation constraints applied to it, are displayed on the from field (see the error_mapping option).

compare

type: boolean or callable default: false

Whether to check that the lower bound is not greater than the upper bound. When set to true, it compares scalar values, DateTimeInterface objects and cases of the same enum (which are ordered as they are declared). The bounds are compared using the normalized data of the inner field type, so for example a DateType is compared as a date, regardless of its input option.

For other values, pass a callable that receives the normalized data of both bounds and returns an integer lower than, equal to, or greater than zero, like the <=> operator does:

1
2
3
4
5
6
7

use Symfony\Component\Form\Extension\Core\Type\BoundsType;
// ...

$builder->add('supportedVersions', BoundsType::class, [
    'compare' => static fn (string $from, string $to): int
        => version_compare($from, $to),
]);

The bounds are not compared when any of them is empty.

compare_message

type: string default: The lower bound must not be greater than the upper bound.

The error message displayed on the from field when the compare option is enabled and the lower bound is greater than the upper bound. It's translated using the validators translation domain.

from_options

type: array default: []

Additional options (merged into options below) that are passed only to the from field. This is especially useful for customizing the label:

1
2
3
4
5
6
7

use Symfony\Component\Form\Extension\Core\Type\BoundsType;
// ...

$builder->add('price', BoundsType::class, [
    'from_options' => ['label' => 'Minimum price'],
    'to_options' => ['label' => 'Maximum price'],
]);

options

type: array default: []

This options array is passed to both underlying fields. In other words, these are the options that customize the individual field types. For example, if the type option is set to MoneyType::class, this array might contain the currency option.

to_options

type: array default: []

Additional options (merged into options above) that are passed only to the to field (see from_options).

type

type: string default: Symfony\Component\Form\Extension\Core\Type\TextType

The two underlying fields are of this field type. For example, passing DateType::class renders two date fields.

error_bubbling

default: false

This option is passed to both bounds, so their errors are displayed next to each bound instead of on the field itself, whose errors are not rendered.

error_mapping

default: ['.' => 'from']

When the Validator component is installed, the errors of the field itself are mapped to the from field.

attr

type: array default: []

If you want to add extra attributes to an HTML field representation you can use the attr option. It's an associative array with HTML attributes as keys. This can be useful when you need to set a custom class for some widget:

1
2
3

$builder->add('body', TextareaType::class, [
    'attr' => ['class' => 'tinymce'],
]);

data

type: mixed default: Defaults to field of the underlying structure.

When you create a form, each field initially displays the value of the corresponding property of the form's domain data (e.g. if you bind an object to the form). If you want to override this initial value for the form or an individual field, you can set it in the data option:

1
2
3
4
5
6

use Symfony\Component\Form\Extension\Core\Type\HiddenType;
// ...

$builder->add('token', HiddenType::class, [
    'data' => 'abcdef',
]);

data_class

type: string

This option is used to set the appropriate data mapper to be used by the form, so you can use it for any form field type which requires an object:

1
2
3
4
5
6
7

use App\Entity\Media;
use App\Form\MediaType;
// ...

$builder->add('media', MediaType::class, [
    'data_class' => Media::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.

translation_domain

type: string, null or false default: null

This is the translation domain that will be used for any label or option that is rendered for this field. Use null to reuse the translation domain of the parent form (or the default domain of the translator for the root form). Use false to disable translations.