Using a Factory to Create Services
Edit this pageWarning: You are browsing the documentation for Symfony 3.0, which is no longer maintained.
Read the updated version of this page for Symfony 6.1 (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::createNewsletterManager()
factory method:
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13
services:
app.newsletter_manager:
class: AppBundle\Email\NewsletterManager
# call a static method
factory: ['AppBundle\Email\NewsletterManager', create]
app.newsletter_manager_factory:
class: AppBundle\Email\NewsletterManagerFactory
app.newsletter_manager:
class: AppBundle\Email\NewsletterManager
# call a method on the specified service
factory: ['@app.newsletter_manager_factory', createNewsletterManager]
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.
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:
- YAML
- XML
- PHP
1 2 3 4 5 6 7
services:
# ...
app.newsletter_manager:
class: AppBundle\Email\NewsletterManager
factory: ['@newsletter_manager_factory', createNewsletterManager]
arguments: ['@templating']