MoneyType Field¶

Renders an input text field and specializes in handling submitted “money” data.

This field type allows you to specify a currency, whose symbol is rendered next to the text field. There are also several other options for customizing how the input and output of the data is handled.

Rendered as	`input` `text` field
Options	currency divisor grouping rounding_mode scale
Overridden options	compound
Inherited options	attr data disabled empty_data error_bubbling error_mapping help help_attr help_html invalid_message invalid_message_parameters label label_attr label_format mapped required row_attr
Parent type	FormType
Class	`MoneyType`

Tip

The full list of options defined and inherited by this form type is available running this command in your app:

# replace 'FooType' by the class name of your form type
$ php bin/console debug:form FooType

Field Options¶

currency¶

type: string default: EUR

Specifies the currency that the money is being specified in. This determines the currency symbol that should be shown by the text box. Depending on the currency - the currency symbol may be shown before or after the input text field.

This can be any 3 letter ISO 4217 code. You can also set this to false to hide the currency symbol.

divisor¶

type: integer default: 1

If you need to divide your starting value by a number before rendering it to the user, you can use the divisor option. For example if you store prices as integer in order to avoid rounding errors, you can transform values in cents automatically:

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

$builder->add('price', MoneyType::class, [
    'divisor' => 100,
]);

In this case, if the price field is set to 9900, then the value 99 will actually be rendered to the user. When the user submits the value 99, it will be multiplied by 100 and 9900 will ultimately be set back on your object.

`grouping`¶

type: boolean 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.

rounding_mode¶

type: integer default: \NumberFormatter::ROUND_HALFUP

If a submitted number needs to be rounded (based on the scale option), you have several configurable options for that rounding. Each option is a constant on the NumberFormatter class:

\NumberFormatter::ROUND_DOWN Round towards zero. It rounds 1.4 to 1 and -1.4 to -1.
\NumberFormatter::ROUND_FLOOR Round towards negative infinity. It rounds 1.4 to 1 and -1.4 to -2.
\NumberFormatter::ROUND_UP Round away from zero. It rounds 1.4 to 2 and -1.4 to -2.
\NumberFormatter::ROUND_CEILING Round towards positive infinity. It rounds 1.4 to 2 and -1.4 to -1.
\NumberFormatter::ROUND_HALFDOWN Round towards the “nearest neighbor”. If both neighbors are equidistant, round down. It rounds 2.5 and 1.6 to 2, 1.5 and 1.4 to 1.
\NumberFormatter::ROUND_HALFEVEN Round towards the “nearest neighbor”. If both neighbors are equidistant, round towards the even neighbor. It rounds 2.5, 1.6 and 1.5 to 2 and 1.4 to 1.
\NumberFormatter::ROUND_HALFUP Round towards the “nearest neighbor”. If both neighbors are equidistant, round up. It rounds 2.5 to 3, 1.6 and 1.5 to 2 and 1.4 to 1.

Deprecated since version 5.1: In Symfony versions prior to 5.1, these constants were also defined as aliases in the NumberToLocalizedStringTransformer class, but they are now deprecated in favor of the NumberFormatter constants.

scale¶

type: integer default: 2

If, for some reason, you need some scale other than 2 decimal places, you can modify this value. You probably won’t need to do this unless, for example, you want to round to the nearest dollar (set the scale to 0).

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 FormType:

