Working with Tagged Services

Warning: You are browsing the documentation for Symfony 2.0, which is no longer maintained.

Read the updated version of this page for Symfony 6.3 (the current stable version).

Working with Tagged Services

Tags are a generic string (along with some options) that can be applied to any service. By themselves, tags don't actually alter the functionality of your services in any way. But if you choose to, you can ask a container builder for a list of all services that were tagged with some specific tag. This is useful in compiler passes where you can find these services and use or modify them in some specific way.

For example, if you are using Swift Mailer you might imagine that you want to implement a "transport chain", which is a collection of classes implementing \Swift_Transport. Using the chain, you'll want Swift Mailer to try several ways of transporting the message until one succeeds.

To begin with, define the TransportChain class:

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        class TransportChain
{
    private $transports;

    public function __construct()
    {
        $this->transports = array();
    }

    public function addTransport(\Swift_Transport  $transport)
    {
        $this->transports[] = $transport;
    }
}
    

Then, define the chain as a service:

        1
2
3
4
5
6
        parameters:
    acme_mailer.transport_chain.class: TransportChain

services:
    acme_mailer.transport_chain:
        class: "%acme_mailer.transport_chain.class%"
    

        1
2
3
4
5
6
7
        <parameters>
    <parameter key="acme_mailer.transport_chain.class">TransportChain</parameter>
</parameters>

<services>
    <service id="acme_mailer.transport_chain" class="%acme_mailer.transport_chain.class%" />
</services>
    

        1
2
3
4
5
        use Symfony\Component\DependencyInjection\Definition;

$container->setParameter('acme_mailer.transport_chain.class', 'TransportChain');

$container->setDefinition('acme_mailer.transport_chain', new Definition('%acme_mailer.transport_chain.class%'));
    

Define Services with a Custom Tag

Now you might want several of the \Swift_Transport classes to be instantiated and added to the chain automatically using the addTransport() method. For example you may add the following transports as services:

        1
2
3
4
5
6
7
8
9
10
11
        services:
    acme_mailer.transport.smtp:
        class: \Swift_SmtpTransport
        arguments:
            - "%mailer_host%"
        tags:
            -  { name: acme_mailer.transport }
    acme_mailer.transport.sendmail:
        class: \Swift_SendmailTransport
        tags:
            -  { name: acme_mailer.transport }
    

        1
2
3
4
5
6
7
8
        <service id="acme_mailer.transport.smtp" class="\Swift_SmtpTransport">
    <argument>%mailer_host%</argument>
    <tag name="acme_mailer.transport" />
</service>

<service id="acme_mailer.transport.sendmail" class="\Swift_SendmailTransport">
    <tag name="acme_mailer.transport" />
</service>
    

        1
2
3
4
5
6
7
8
9
        use Symfony\Component\DependencyInjection\Definition;

$definitionSmtp = new Definition('\Swift_SmtpTransport', array('%mailer_host%'));
$definitionSmtp->addTag('acme_mailer.transport');
$container->setDefinition('acme_mailer.transport.smtp', $definitionSmtp);

$definitionSendmail = new Definition('\Swift_SendmailTransport');
$definitionSendmail->addTag('acme_mailer.transport');
$container->setDefinition('acme_mailer.transport.sendmail', $definitionSendmail);
    

Notice that each was given a tag named acme_mailer.transport. This is the custom tag that you'll use in your compiler pass. The compiler pass is what makes this tag "mean" something.

Create a `CompilerPass`

Your compiler pass can now ask the container for any services with the custom tag:

        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
26
27
        use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\Reference;

class TransportCompilerPass implements CompilerPassInterface
{
    public function process(ContainerBuilder $container)
    {
        if (!$container->hasDefinition('acme_mailer.transport_chain')) {
            return;
        }

        $definition = $container->getDefinition(
            'acme_mailer.transport_chain'
        );

        $taggedServices = $container->findTaggedServiceIds(
            'acme_mailer.transport'
        );
        foreach ($taggedServices as $id => $attributes) {
            $definition->addMethodCall(
                'addTransport',
                array(new Reference($id))
            );
        }
    }
}
    

The process() method checks for the existence of the acme_mailer.transport_chain service, then looks for all services tagged acme_mailer.transport. It adds to the definition of the acme_mailer.transport_chain service a call to addTransport() for each "acme_mailer.transport" service it has found. The first argument of each of these calls will be the mailer transport service itself.

Register the Pass with the Container

You also need to register the pass with the container, it will then be run when the container is compiled:

        1
2
3
4
        use Symfony\Component\DependencyInjection\ContainerBuilder;

$container = new ContainerBuilder();
$container->addCompilerPass(new TransportCompilerPass);
    

Note

Compiler passes are registered differently if you are using the full stack framework. See How to work with Compiler Passes in Bundles for more details.

Adding additional attributes on Tags

Sometimes you need additional information about each service that's tagged with your tag. For example, you might want to add an alias to each TransportChain.

To begin with, change the TransportChain 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
        class TransportChain
{
    private $transports;

    public function __construct()
    {
        $this->transports = array();
    }

    public function addTransport(\Swift_Transport $transport, $alias)
    {
        $this->transports[$alias] = $transport;
    }

    public function getTransport($alias)
    {
        if (array_key_exists($alias, $this->transports)) {
           return $this->transports[$alias];
        }
        else {
           return;
        }
    }
}
    

As you can see, when addTransport is called, it takes not only a Swift_Transport object, but also a string alias for that transport. So, how can you allow each tagged transport service to also supply an alias?

To answer this, change the service declaration:

        1
2
3
4
5
6
7
8
9
10
11
        services:
    acme_mailer.transport.smtp:
        class: \Swift_SmtpTransport
        arguments:
            - "%mailer_host%"
        tags:
            -  { name: acme_mailer.transport, alias: foo }
    acme_mailer.transport.sendmail:
        class: \Swift_SendmailTransport
        tags:
            -  { name: acme_mailer.transport, alias: bar }
    

Notice that you've added a generic alias key to the tag. To actually use this, update the compiler:

        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
26
27
28
29
        use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\Reference;

class TransportCompilerPass implements CompilerPassInterface
{
    public function process(ContainerBuilder $container)
    {
        if (!$container->hasDefinition('acme_mailer.transport_chain')) {
            return;
        }

        $definition = $container->getDefinition(
            'acme_mailer.transport_chain'
        );

        $taggedServices = $container->findTaggedServiceIds(
            'acme_mailer.transport'
        );
        foreach ($taggedServices as $id => $tagAttributes) {
            foreach ($tagAttributes as $attributes) {
                $definition->addMethodCall(
                    'addTransport',
                    array(new Reference($id), $attributes["alias"])
                );
            }
        }
    }
}
    

The trickiest part is the $attributes variable. Because you can use the same tag many times on the same service (e.g. you could theoretically tag the same service 5 times with the acme_mailer.transport tag), $attributes is an array of the tag information for each tag on that service.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

Working with Tagged Services

Working with Tagged Services

Define Services with a Custom Tag

Create a `CompilerPass`

Register the Pass with the Container

Adding additional attributes on Tags

What is Symfony?

Learn Symfony

Screencasts

Community

Blog

Services

Deployed on