You are browsing the documentation for Symfony 2.0 which is not maintained anymore.
Consider upgrading your projects to Symfony 5.2.
percent Field Type
percent Field Type¶
The percent
type renders an input text field and specializes in handling
percentage data. If your percentage data is stored as a decimal (e.g. .95
),
you can use this field out-of-the-box. If you store your data as a number
(e.g. 95
), you should set the type
option to integer
.
This field adds a percentage sign “%
” after the input box.
Rendered as | input text field |
Options | |
Inherited options | |
Parent type | field |
Class | Symfony\Component\Form\Extension\Core\Type\PercentType |
Options¶
type¶
type: string
default: fractional
This controls how your data is stored on your object. For example, a percentage
corresponding to “55%”, might be stored as .55
or 55
on your
object. The two “types” handle these two cases:
fractional
If your data is stored as a decimal (e.g..55
), use this type. The data will be multiplied by100
before being shown to the user (e.g.55
). The submitted data will be divided by100
on form submit so that the decimal value is stored (.55
);integer
If your data is stored as an integer (e.g. 55), then use this option. The raw value (55
) is shown to the user and stored on your object. Note that this only works for integer values.
precision¶
type: integer
default: 0
By default, the input numbers are rounded. To allow for more decimal places, use this option.
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¶
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.
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:
$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),
));
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.