`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:

$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:

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

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

Caution

The data option always overrides the value taken from the domain data (object) when rendering. This means the object value is also overridden when the form edits an already persisted object, causing it to lose its persisted value when the form is submitted.

`disabled`¶

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 (or missing). It does not set an initial value if none is provided when the form is rendered in a view.

This means it helps you handling form submission with blank fields. For example, if you want the name field to be explicitly set to John Doe when no value is selected, you can do it like this:

$builder->add('name', null, [
    'required'   => false,
    'empty_data' => 'John Doe',
]);

This will still render an empty text box, but upon submission the John Doe value will be set. Use the data or placeholder options to show this initial value in the rendered form.

If a form is compound, you can set empty_data as an array, object or closure. See the How to Configure empty Data for a Form Class article for more details about these options.

Note

If you want to set the empty_data option for your entire form class, see the How to Configure empty Data for a Form Class article.

Caution

Form data transformers will still be applied to the empty_data value. This means that an empty string will be cast to null. Use a custom data transformer if you explicitly want to return the empty string.

`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`¶

type: array default: []

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 configureOptions(OptionsResolver $resolver)
{
    $resolver->setDefaults([
        'error_mapping' => [
            '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 the 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 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([
    'error_mapping' => [
        '.' => 'city',
    ],
]);

help¶

type: string default: null

Allows you to define a help message for the form field, which by default is rendered below the field:

$builder->add('zipCode', null, [
    'help' => 'The ZIP/Postal code for your credit card\'s billing address.',
]);

help_attr¶

type: array default: []

Sets the HTML attributes for the element used to display the help message of the form field. Its value is an associative array with HTML attribute names as keys. These attributes can also be set in the template:

{{ form_help(form.name, 'Your name', {
    'help_attr': {'class': 'CUSTOM_LABEL_CLASS'}
}) }}

help_html¶

type: bool default: false

By default, the contents of the help option are escaped before rendering them in the template. Set this option to true to not escape them, which is useful when the help contains HTML elements.

`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 TimeType 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: []

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:

$builder->add('someField', SomeFormType::class, [
    // ...
    'invalid_message' => 'You entered an invalid value, it should include %num% letters',
    'invalid_message_parameters' => ['%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:

Twig

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

PHP

echo $view['form']->label(
    $form['name'],
    'Your name'
);

`label_attr`¶

type: array default: []

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

{{ form_label(form.name, 'Your name', {
    'label_attr': {'class': 'CUSTOM_LABEL_CLASS'}
}) }}

PHP

echo $view['form']->label(
    $form['name'],
    'Your name',
    ['label_attr' => ['class' => 'CUSTOM_LABEL_CLASS']]
);

`label_format`¶

type: string default: null

Configures the string used as the label of the field, in case the label option was not set. This is useful when using keyword translation messages.

If you’re using keyword translation messages as labels, you often end up having multiple keyword messages for the same label (e.g. profile_address_street, invoice_address_street). This is because the label is built for each “path” to a field. To avoid duplicated keyword messages, you can configure the label format to a static value, like:

// ...
$profileFormBuilder->add('address', AddressType::class, [
    'label_format' => 'form.address.%name%',
]);

$invoiceFormBuilder->add('invoice', AddressType::class, [
    'label_format' => 'form.address.%name%',
]);

This option is inherited by the child types. With the code above, the label of the street field of both forms will use the form.address.street keyword message.

Two variables are available in the label format:

%id%: A unique identifier for the field, consisting of the complete path to the field and the field name (e.g. profile_address_street);
%name%: The field name (e.g. street).

The default value (null) results in a “humanized” version of the field name.

Note

The label_format option is evaluated in the form theme. Make sure to update your templates in case you customized form theming.

`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.

`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 of 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.

row_attr¶

type: array default: []

An associative array of the HTML attributes added to the element which is used to render the form type row:

$builder->add('body', TextareaType::class, [
    'row_attr' => ['class' => 'text-editor', 'id' => '...'],
]);

Form Variables¶

Variable	Type	Usage
money_pattern	`string`	The format to use to display the money, including the currency.

MoneyType Field¶

Field Options¶

currency¶

divisor¶

grouping¶

rounding_mode¶

scale¶

Overridden Options¶

compound¶

Inherited Options¶

attr¶

data¶

disabled¶

empty_data¶

error_bubbling¶

error_mapping¶

help¶

help_attr¶

help_html¶

invalid_message¶

invalid_message_parameters¶

label¶

label_attr¶

label_format¶

mapped¶

required¶

row_attr¶

Form Variables¶

`grouping`¶

`compound`¶

`attr`¶

`data`¶

`disabled`¶

`empty_data`¶

`error_bubbling`¶

`error_mapping`¶

`invalid_message`¶

`invalid_message_parameters`¶

`label`¶

`label_attr`¶

`label_format`¶

`mapped`¶

`required`¶