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 | field |
Class | Symfony\Component\Form\Extension\Core\Type\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 Symfony\Component\Form\Extension\Core\DataTransformer\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 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:
{{ form_label(form.name, 'Your name') }}
read_only¶
type: Boolean
default: false
If this option is true, the field will be rendered with the disabled
attribute so that the field is not editable.
error_bubbling¶
type: Boolean
default: false
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.