How to Configure empty Data for a Form Class

The empty_data option allows you to specify an empty data set for your form class. This empty data set would be used if you submit your form, but haven't called setData() on your form or passed in data when you created your form. For example, in a controller:

empty_data オプションを使用すると、フォーム クラスに空のデータ セットを指定できます。この空のデータ セットは、フォームを送信しても、フォームで setData() を呼び出していないか、フォームの作成時にデータを渡していない場合に使用されます。たとえば、コントローラーでは次のようになります。
1
2
3
4
5
6
7
8
9
10
11
12
 
public function index(): Response
{
    $blog = ...;

    // $blog is passed in as the data, so the empty_data
    // option is not needed
    $form = $this->createForm(BlogType::class, $blog);

    // no data is passed in, so empty_data is
    // used to get the "starting data"
    $form = $this->createForm(BlogType::class);
}

By default, empty_data is set to null. Or, if you have specified a data_class option for your form class, it will default to a new instance of that class. That instance will be created by calling the constructor with no arguments.

デフォルトでは、empty_data は null に設定されています。または、フォーム クラスに data_class オプションを指定した場合は、デフォルトでそのクラスの新しいインスタンスになります。そのインスタンスは、引数なしでコンストラクターを呼び出すことによって作成されます。

If you want to override this default behavior, there are two ways to do this:

このデフォルトの動作をオーバーライドする場合は、次の 2 つの方法があります。

If you didn't set the data_class option, you can pass the initial data as string or pass an array of strings (where the key matches the field name) when the form type is compound.

data_class オプションを設定しなかった場合、フォーム タイプが複合の場合、初期データを文字列として渡すか、文字列の配列 (キーがフィールド名と一致する) を渡すことができます。

Option 1: Instantiate a new Class

One reason you might use this option is if you want to use a constructor that takes arguments. Remember, the default data_class option calls that constructor with no arguments:

このオプションを使用する理由の 1 つは、引数を取るコンストラクターを使用する場合です。デフォルトの data_class オプションは、引数なしでそのコンストラクターを呼び出すことに注意してください。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
// src/Form/Type/BlogType.php
namespace App\Form\Type;

// ...
use App\Entity\Blog;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\OptionsResolver\OptionsResolver;

class BlogType extends AbstractType
{
    private $someDependency;

    public function __construct($someDependency)
    {
        $this->someDependency = $someDependency;
    }
    // ...

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'empty_data' => new Blog($this->someDependency),
        ]);
    }
}

You can instantiate your class however you want. In this example, you pass some dependency into the BlogType then use that to instantiate the Blog class. The point is, you can set empty_data to the exact "new" object that you want to use.

必要に応じてクラスをインスタンス化できます。この例では、いくつかの依存関係を BlogType に渡し、それを使用して Blog クラスをインスタンス化します。要点は、使用する正確な「新しい」オブジェクトに empty_data を設定できることです。

Tip

ヒント

In order to pass arguments to the BlogType constructor, you'll need to register the form as a service and tag it with form.type. If you're using the default services.yaml configuration, this is already done for you.

引数を BlogType コンストラクターに渡すには、フォームをサービスとして登録し、form.type でタグ付けする必要があります。デフォルトの services.yaml 構成を使用している場合、これは既に行われています。

Option 2: Provide a Closure

Using a closure is the preferred method, since it will only create the object if it is needed.

必要な場合にのみオブジェクトを作成するため、クロージャーを使用することをお勧めします。

The closure must accept a FormInterface instance as the first argument:

クロージャーは、最初の引数として FormInterface インスタンスを受け入れる必要があります。
1
2
3
4
5
6
7
8
9
10
11
12
 
use Symfony\Component\Form\FormInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
// ...

public function configureOptions(OptionsResolver $resolver): void
{
    $resolver->setDefaults([
        'empty_data' => function (FormInterface $form) {
            return new Blog($form->get('title')->getData());
        },
    ]);
}