Поле MoneyType

Дата обновления перевода 2025-02-05

Поле MoneyType

Отображает текстовое поле ввода и специализируется на обработке отправленных данных о "деньгах".

Этот тип поля позволяет вам указать валюту, символ которой отображается рядом с текстовым полем. Существует также несколько других опций для настройки того, как обрабатываются данные ввода и вывода.

???????????? ??? ???? input text
????????? ???????????? ?? ????????? ??????????, ??????? ???????? ?????????? ?????.
???????????? ??? FormType
????? MoneyType

Дата обновления перевода 2025-02-21

Tip

Полный список опций, определенных и унаследованных этим типом формы, доступен путем
выполнения этой команды в вашем приложении:

1
2
# замените 'FooType' именем класса вашего типа формы
$ php bin/console debug:form FooType

Опции поля

currency

тип: string по умолчанию: EUR

Указывает валюту, в которой были указаны деньги. Определяет символ валюты, который должен быть отображён возле текстового поля. В зависимости от валюты - символ валюты может быть отображён до или после текстового поля ввода.

Это может быть любой 3-буквенный код ISO 4217. Вы также можете установить опцию, как "false", чтобы скрыть символ валюты.

divisor

тип: integer по умолчанию: 1

Если вам нужно поделить ваше изначальное значение на число, до того, как отображать его пользователю, вы можете использовать опцию divisor. Например, если вы храните цены в виде целых чисел, чтобы избежать ошибок округления, вы можете преобразовать значения в центы автоматически:

1
2
3
4
5
6
use Symfony\Component\Form\Extension\Core\Type\MoneyType;
// ...

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

В этом случае, если поле price установлено, как 9900, то значение 99 будет автоматически отображено пользователю. Когда пользователь отправляет значение 99, оно будет умножено на 100 и 9900 будет установлено в вашем объектк.

Дата обновления перевода 2025-02-24

grouping

тип: integer по умолчанию: false

Это значение используется внутренне, как значение NumberFormatter::GROUPING_USED при использовании класса NumberFormatter. Его документации не существует, но похоже, что если вы установите это, как true, то числа будут сгруппированы с запятой или точкой (в зависимости от вашей локали): 12345.123 будет отображаться как 12,345.123.

Дата обновления перевода 2023-09-25

rounding_mode

тип: integer по умолчанию: \NumberFormatter::ROUND_DOWN для IntegerType и \NumberFormatter::ROUND_HALFUP для MoneyType и NumberType

  • IntegerType

по умолчанию: \NumberFormatter::ROUND_DOWN

  • MoneyType, NumberType и PercentType

по умолчанию: \NumberFormatter::ROUND_HALFUP

Если предоставленное число нужно округлить (на основе опции scale), вы имеете несколько опций, которые можно сконфигурировать для этого округления. Каждая опция является константой в классе NumberFormatter:

  • \NumberFormatter::ROUND_DOWN Округлить до нуля. Округляет 1.4 до 1, а -1.4 до -1.
  • \NumberFormatter::ROUND_FLOOR Округлить до отрицательной бесконечности. Округляет 1.4 до 1, а -1.4 до -2.
  • \NumberFormatter::ROUND_UP Округлить от нуля. Округляет 1.4 до 2, а -1.4 до -2.
  • \NumberFormatter::ROUND_CEILING Округлить до положительной бесконечности.
    Округляет 1.4 до 2, а -1.4 до -1.
  • \NumberFormatter::ROUND_HALFDOWN Округлить до "ближайшего соседа". Если оба соседа равноудалены, округлить до меньшего. Округляет 2.5 и 1.6 до 2, а 1.5 и 1.4 до 1.
  • \NumberFormatter::ROUND_HALFEVEN Округлить до "ближайшего соседа". Если
    оба соседа равноудалены, округлить до целого. Округляет 2.5, 1.6 и 1.5 до 2, а 1.4 до 1.
  • \NumberFormatter::ROUND_HALFUP Округлить до "ближайшего соседа". Если оба соседа равноудалены, округлить до большего. Округляет 2.5 до 3, 1.6 и 1.5 до 2, а 1.4 до 1.

