NumberType Field

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

入力テキスト フィールドをレンダリングし、数値入力の処理に特化しています。このタイプは、数値に使用するスケール、丸め、およびグループ化のさまざまなオプションを提供します。
Rendered as input text field
Default invalid message Please enter a number.
Legacy invalid message The value {{ value }} is not valid.
Parent type FormType
Class NumberType

Tip

ヒント

The full list of options defined and inherited by this form type is available running this command in your app:

このフォーム タイプによって定義および継承されるオプションの完全なリストは、アプリで次のコマンドを実行して利用できます。
1
2
# replace 'FooType' by the class name of your form type
$ php bin/console debug:form FooType

Field Options

grouping

type: boolean default: false

タイプ: ブール デフォルト: 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.

この値は、PHP の NumberFormatter クラスを使用するときに NumberFormatter::GROUPING_USEDvalue として内部的に使用されます。そのドキュメントは存在しませんが、これを true に設定すると、数値がカンマまたはピリオドでグループ化されるようです (ロケールによって異なります): 12345.123 は 12,345.123 として表示されます。

html5

type: boolean default: false

タイプ: ブール デフォルト: false

If set to true, the HTML input will be rendered as a native HTML5 type="number" form.

true に設定すると、HTML 入力はネイティブの HTML5 type="number" フォームとしてレンダリングされます。

input

type: string default: number

タイプ: 文字列 デフォルト: 数値

The format of the input data - i.e. the format that the number is stored on your underlying object. Valid values are number and string. Setting this option to string can be useful if the underlying data is a string for precision reasons (for example, Doctrine uses strings for the decimal type).

入力データの形式 - つまり、基になるオブジェクトに数値が格納される形式。有効な値は数値と文字列です。このオプションを文字列に設定すると、元になるデータが精度上の理由から文字列である場合に役立ちます (たとえば、Doctrine は decimal 型に文字列を使用します)。

scale

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

タイプ: 整数 デフォルト: ロケール固有 (通常は約 3)

This specifies how many decimals will be allowed until the field rounds the submitted value (via rounding_mode). For example, if scale 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 を介して) 送信された値を丸めるまで許容される小数点以下の桁数を指定します。たとえば、スケールが 2 に設定されている場合、送信された値 20.123 は、たとえば 20.12 に丸められます (rounding_mode によって異なります)。

rounding_mode

type: integer default: \NumberFormatter::ROUND_DOWN for IntegerType and \NumberFormatter::ROUND_HALFUP for MoneyType and NumberType

タイプ: 整数 デフォルト: IntegerType の場合は \NumberFormatter::ROUND_DOWN、MoneyType と NumberType の場合は \NumberFormatter::ROUND_HALFUP
  • IntegerType
    整数型

default: \NumberFormatter::ROUND_DOWN

デフォルト: \NumberFormatter::ROUND_DOWN
  • MoneyType and NumberType
    MoneyType と NumberType

default: \NumberFormatter::ROUND_HALFUP

デフォルト: \NumberFormatter::ROUND_HALFUP

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

送信された数値を (スケール オプションに基づいて) 丸める必要がある場合、その丸めのための構成可能なオプションがいくつかあります。各オプションは NumberFormatter クラスの定数です。
  • \NumberFormatter::ROUND_DOWN Round towards zero. It rounds 1.4 to 1 and -1.4 to -1.
    \NumberFormatter::ROUND_DOWN ゼロ方向に丸めます。 1.4 を 1 に丸め、-1.4 を -1 に丸めます。
  • \NumberFormatter::ROUND_FLOOR Round towards negative infinity. It rounds 1.4 to 1 and -1.4 to -2.
    \NumberFormatter::ROUND_FLOOR 負の無限大に向かって丸めます。 1.4 を 1 に丸め、-1.4 を -2 に丸めます。
  • \NumberFormatter::ROUND_UP Round away from zero. It rounds 1.4 to 2 and -1.4 to -2.
    \NumberFormatter::ROUND_UP ゼロ以外を丸めます。 1.4 から 2 および -1.4 から -2 に丸められます。
  • \NumberFormatter::ROUND_CEILING Round towards positive infinity. It rounds 1.4 to 2 and -1.4 to -1.
    \NumberFormatter::ROUND_CEILING 正の無限大に向かって丸めます。 1.4 を 2 に丸め、-1.4 を -1 に丸めます。
  • \NumberFormatter::ROUND_HALFDOWN Round towards the "nearest neighbor". If both neighbors are equidistant, round down. It rounds 2.5 and 1.6 to 2, 1.5 and 1.4 to 1.
    \NumberFormatter::ROUND_HALFDOWN 「最近傍」に向かって丸めます。両方の隣人が等距離にある場合は、切り捨てます。 2.5 と 1.6 を 2 に、1.5 と 1.4 を 1 に丸めます。
  • \NumberFormatter::ROUND_HALFEVEN Round towards the "nearest neighbor". If both neighbors are equidistant, round towards the even neighbor. It rounds 2.5, 1.6 and 1.5 to 2 and 1.4 to 1.
    \NumberFormatter::ROUND_HALFEVEN 「最近傍」に向かって丸めます。両方の隣人が等距離にある場合は、偶数隣人に向かって丸めます。 2.5、1.6、および 1.5 を 2 に丸め、1.4 を 1 に丸めます。
  • \NumberFormatter::ROUND_HALFUP Round towards the "nearest neighbor". If both neighbors are equidistant, round up. It rounds 2.5 to 3, 1.6 and 1.5 to 2 and 1.4 to 1.
    \NumberFormatter::ROUND_HALFUP 「最近傍」に向かって丸めます。両方の隣人が等距離にある場合は、切り上げます。 2.5 を 3 に、1.6 と 1.5 を 2 に、1.4 を 1 に丸めます。

