EnumType Field

A multi-purpose field used to allow the user to "choose" one or more options defined in a PHP enumeration. It extends the ChoiceType field and defines the same options.

ユーザーが PHP 列挙で定義された 1 つ以上のオプションを「選択」できるようにするために使用される多目的フィールド。 ChoiceTypefield を拡張し、同じオプションを定義します。
Rendered as can be various tags (see below)
Default invalid message The selected choice is invalid.
Legacy invalid message The value {{ value }} is not valid.
Parent type ChoiceType
Class EnumType

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

Example Usage

Before using this field, you'll need to have some PHP enumeration (or "enum" for short) defined somewhere in your application. This enum has to be of type "backed enum", where each keyword defines a scalar value such as a string:

このフィールドを使用する前に、アプリケーションのどこかに PHP 列挙 (略して「列挙」) を定義する必要があります。この列挙型は「backed enum」型である必要があり、各キーワードは文字列などのスカラー値を定義します。
1
2
3
4
5
6
7
8
9
// src/Config/TextAlign.php
namespace App\Config;

enum TextAlign: string
{
    case Left = 'Left aligned';
    case Center = 'Center aligned';
    case Right = 'Right aligned';
}

Instead of using the values of the enumeration in a choices option, the EnumType only requires to define the class option pointing to the enum:

選択肢オプションで列挙型の値を使用する代わりに、theEnumType は、列挙型を指すクラス オプションを定義するだけで済みます。
1
2
3
4
5
use App\Config\TextAlign;
use Symfony\Component\Form\Extension\Core\Type\EnumType;
// ...

$builder->add('alignment', EnumType::class, ['class' => TextAlign::class]);

This will display a <select> tag with the three possible values defined in the TextAlign enum. Use the expanded and multiple options to display these values as <input type="checkbox"> or <input type="radio">.

これにより、TextAlign 列挙で定義された 3 つの可能な値を持つタグが表示されます。展開された複数のオプションを使用して、これらの値をまたはとして表示します。

The label displayed in the <option> elements of the <select> is the enum name. PHP defines some strict rules for these names (e.g. they can't contain dots or spaces). If you need more flexibility for these labels, use the choice_label option and define a function that returns the custom label:

の要素に表示されるラベルは列挙名です。 PHP は、これらの名前に対していくつかの厳密な規則を定義しています (たとえば、ドットやスペースを含めることはできません)。これらのラベルにさらに柔軟性が必要な場合は、choice_label オプションを使用して、カスタム ラベルを返す関数を定義します。
1
2
3
4
5
6
7
8
->add('textAlign', EnumType::class, [
    'class' => TextAlign::class,
    'choice_label' => fn ($choice) => match ($choice) {
        TextAlign::Left => 'text_align.left.label',
        TextAlign::Center => 'text_align.center.label',
        TextAlign::Right  => 'text_align.right.label',
    },
]);

Field Options

class

type: string default: (it has no default)

type: 文字列 default: (デフォルトはありません)

The fully-qualified class name (FQCN) of the PHP enum used to get the values displayed by this form field.

このフォーム フィールドによって表示される値を取得するために使用される PHP 列挙型の完全修飾クラス名 (FQCN)。

Inherited Options

These options inherit from the ChoiceType:

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

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',
    ],
]);

expanded

type: boolean default: false

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

If set to true, radio buttons or checkboxes will be rendered (depending on the multiple value). If false, a select element will be rendered.

true に設定すると、ラジオ ボタンまたはチェックボックスが表示されます (複数の値に応じて)。 false の場合、select 要素がレンダリングされます。

multiple

type: boolean default: false

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

If true, the user will be able to select multiple options (as opposed to choosing just one option). Depending on the value of the expanded option, this will render either a select tag or checkboxes if true and a select tag or radio buttons if false. The returned value will be an array.

true の場合、ユーザーは (1 つのオプションのみを選択するのではなく) 複数のオプションを選択できます。 Expandedoption の値に応じて、true の場合は選択タグまたはチェックボックスがレンダリングされ、false の場合は選択タグまたはラジオ ボタンがレンダリングされます。戻り値は配列になります。

placeholder

type: string or boolean

タイプ: 文字列またはブール値

This option determines whether or not a special "empty" option (e.g. "Choose an option") will appear at the top of a select widget. This option only applies if the multiple option is set to false.

