Using a Factory to Create Services
Edit this pageWarning: You are browsing the documentation for Symfony 2.3, which is no longer maintained.
Read the updated version of this page for Symfony 6.3 (the current stable version).
Using a Factory to Create Services
Symfony's Service Container provides a powerful way of controlling the creation of objects, allowing you to specify arguments passed to the constructor as well as calling methods and setting parameters. Sometimes, however, this will not provide you with everything you need to construct your objects. For this situation, you can use a factory to create the object and tell the service container to call a method on the factory rather than directly instantiating the class.
Suppose you have a factory that configures and returns a new NewsletterManager
object:
1 2 3 4 5 6 7 8 9 10 11
class NewsletterManagerFactory
{
public static function createNewsletterManager()
{
$newsletterManager = new NewsletterManager();
// ...
return $newsletterManager;
}
}
To make the NewsletterManager
object available as a service, you can
configure the service container to use the NewsletterManagerFactory
factory class:
1 2 3 4 5
services:
newsletter_manager:
class: NewsletterManager
factory_class: NewsletterManagerFactory
factory_method: createNewsletterManager
1 2 3 4 5 6 7 8 9 10 11 12 13
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
<services>
<service
id="newsletter_manager"
class="NewsletterManager"
factory-class="NewsletterManagerFactory"
factory-method="createNewsletterManager" />
</services>
</container>
1 2 3 4 5 6 7 8
use Symfony\Component\DependencyInjection\Definition;
// ...
$definition = new Definition('NewsletterManager');
$definition->setFactoryClass('NewsletterManagerFactory');
$definition->setFactoryMethod('createNewsletterManager');
$container->setDefinition('newsletter_manager', $definition);
Note
When using a factory to create services, the value chosen for the class
option 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.
When you specify the class to use for the factory (via factory_class
)
the method will be called statically. If the factory itself should be instantiated
and the resulting object's method called, configure the factory itself
as a service. In this case, the method (e.g. createNewsletterManager
)
should be changed to be non-static:
1 2 3 4 5 6 7
services:
newsletter_manager_factory:
class: NewsletterManagerFactory
newsletter_manager:
class: NewsletterManager
factory_service: newsletter_manager_factory
factory_method: createNewsletterManager
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
<services>
<service id="newsletter_manager_factory" class="NewsletterManagerFactory" />
<service
id="newsletter_manager"
class="NewsletterManager"
factory-service="newsletter_manager_factory"
factory-method="createNewsletterManager" />
</services>
</container>
1 2 3 4 5 6 7 8 9 10 11 12
use Symfony\Component\DependencyInjection\Definition;
$container->setDefinition('newsletter_manager_factory', new Definition(
'NewsletterManager'
));
$container->setDefinition('newsletter_manager', new Definition(
'NewsletterManagerFactory'
))->setFactoryService(
'newsletter_manager_factory'
)->setFactoryMethod(
'createNewsletterManager'
);
Note
The factory service is specified by its id name and not a reference
to the service itself. So, you do not need to use the @
syntax for
this in YAML configurations.
Passing Arguments to the Factory Method
If you need to pass arguments to the factory method, you can use the arguments
options inside the service container. For example, suppose the createNewsletterManager
method in the previous example takes the templating
service as an argument:
1 2 3 4 5 6 7 8 9
services:
newsletter_manager_factory:
class: NewsletterManagerFactory
newsletter_manager:
class: NewsletterManager
factory_service: newsletter_manager_factory
factory_method: createNewsletterManager
arguments:
- '@templating'
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
<services>
<service id="newsletter_manager_factory" class="NewsletterManagerFactory" />
<service
id="newsletter_manager"
class="NewsletterManager"
factory-service="newsletter_manager_factory"
factory-method="createNewsletterManager">
<argument type="service" id="templating" />
</service>
</services>
</container>
1 2 3 4 5 6 7 8 9 10 11 12 13 14
use Symfony\Component\DependencyInjection\Definition;
// ...
$container->setDefinition('newsletter_manager_factory', new Definition(
'NewsletterManagerFactory'
));
$container->setDefinition('newsletter_manager', new Definition(
'NewsletterManager',
array(new Reference('templating'))
))->setFactoryService(
'newsletter_manager_factory'
)->setFactoryMethod(
'createNewsletterManager'
);