When the html5 option is set to false, the <input> element will include an inputmode HTML attribute which depends on the value of this option. If the scale value is 0, inputmode will be numeric; if scale is set to any value greater than 0, inputmode will be decimal.

html5 オプションが false に設定されている場合、要素には、このオプションの値に依存する inputmode HTML 属性が含まれます。scale 値が 0 の場合、inputmode は数値になります。 scale が 0 より大きい値に設定されている場合、inputmode は 10 進数になります。

6.1

6.1

The automatic addition of the inputmode attribute was introduced in Symfony 6.1.

inputmode 属性の自動追加は Symfony 6.1 で導入されました。

Overridden Options

compound

type: boolean default: false

タイプ: ブール デフォルト: 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.

このオプションは、型に子型が含まれるかどうかを指定します。このオプションは、組み込み型の内部で管理されるため、明示的に構成する必要はありません。

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.

これは、たとえば、ユーザーがリアルタイムに変換できない無意味な文字列を TimeType フィールドに入力した場合、またはユーザーが文字列 (例: apple) を数値フィールドに入力した場合に発生する可能性があります。

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).

通常の (ビジネス ロジック) 検証 (フィールドの最小長を設定する場合など) は、validationrules (参照) で検証メッセージを使用して設定する必要があります。

Inherited Options

These options inherit from the FormType:

これらのオプションは FormType から継承します。

attr

type: array default: []

タイプ: 配列 デフォルト: []

If you want to add extra attributes to an HTML field representation you can use the attr option. It's an associative array with HTML attributes as keys. This can be useful when you need to set a custom class for some widget:

HTML フィールド表現に追加の属性を追加する場合は、attr オプションを使用できます。これは、HTML 属性をキーとする連想配列です。これは、一部のウィジェットにカスタム クラスを設定する必要がある場合に役立ちます。
1
2
3
$builder->add('body', TextareaType::class, [
    'attr' => ['class' => 'tinymce'],
]);

See also

こちらもご覧ください

Use the row_attr option if you want to add these attributes to the form type row element.

これらの属性をフォーム タイプの行要素に追加する場合は、row_attr オプションを使用します。

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:

フォームを作成すると、最初に各フィールドに、フォームのドメイン データの対応するプロパティの値が表示されます (たとえば、オブジェクトをフォームにバインドした場合)。フォームまたは個々のフィールドのこの初期値をオーバーライドする場合は、データ オプションで設定できます。
1
2
3
4
5
6
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.

data オプションは、レンダリング時にドメイン データ (オブジェクト) から取得した値を常にオーバーライドします。これは、フォームがすでに永続化されているオブジェクトを編集すると、オブジェクトの値も上書きされ、フォームが送信されると永続化された値が失われることを意味します。

disabled

type: boolean default: false

タイプ: ブール値デフォルト: 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.

ユーザーがフィールドの値を変更できないようにするには、disabled オプションを true に設定します。送信された値は無視されます。

empty_data

type: mixed

タイプ: 混合

The default value is '' (the empty string).

デフォルト値は '' (空の文字列) です。

This option determines what value the field will return when the submitted value is empty (or missing). It does not set an initial value if none is provided when the form is rendered in a view.

このオプションは、送信された値が空 (または欠落) の場合にフィールドが返す値を決定します。フォームがビューにレンダリングされるときに何も指定されていない場合、初期値は設定されません。

This means it helps you handling form submission with blank fields. For example, if you want the name field to be explicitly set to John Doe when no value is selected, you can do it like this:

