Using a Factory to Create Services

Symfony's Service Container provides multiple features to control the creation of objects, allowing you to specify arguments passed to the constructor as well as calling methods and setting parameters.

Symfony のサービス コンテナーは、オブジェクトの作成を制御するための複数の機能を提供し、コンストラクターに渡される引数を指定したり、メソッドを呼び出したりパラメーターを設定したりできます。

However, sometimes you need to apply the factory design pattern to delegate the object creation to some special object called "the factory". In those cases, the service container can call a method on your factory to create the object rather than directly instantiating the class.

ただし、ファクトリ デザイン パターンを適用して、オブジェクトの作成を「ファクトリ」と呼ばれる特別なオブジェクトに委任する必要がある場合があります。このような場合、サービス コンテナーは、クラスを直接インスタンス化するのではなく、ファクトリのメソッドを呼び出してオブジェクトを作成できます。

Static Factories

Suppose you have a factory that configures and returns a new NewsletterManager object by calling the static createNewsletterManager() method:

静的な createNewsletterManager() メソッドを呼び出して、新しい NewsletterManager オブジェクトを構成して返すファクトリがあるとします。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
 
// src/Email/NewsletterManagerStaticFactory.php
namespace App\Email;

// ...

class NewsletterManagerStaticFactory
{
    public static function createNewsletterManager(): NewsletterManager
    {
        $newsletterManager = new NewsletterManager();

        // ...

        return $newsletterManager;
    }
}

To make the NewsletterManager object available as a service, use the factory option to define which method of which class must be called to create its object:

NewsletterManager オブジェクトをサービスとして利用できるようにするには、factory オプションを使用して、そのオブジェクトを作成するためにどのクラスのどのメソッドを呼び出す必要があるかを定義します。
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
6
7
 
# config/services.yaml
services:
    # ...

    App\Email\NewsletterManager:
        # the first argument is the class and the second argument is the static method
        factory: ['App\Email\NewsletterManagerStaticFactory', 'createNewsletterManager']

Note

ノート

When using a factory to create services, the value chosen for class has no effect on the resulting service. The actual class name only depends on the object that is returned by the factory. However, the configured class name may be used by compiler passes and therefore should be set to a sensible value.

ファクトリを使用してサービスを作成する場合、クラスに選択された値は結果のサービスには影響しません。実際のクラス名は、ファクトリによって返されるオブジェクトにのみ依存します。ただし、構成されたクラス名はコンパイラ パスによって使用される可能性があるため、適切な値に設定する必要があります。

Non-Static Factories

If your factory is using a regular method instead of a static one to configure and create the service, instantiate the factory itself as a service too. Configuration of the service container then looks like this:

ファクトリがサービスの構成と作成に静的メソッドではなく通常のメソッドを使用している場合は、ファクトリ自体もサービスとしてインスタンス化します。サービス コンテナの構成は次のようになります。
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
6
7
8
9
10
11
 
# config/services.yaml
services:
    # ...

    # first, create a service for the factory
    App\Email\NewsletterManagerFactory: ~

    # second, use the factory service as the first argument of the 'factory'
    # option and the factory method as the second argument
    App\Email\NewsletterManager:
        factory: ['@App\Email\NewsletterManagerFactory', 'createNewsletterManager']

Invokable Factories

Suppose you now change your factory method to __invoke() so that your factory service can be used as a callback:

ファクトリ メソッドを __invoke() に変更して、ファクトリ サービスをコールバックとして使用できるようにするとします。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
// src/Email/InvokableNewsletterManagerFactory.php
namespace App\Email;

// ...
class InvokableNewsletterManagerFactory
{
    public function __invoke(): NewsletterManager
    {
        $newsletterManager = new NewsletterManager();

        // ...

        return $newsletterManager;
    }
}

Services can be created and configured via invokable factories by omitting the method name:

メソッド名を省略することで、呼び出し可能なファクトリを介してサービスを作成および構成できます。
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
6
7
 
# config/services.yaml
services:
    # ...

    App\Email\NewsletterManager:
        class:   App\Email\NewsletterManager
        factory: '@App\Email\InvokableNewsletterManagerFactory'

Using Expressions in Service Factories

6.1

6.1

Using expressions as factories was introduced in Symfony 6.1.

ファクトリとしての式の使用は、Symfony 6.1 で導入されました。

Instead of using PHP classes as a factory, you can also use expressions. This allows you to e.g. change the service based on a parameter:

PHP クラスをファクトリとして使用する代わりに、式を使用することもできます。これにより、つま先立ちが可能になります。パラメータに基づいてサービスを変更します。
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
6
7
8
9
10
11
12
 
# config/services.yaml
services:
    App\Email\NewsletterManagerInterface:
        # use the "tracable_newsletter" service when debug is enabled, "newsletter" otherwise.
        # "@=" indicates that this is an expression
        factory: '@=parameter("kernel.debug") ? service("tracable_newsletter") : service("newsletter")'

    # you can use the arg() function to retrieve an argument from the definition
    App\Email\NewsletterManagerInterface:
        factory: "@=arg(0).createNewsletterManager() ?: service("default_newsletter_manager")"
        arguments:
            - '@App\Email\NewsletterManagerFactory'

Passing Arguments to the Factory Method

Tip

ヒント

Arguments to your factory method are autowired if that's enabled for your service.

サービスで有効になっている場合、ファクトリ メソッドへの引数は自動配線されます。

If you need to pass arguments to the factory method you can use the arguments option. For example, suppose the createNewsletterManager() method in the previous examples takes the templating service as an argument:

ファクトリ メソッドに引数を渡す必要がある場合は、arguments オプションを使用できます。たとえば、前の例の createNewsletterManager() メソッドがテンプレート サービスを引数として受け取るとします。
  • YAML
    YAML
  • XML
    XML
  • PHP
    PHP
1
2
3
4
5
6
7
 
# config/services.yaml
services:
    # ...

    App\Email\NewsletterManager:
        factory:   ['@App\Email\NewsletterManagerFactory', createNewsletterManager]
        arguments: ['@templating']