html5

тип: boolean по умолчанию: false

Если установлена как true, ввод HTML будет отображаться как нативный элемент HTML5 <input type="number">.

Warning

As HTML5 number format is normalized, it is incompatible with grouping option.

model_type

тип: string по умолчанию: float

По умолчанию значение денег преобразуется в PHP-тип float. Если вам необходимо, чтобы
значение было преобразовано в целое число (например, потому что какая-то библиотека требует, чтобы денежные значения, хранялись в центах, как целые числа), установите эту опцию как integer.

7.1

Опция model_type была представлена в Symfony 7.1.

scale

тип: integer по умолчанию: 2

Если, по какой-то причине, вам нужна какая-то шкала, кроме 2 десятичных разрядов, вы можете изменить это значение. Вам скорее всего не понадобится это делать, разве что, к примеру, вы не захотите округлять до ближайшего доллара(установите шкалу, как 0).

Переопределённые опции

Дата обновления перевода 2025-02-22

compound

тип: boolean по умолчанию: false

Эта опция указывает, содержит ли тип дочерние типы. Эта опция управляется внутренне для встроенных типов, так что нет необходимости конфигурировать её ясно.

Дата обновления перевода 2025-02-24

invalid_message

тип: string по умолчанию: Это значение не валидно

Это сообщение ошибки валидации, которое используется, если данные, введенные в это поле, не имеют смысла (т.е. валидация проходит неудачно).

Это может случиться, к примеру, если пользователь вводит в поле TimeType асбурдную строку, которая не может быть конвертирована в настоящее время, или если пользователь вводит строку (например, apple) в числовое поле.

Нормальная (программный код) валидация (например, установка минимальной длины для поля), должна быть установлена с использованием сообщений валидации с вашими правилами валидации (справочник ).

Наследуемые опции

Эти опции наследуются из FormType:

Дата обновления перевода 2025-02-21

attr

тип: array по умолчанию: []

Если вы хотите добавить дополнительные атрибуты к HTML представлению поля, то вы можете использовать опцию attr. Это ассоциативный массив с HTML-атрибутами в качестве ключей. Этоможет быть полезно, когда вам нужно установить для некоторого виджета пользовательский класс:

1
2
3
$builder->add('body', TextareaType::class, [
    'attr' => ['class' => 'tinymce'],
]);

See also

Используйте опцию row_attr, если вы хотите добавить эти атрибуты к к элементу строки типа формы

Дата обновления перевода 2025-02-05

data

тип: mixed по умолчанию : По умолчанию является полем основоположной структуры.

Когда вы создаёте форму, каждое поле изначально отображает значение соотствующего свойства данных домена формы (например, если вы привязываете объект к форме). Если вы хотите переопределить эти изначальные значения для формы или индивидуального поля, вы можете установить это в опции данных:

1
2
3
4
5
6
use Symfony\Component\Form\Extension\Core\Type\HiddenType;
// ...

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

Warning

Опция data всегда переопределяет значение, взятое из данных домена (объекта) при отображении. Это означает, что значение объекта также переопределяется, когда форма редактирует уже существующий сохранённый объект, что приводит к потере сохранённого значения при отправке формы.

Дата обновления перевода 2025-02-24

disabled

тип: boolean по умолчанию: false

Если вы не хотите, чтобы пользователь изменял значение поля, то вы можете установить опцию отключения, как "true". Любые отправленные данные будут проигнорированы.

Дата обновления перевода 2025-02-24

empty_data

тип: mixed

Значение по умолчанию - '' (пустая строка).

Дата обновления перевода 2025-02-05

Эта опция определяет, какое значение поле будет возвращать, если представленное значение пустое (или отсутствует). Она не устанавливает начальное значение, если оно не предоставлено при отображении формы в просмотре.

Это означает, что она помогает вам обрабатывать отправку формы с пустыми полями. Например, если вы хотите, чтобы поле name было явно установлено как John Doe, когда значение не выбрано, вы можете сделать это следующим образом:

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