これは、空白のフィールドでフォーム送信を処理するのに役立つことを意味します。たとえば、値が選択されていないときに名前フィールドを明示的に John Doe に設定する場合は、次のようにします。
1
2
3
4
$builder->add('name', null, [
    'required'   => false,
    'empty_data' => 'John Doe',
]);

This will still render an empty text box, but upon submission the John Doe value will be set. Use the data or placeholder options to show this initial value in the rendered form.

これでも空のテキスト ボックスが表示されますが、送信時に John Doevalue が設定されます。データまたはプレースホルダー オプションを使用して、レンダリングされたフォームでこの初期値を表示します。

If a form is compound, you can set empty_data as an array, object or closure. See the How to Configure empty Data for a Form Class article for more details about these options.

フォームが複合の場合、empty_data を配列、オブジェクト、またはクロージャーとして設定できます。これらのオプションの詳細については、フォーム クラスの空のデータを構成する方法の記事を参照してください。

Note

ノート

If you want to set the empty_data option for your entire form class, see the How to Configure empty Data for a Form Class article.

フォーム クラス全体に empty_data オプションを設定する場合は、フォーム クラスの空のデータを構成する方法の記事を参照してください。

Caution

注意

Form data transformers will still be applied to the empty_data value. This means that an empty string will be cast to null. Use a custom data transformer if you explicitly want to return the empty string.

フォーム データ トランスフォーマーは引き続き empty_data 値に適用されます。これは、空の文字列が null にキャストされることを意味します。空の文字列を明示的に返したい場合は、カスタム データ トランスフォーマーを使用します。

error_bubbling

type: boolean default: false unless the form is compound

タイプ: ブール値 デフォルト: フォームが複合でない限り 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.

true の場合、このフィールドのエラーは親フィールドまたはフォームに渡されます。たとえば、通常のフィールドで true に設定すると、そのフィールドのエラーは特定のフィールドではなく、メイン フォームに添付されます。

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.

都市と郵便番号が一致するかどうかを検証する matchingCityAndZipCode() という名前のカスタム メソッドがあるとします。残念ながら、あなたのフォームには一致する CityAndZipCode フィールドがないため、Symfony ができることはフォームの上にエラーを表示することだけです。

With customized error mapping, you can do better: map the error to the city field so that it displays above it:

カスタマイズされたエラー マッピングを使用すると、より適切に実行できます。エラーを cityfield にマッピングして、その上に表示されるようにします。
1
2
3
4
5
6
7
8
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;
    違反がクラスのプロパティまたはメソッドで生成された場合、そのパスは propertyName です。
  • If the violation is generated on an entry of an array or ArrayAccess object, the property path is [indexName];
    違反が配列または ArrayAccess オブジェクトのエントリで生成された場合、プロパティ パスは [indexName] です。
  • You can construct nested property paths by concatenating them, separating properties by dots. For example: addresses[work].matchingCityAndZipCode;
    プロパティをドットで区切って連結することにより、ネストされたプロパティ パスを作成できます。例: address[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:

デフォルトでは、マップされていないプロパティのエラーは親フォームにバブル アップします。左側のドット (.) を使用して、マップされていないすべてのプロパティのエラーを特定のフィールドにマップできます。たとえば、これらすべてのエラーを都市フィールドにマップするには、次を使用します。
1
2
3
4
5
$resolver->setDefaults([
    'error_mapping' => [
        '.' => 'city',
    ],
]);

help

type: string or TranslatableInterface default: null

タイプ: 文字列または TranslatableInterface デフォルト: null

Allows you to define a help message for the form field, which by default is rendered below the field:

フォーム フィールドのヘルプ メッセージを定義できます。デフォルトではフィールドの下に表示されます。
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'),
    ])
;

6.2

6.2

The support for TranslatableInterface objects as help contents was introduced in Symfony 6.2.

ヘルプ コンテンツとしての TranslatableInterface オブジェクトのサポートは、Symfony 6.2 で導入されました。

help_attr

type: array default: []

タイプ: 配列 デフォルト: []

Sets the HTML attributes for the element used to display the help message of the form field. Its value is an associative array with HTML attribute names as keys. These attributes can also be set in the template:

フォーム フィールドのヘルプ メッセージを表示するために使用される要素の HTML 属性を設定します。その値は、HTML 属性名をキーとする連想配列です。これらの属性は、テンプレートで設定することもできます。
1
2
3
{{ form_help(form.name, 'Your name', {
    'help_attr': {'class': 'CUSTOM_LABEL_CLASS'}
}) }}

help_html

type: boolean default: false

タイプ: ブール デフォルト: false

By default, the contents of the help option are escaped before rendering them in the template. Set this option to true to not escape them, which is useful when the help contains HTML elements.

