Поле MoneyType¶
Отображает текстовое поле ввода и специализируется на обработке отправленных данных о “деньгах”.
Этот тип поля позволяет вам указать валюту, символ которой отображается рядом с текстовым полем. Существует также несколько других опций для настройки того, как обрабатываются данные ввода и вывода.
Отображается как | поле input text |
|
|
Наследуемые опции | |
Родительский тип | FormType |
Класс | MoneyType |
Опции поля¶
currency¶
тип: string
по умолчанию: EUR
Указывает валюту, в которой были указаны деньги. Определяет символ валюты, который должен быть отображён возле текстового поля. В зависимости от валюты - символ валюты может быть отображён до или после текстового поля ввода.
Это может быть любой 3-буквенный код ISO 4217. Вы также можете установить опцию, как “false”, чтобы скрыть символ валюты.
divisor¶
тип: integer
по умолчанию: 1
Если, по какой-то причине, вам нужно поделить ваше начальное значение на
число, до того, как отображать его пользователю, вы можете использовать
опцию divisor
. Например:
use Symfony\Component\Form\Extension\Core\Type\MoneyType;
// ...
$builder->add('price', MoneyType::class, array(
'divisor' => 100,
));
В этом случае, если поле price
установлено, как 9900
, то значение
99
будет автоматически отображено пользователю. Когда пользователь отправляет
значение 99
, оно будет умножено на 100
и 9900
будет установлено в
вашем объектк.
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
.
scale¶
тип: integer
по умолчанию: 2
Если, по какой-то причине, вам нужна какая-то шкала, кроме 2 десятичных
разрядов, вы можете изменить это значение. Вам скорее всего не понадобится
это делать, разве что, к примеру, вы не захотите округлять до ближайшего
доллара(установите шкалу, как 0
).
Переопределённые опции¶
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.
Наследуемые опции¶
Эти опции наследуются из FormType:
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.
Значение по умолчанию - ''
(пустая строка).
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
orArrayAccess
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',
],
]);
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 set in the template:
- Twig
1
{{ form_label(form.name, 'Your name') }}
- PHP
1 2 3 4
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
1 2 3
{{ form_label(form.name, 'Your name', { 'label_attr': {'class': 'CUSTOM_LABEL_CLASS'} }) }}
- PHP
1 2 3 4 5
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.
Переменные формы¶
Переменная | Тип | Применение |
---|---|---|
money_pattern | string |
Формат, используемый для отображения денег, включая валюту. |
Эта документация является переводом официальной документации Symfony и предоставляется по свободной лицензии CC BY-SA 3.0.