How to Configure a Service with a Configurator
The service configurator is a feature of the service container that allows you to use a callable to configure a service after its instantiation.
A service configurator can be used, for example, when you have a service that requires complex setup based on configuration settings coming from different sources/services. Using an external configurator, you can maintain the service implementation cleanly and keep it decoupled from the other objects that provide the configuration needed.
Another use case is when you have multiple objects that share a common configuration or that should be configured in a similar way at runtime.
For example, suppose you have an application where you send different types
of emails to users. Emails are passed through different formatters that
could be enabled or not depending on some dynamic application settings.
You start defining a NewsletterManager
class like this:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/Mail/NewsletterManager.php
namespace App\Mail;
class NewsletterManager implements EmailFormatterAwareInterface
{
private $enabledFormatters;
public function setEnabledFormatters(array $enabledFormatters): void
{
$this->enabledFormatters = $enabledFormatters;
}
// ...
}
and also a GreetingCardManager
class:
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/Mail/GreetingCardManager.php
namespace App\Mail;
class GreetingCardManager implements EmailFormatterAwareInterface
{
private $enabledFormatters;
public function setEnabledFormatters(array $enabledFormatters): void
{
$this->enabledFormatters = $enabledFormatters;
}
// ...
}
As mentioned before, the goal is to set the formatters at runtime depending
on application settings. To do this, you also have an EmailFormatterManager
class which is responsible for loading and validating formatters enabled
in the application:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// src/Mail/EmailFormatterManager.php
namespace App\Mail;
class EmailFormatterManager
{
// ...
public function getEnabledFormatters(): array
{
// code to configure which formatters to use
$enabledFormatters = [...];
// ...
return $enabledFormatters;
}
}
If your goal is to avoid having to couple NewsletterManager
and
GreetingCardManager
with EmailFormatterManager
, then you might want
to create a configurator class to configure these instances:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
// src/Mail/EmailConfigurator.php
namespace App\Mail;
class EmailConfigurator
{
private $formatterManager;
public function __construct(EmailFormatterManager $formatterManager)
{
$this->formatterManager = $formatterManager;
}
public function configure(EmailFormatterAwareInterface $emailManager): void
{
$emailManager->setEnabledFormatters(
$this->formatterManager->getEnabledFormatters()
);
}
// ...
}
The EmailConfigurator
's job is to inject the enabled formatters into
NewsletterManager
and GreetingCardManager
because they are not aware of
where the enabled formatters come from. On the other hand, the
EmailFormatterManager
holds the knowledge about the enabled formatters and
how to load them, keeping the single responsibility principle.
Tip
While this example uses a PHP class method, configurators can be any valid PHP callable, including functions, static methods and methods of services.
Using the Configurator
You can configure the service configurator using the configurator
option. If
you're using the default services.yaml configuration,
all the classes are already loaded as services. All you need to do is specify the
configurator
:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
# config/services.yaml
services:
# ...
# Registers all 4 classes as services, including App\Mail\EmailConfigurator
App\:
resource: '../src/*'
# ...
# override the services to set the configurator
App\Mail\NewsletterManager:
configurator: ['@App\Mail\EmailConfigurator', 'configure']
App\Mail\GreetingCardManager:
configurator: ['@App\Mail\EmailConfigurator', 'configure']
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<!-- config/services.xml -->
<?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
https://symfony.com/schema/dic/services/services-1.0.xsd">
<services>
<prototype namespace="App\" resource="../src/*"/>
<service id="App\Mail\NewsletterManager">
<configurator service="App\Mail\EmailConfigurator" method="configure"/>
</service>
<service id="App\Mail\GreetingCardManager">
<configurator service="App\Mail\EmailConfigurator" method="configure"/>
</service>
</services>
</container>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;
use App\Mail\EmailConfigurator;
use App\Mail\GreetingCardManager;
use App\Mail\NewsletterManager;
return function(ContainerConfigurator $container) {
$services = $container->services();
// Registers all 4 classes as services, including App\Mail\EmailConfigurator
$services->load('App\\', '../src/*');
// override the services to set the configurator
// In versions earlier to Symfony 5.1 the service() function was called ref()
$services->set(NewsletterManager::class)
->configurator([service(EmailConfigurator::class), 'configure']);
$services->set(GreetingCardManager::class)
->configurator([service(EmailConfigurator::class), 'configure']);
};
Services can be configured via invokable configurators (replacing the
configure()
method with __invoke()
) by omitting the method name:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
# config/services.yaml
services:
# ...
# registers all classes as services, including App\Mail\EmailConfigurator
App\:
resource: '../src/*'
# ...
# override the services to set the configurator
App\Mail\NewsletterManager:
configurator: '@App\Mail\EmailConfigurator'
App\Mail\GreetingCardManager:
configurator: '@App\Mail\EmailConfigurator'
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<!-- config/services.xml -->
<?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
https://symfony.com/schema/dic/services/services-1.0.xsd">
<services>
<prototype namespace="App\" resource="../src/*"/>
<service id="App\Mail\NewsletterManager">
<configurator service="App\Mail\EmailConfigurator"/>
</service>
<service id="App\Mail\GreetingCardManager">
<configurator service="App\Mail\EmailConfigurator"/>
</service>
</services>
</container>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;
use App\Mail\GreetingCardManager;
use App\Mail\NewsletterManager;
return function(ContainerConfigurator $container) {
$services = $container->services();
// Registers all 4 classes as services, including App\Mail\EmailConfigurator
$services->load('App\\', '../src/*');
// override the services to set the configurator
$services->set(NewsletterManager::class)
->configurator(service(EmailConfigurator::class));
$services->set(GreetingCardManager::class)
->configurator(service(EmailConfigurator::class));
};
That's it! When requesting the App\Mail\NewsletterManager
or
App\Mail\GreetingCardManager
service, the created instance will first be
passed to the EmailConfigurator::configure()
method.