В результате все еще будет отображаться пустое текстовое поле, но при отправке будет установлено значение John Doe. Используйте опции data или placeholder, чтобы показать это начальное значение в отображаемой форме.

Note

Если форма является составной, вы можете задать empty_data в виде массива, объекта или
замыкания. Эта опция может быть установлена для всего класса формы, см. статью Как сконфигурировать пустые данные для класса формы для получения более подробной информации об этих опциях.

Warning

Преобразователи данных формы все равно будут
применяться к значению empty_data. Это означает, что пустая строка будет будет приведена к значению null. Используйте пользовательский преобразователь данных, если вы явно хотите вернуть пустую строку.

Дата обновления перевода 2025-02-24

error_bubbling

тип: boolean по умолчанию: false, кроме случаев, когда форма compound

Если true, то любые ошибки в этом поле будут переданы родительскому полю или форме. Например, если установлена, как true в нормальном поле, то любые ошибки для этого поля будут присоединены к главной форме, а не к конкретному полю.

Дата обновления перевода 2024-07-26

error_mapping

тип: array по умолчанию: []

Эта опция позволяет вам изменять цель ошибки валидации.

Представьте, что у вас есть пользовательский метод под именем matchingCityAndZipCode(), который валидирует, совпадает ли город и почтовый индекс. К сожалению, поля "matchingCityAndZipCode" в вашей форме нет, поэтому всё, что Symfony может сделать - это отобразить ошибку наверху формы.

С настроенным отображением ошибок вы можете сделать лучше: привяжите ошибку к полю города, чтобы она отображалась над ним:

1
2
3
4
5
6
7
8
public function configureOptions(OptionsResolver $resolver): void
{
    $resolver->setDefaults([
        'error_mapping' => [
            'matchingCityAndZipCode' => 'city',
        ],
    ]);
}

Вот правила для лево- и правостороннего отображения:

  • Левая сторона содержит пути свойств;
  • Если нарушение генерируется в свойстве или методе класса, то его путь - это просто propertyName;
  • Если нарушение сгенерировано в записи объекта array или ArrayAccess,
    то путь свойства будет [indexName]; * Вы можете создать вложенные пути свойств, соединив их, разделяя свойства точками. Например: addresses[work].matchingCityAndZipCode;
  • Правая сторона содержит просто имена полей в форме.

По умолчанию, ошибки любого свойства, которое не отображенно, соберутся в родительской форме. Вы можете использовать точку (.) в левой части, чтобы привязать ошибки всех неотображённых свойств к конкретному полю. Например, чтобы привязать эти ошибки к полю city, используйте:

1
2
3
4
5
$resolver->setDefaults([
    'error_mapping' => [
        '.' => 'city',
    ],
]);

Дата обновления перевода 2024-07-26

help

тип: string или TranslatableInterface по умолчанию: null

Позволяет вам определять сообщение помощи для поля формы, которое по умолчанию отображается под полем:

1
2
3
4
5
6
7
8
9
10
11
12
13
use Symfony\Component\Translation\TranslatableMessage;

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

    // ...

    ->add('status', null, [
        'help' => new TranslatableMessage('order.status', ['%order_id%' => $order->getId()], 'store'),
    ])
;

Дата обновления перевода 2025-02-24

help_attr

тип: array по умолчанию: []

Устанавливает HTML-атрибуты для элемента, используемого для отображения сообщения помощи в поле формы. Его значение представляет собой ассоциативный массив с именами HTML-атрибутов в качестве ключей. Эти атрибуты также могут быть заданы в шаблоне:

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

Дата обновления перевода 2025-02-24

help_html

тип: boolean по умолчанию: false

По умолчанию содержание опции help экранируется перед отображением в шаблоне.
Установите для этой опции значение true, чтобы не экранировать их, что полезно,
когда справка содержит элементы HTML.

Дата обновления перевода 2025-02-24

invalid_message_parameters

тип: array по умолчанию: []

При установке опции invalid_message вам может понадобиться включить в строку некоторые переменные. Это можно сделать, добавив заполнители в эту опцию,и включив переменные в этой опции:

