number Field Type

WARNING: You are browsing the documentation for Symfony 2.2 which is not maintained anymore. Consider upgrading your projects to Symfony 3.3.

number Field Type

Renders an input text field and specializes in handling number input. This type offers different options for the precision, rounding, and grouping that you want to use for your number.

Rendered as input text field
Options
Inherited options
Parent type form
Class NumberType

Field Options

precision

type: integer default: Locale-specific (usually around 3)

This specifies how many decimals will be allowed until the field rounds the submitted value (via rounding_mode). For example, if precision is set to 2, a submitted value of 20.123 will be rounded to, for example, 20.12 (depending on your rounding_mode).

rounding_mode

type: integer default: IntegerToLocalizedStringTransformer::ROUND_HALFUP

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

  • IntegerToLocalizedStringTransformer::ROUND_DOWN Rounding mode to round towards zero.
  • IntegerToLocalizedStringTransformer::ROUND_FLOOR Rounding mode to round towards negative infinity.
  • IntegerToLocalizedStringTransformer::ROUND_UP Rounding mode to round away from zero.
  • IntegerToLocalizedStringTransformer::ROUND_CEILING Rounding mode to round towards positive infinity.
  • IntegerToLocalizedStringTransformer::ROUND_HALFDOWN Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down.
  • IntegerToLocalizedStringTransformer::ROUND_HALFEVEN Rounding mode to round towards the "nearest neighbor" unless both neighbors are equidistant, in which case, round towards the even neighbor.
  • IntegerToLocalizedStringTransformer::ROUND_HALFUP Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up.

grouping

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

Inherited Options

These options inherit from the form 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. Setting to false will suppress the label. The label can also be directly set inside the template:

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

read_only

New in version 2.1: The 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

New in version 2.1: The 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.

error_mapping

type: array default: empty

New in version 2.1: The error_mapping option is new to Symfony 2.1.

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.

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 time 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: array()

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:

1
2
3
4
5
$builder->add('some_field', 'some_type', array(
    // ...
    'invalid_message'            => 'You entered an invalid value - it should include %num% letters',
    'invalid_message_parameters' => array('%num%' => 6),
));

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.