このオプションは、特別な「空の」オプション (「オプションの選択」など) を選択ウィジェットの上部に表示するかどうかを決定します。このオプションは、multiple オプションが false に設定されている場合にのみ適用されます。
  • Add an empty value with "Choose an option" as the text:

    「オプションを選択してください」という空の値をテキストとして追加します。
    1
    2
    3
    4
    5
    6
    use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
    // ...
    
    $builder->add('states', ChoiceType::class, [
        'placeholder' => 'Choose an option',
    ]);
  • Guarantee that no "empty" value option is displayed:

    「空の」値オプションが表示されないことを保証します。
    1
    2
    3
    4
    5
    6
    use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
    // ...
    
    $builder->add('states', ChoiceType::class, [
        'placeholder' => false,
    ]);

If you leave the placeholder option unset, then a blank (with no text) option will automatically be added if and only if the required option is false:

プレースホルダー オプションを未設定のままにすると、必要なオプションが false の場合にのみ、空白 (テキストなし) のオプションが自動的に追加されます。
1
2
3
4
5
6
7
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

// a blank (with no text) option will be added
$builder->add('states', ChoiceType::class, [
    'required' => false,
]);

preferred_choices

type: array, callable, string or PropertyPath default: []

タイプ: 配列、呼び出し可能、文字列または PropertyPath デフォルト: []

This option allows you to display certain choices at the top of your list with a visual separator between them and the complete list of options. If you have a form of languages, you can list the most popular on top, like Bork and Pirate:

このオプションを使用すると、リストの上部に特定の選択肢を表示し、選択肢とオプションの完全なリストを視覚的に区切ることができます。言語の形式がある場合は、Bork や Pirate など、最も人気のあるものを一番上にリストできます。
1
2
3
4
5
6
7
8
9
10
11
12
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('language', ChoiceType::class, [
    'choices' => [
        'English' => 'en',
        'Spanish' => 'es',
        'Bork' => 'muppets',
        'Pirate' => 'arr',
    ],
    'preferred_choices' => ['muppets', 'arr'],
]);

This options can also be a callback function to give you more flexibility. This might be especially useful if your values are objects:

このオプションは、柔軟性を高めるためにコールバック関数にすることもできます。これは、値がオブジェクトである場合に特に役立ちます。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
// ...

$builder->add('publishAt', ChoiceType::class, [
    'choices' => [
        'now' => new \DateTime('now'),
        'tomorrow' => new \DateTime('+1 day'),
        '1 week' => new \DateTime('+1 week'),
        '1 month' => new \DateTime('+1 month'),
    ],
    'preferred_choices' => function ($choice, $key, $value) {
        // prefer options within 3 days
        return $choice <= new \DateTime('+3 days');
    },
]);

This will "prefer" the "now" and "tomorrow" choices only:

これは、「今」と「明日」の選択肢のみを「優先」します。

Finally, if your values are objects, you can also specify a property path string on the object that will return true or false.

最後に、値がオブジェクトの場合、true または false を返すオブジェクトのプロパティ パス文字列を指定することもできます。

The preferred choices are only meaningful when rendering a select element (i.e. expanded false). The preferred choices and normal choices are separated visually by a set of dotted lines (i.e. -------------------). This can be customized when rendering the field:

優先される選択肢は、select 要素をレンダリングする場合 (つまり、expanded false) にのみ意味があります。好ましい選択肢と通常の選​​択肢は、一連の点線 (つまり -------------------) によって視覚的に区切られています。これは、フィールドをレンダリングするときにカスタマイズできます。
  • Twig
    小枝
  • PHP
    PHP
1
{{ form_widget(form.publishAt, { 'separator': '=====' }) }}

Tip

ヒント

When defining a custom type, you should use the ChoiceList class helper:

カスタム タイプを定義するときは、ChoiceList クラス ヘルパーを使用する必要があります。
1
2
3
4
5
6
use Symfony\Component\Form\ChoiceList\ChoiceList;

// ...
$builder->add('choices', ChoiceType::class, [
    'preferred_choices' => ChoiceList::preferred($this, 'taggedAsFavorite'),
]);

See the "choice_loader" option documentation.

「choice_loader」オプションのドキュメントを参照してください。

trim

type: boolean default: false

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

Trimming is disabled by default because the selected value or values must match the given choice values exactly (and they could contain whitespaces).

選択された値または値が指定された選択肢の値と正確に一致する必要があるため (空白が含まれる可能性があるため)、トリミングはデフォルトで無効になっています。

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

タイプ: 混合

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 にキャストされることを意味します。空の文字列を明示的に返したい場合は、カスタム データ トランスフォーマーを使用します。

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 要素が含まれている場合に役立ちます。

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 オプションを使用します。