デフォルトでは、ヘルプ オプションの内容は、テンプレートでレンダリングする前にエスケープされます。エスケープしないようにするには、このオプションを true に設定します。これは、ヘルプに HTML 要素が含まれている場合に役立ちます。

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:

invalid_message オプションを設定する場合、文字列にいくつかの変数を含める必要がある場合があります。これは、そのオプションにプレースホルダーを追加し、このオプションに変数を含めることで実行できます。
1
2
3
4
5
$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 or TranslatableMessage default: The label is "guessed" from the field name

タイプ: 文字列または TranslatableMessage デフォルト: ラベルはフィールド名から「推測」されます

Sets the label that will be used when rendering the field. Setting to false will suppress the label:

フィールドのレンダリング時に使用されるラベルを設定します。 false に設定すると、ラベルが抑制されます。
1
2
3
4
5
6
7
8
use Symfony\Component\Translation\TranslatableMessage;

$builder
    ->add('zipCode', null, [
        'label' => 'The ZIP/Postal code',
        // optionally, you can use TranslatableMessage objects as the label content
        'label' => new TranslatableMessage('address.zipCode', ['%country%' => $country], 'address'),
    ])

The label can also be set in the template:

ラベルはテンプレートで設定することもできます:
  • Twig
    小枝
  • PHP
    PHP
1
{{ 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:

フィールドのラベルをレンダリングするときに使用される要素の HTML 属性を設定します。 HTML属性をキーにした連想配列です。この属性は、テンプレート内で直接設定することもできます:
  • Twig
    小枝
  • PHP
    PHP
1
2
3
{{ form_label(form.name, 'Your name', {
    'label_attr': {'class': 'CUSTOM_LABEL_CLASS'}
}) }}

label_format

type: string default: null

タイプ: 文字列 デフォルト: 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.

label オプションが設定されていない場合に、フィールドのラベルとして使用される文字列を構成します。これは、キーワード翻訳メッセージを使用する場合に便利です。

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:

キーワード翻訳メッセージをラベルとして使用している場合、同じラベルに複数のキーワード メッセージが含まれることがよくあります (例: profile_address_street,invoice_address_street)。これは、フィールドへの「パス」ごとにラベルが作成されるためです。キーワード メッセージの重複を避けるために、次のように labelformat を静的な値に設定できます。
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%',
]);

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.

このオプションは子タイプに継承されます。上記のコードでは、両方のフォームのストリート フィールドのラベルが form.address.street キーワード メッセージを使用します。

Two variables are available in the label format:

ラベル形式では、次の 2 つの変数を使用できます。
%id%
A unique identifier for the field, consisting of the complete path to the field and the field name (e.g. profile_address_street);
フィールドへの完全なパスとフィールド名 (例: profile_address_street) で構成される、フィールドの一意の識別子。
%name%
The field name (e.g. street).
フィールド名 (通りなど)。

The default value (null) results in a "humanized" version of the field name.

デフォルト値 (null) は、フィールド名の「人間化された」バージョンになります。

Note

ノート

The label_format option is evaluated in the form theme. Make sure to update your templates in case you customized form theming.

label_format オプションは、フォーム テーマで評価されます。フォームのテーマをカスタマイズした場合は、必ずテンプレートを更新してください。

mapped

type: boolean default: true

タイプ: ブール値デフォルト: true

If you wish the field to be ignored when reading or writing to the object, you can set the mapped option to false.

オブジェクトの読み取りまたは書き込み時にフィールドを無視する場合は、マップされたオプションを false に設定できます。

required

type: boolean default: true

タイプ: ブール デフォルト: true

If true, an HTML5 required attribute will be rendered. The corresponding label will also render with a required class.

true の場合、HTML5 必須属性がレンダリングされます。対応するラベルも必要なクラスでレンダリングされます。

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.

これは表面的なものであり、検証とは無関係です。せいぜい、Symfony にフィールド タイプを推測させれば、このオプションの値は検証情報から推測されます。

Note

ノート

The required option also affects how empty data for each field is handled. For more details, see the empty_data option.

必須オプションは、各フィールドの空のデータの処理方法にも影響します。詳細については、empty_data オプションを参照してください。

row_attr

type: array default: []

タイプ: 配列 デフォルト: []

An associative array of the HTML attributes added to the element which is used to render the form type row:

フォーム タイプの行をレンダリングするために使用される要素に追加される HTML 属性の連想配列:
1
2
3
$builder->add('body', TextareaType::class, [
    'row_attr' => ['class' => 'text-editor', 'id' => '...'],
]);

See also

こちらもご覧ください

Use the attr option if you want to add these attributes to the form type widget element.

これらの属性をフォーム タイプのウィジェット要素に追加する場合は、attr オプションを使用します。