1
2
3
4
$builder->add('someField', SomeFormType::class, [
    // ...
    'invalid_message' => 'Вы ввели невалидное значение, оно должно содержать %num% букв',
    'invalid_message_parameters' => ['%num%' => 6],

Дата обновления перевода 2023-01-12

label

тип: string или TranslatableMessage по умолчанию: Ярлык "угадывается" из имени поля

Устанавливает ярлык, который будет использован при отображении поля. Установка, как "false" подавит ярлык:

1
2
3
4
5
6
7
8
use Symfony\Component\Translation\TranslatableMessage;

$builder
    ->add('zipCode', null, [
        'label' => 'The ZIP/Postal code',
        // по желанию, вы можете использовать объекты TranslatableMessage как содержание ярлыка
        'label' => new TranslatableMessage('address.zipCode', ['%country%' => $country], 'address'),
    ])

Ярлык также может быть установлен внутри шаблона:

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

Дата обновления перевода 2025-02-24

label_attr

тип: array по умолчанию: []

Устанавливает HTML-атрибуты для элемента <label>, который будет использован при отображении ярлыка для поля. Это ассоциативный массив с HTML-атрибутом в качестве ключа. Этот атрибут может также быть установлен прямо внутри шаблона:

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

Дата обновления перевода 2025-02-24

label_html

тип: boolean по умолчанию: false

По умолчанию, содержание опции label экранируется перед отображением в шаблоне. Установите для этой опции значение true, чтобы не экранировать ее, что может быть полезно, когда ярлык содержит HTML-элементы.

Дата обновления перевода 2025-02-24

label_format

тип: string по умолчанию: null

Конфигурирует строку, используемую в качестве ярылка поля, в случае, если опция label не была установлена. Это полезно при использовании сообщений переводов ключевых слов.

Если вы используете сообщения переводов ключевых слов в качестве ярлыков, то у вас часто будет несколько сообщений с ключевым словом для одного и того же ярлыка (например, profile_address_street, invoice_address_street). Это потому, что ярлык строится для каждого "пути" к полю. Чтобы избежать повтора сообщений ключевых слов, вы можете сконфигурировать формат ярлыка в качестве статичного значения, например:

1
2
3
4
5
6
7
8
// ...
$profileFormBuilder->add('address', AddressType::class, [
    'label_format' => 'form.address.%name%',
]);

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

Эта опция наследуется дочерними типами. С использованием вышенаписанного кода, ярлык поля street обеих форм будет использовать сообщение с ключевым словом form.address.street.

В формате ярлыка доступны две переменные:

%id%
Уникальный идентификатор для поля, состоящий из полного пути к полю и имени поля (например, profile_address_street);
%name%
Имя поля (например, street).

Значение по умолчанию (null) приводит к "человеческой" версии имени поля.

Note

Опция label_format оценивается в теме формы. Убедитесь в том, что вы обновили ваши щаблоны, в случае, если вы настраивали темизацию форм.

Дата обновления перевода 2025-02-24

mapped

тип: boolean по умолчанию: true

Если вы хотите, чтобы поле было проигнорировано про чтении или записи в него объекта, вы можете установить опцию mapped, как false.

Дата обновления перевода 2023-09-25

required

тип: boolean по умолчанию: true

Если "true", то будет отображён обязательный атрибут HTML5. Соответствующий label также отобразится с классом required.

Эта опция внешняя и не зависит от валидации. В лучшем случае, если вы позволите Symfony отгадать ваш тип поля, тогда значение этой опции будет угадано из вашей информации о валидации.

Note

Обязательная опция также влияет на то, как будут обработаны пустые данные для каждого поля. Чтобы узнать больше, см. опцию empty_data.

Дата обновления перевода 2025-02-24

row_attr

тип: array по умолчанию: []

Ассоциативный массив атрибутов HTML, добавляемых к элементу, который используется для отображения строки типа формы :

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

See also

Используйте опцию attr, если вы хотите добавить эти атрибуты к к элементу виджета типа формы .

Переменные формы

?????????? ??? ??????????
money_pattern string ??????, ???????????? ??? ??????????? ?????, ??????? ??????.