DecoratorBundle for Symfony

Provides consistent decorator handling for the Symfony Dependency Injection Container.

Installation

For Symfony 3.3 up to 4:

composer require internations/decorator-bundle

For Symfony < 3.3:

composer require internations/decorator-bundle:~0

Usage

"Decorate this"-mode

In "decorate this"-mode you declare your decorators in the dependency at hand. A configuration example:

<service id="iterator" class="ArrayIterator">
    <argument type="collection">
        <argument type="string">element1</argument>
        <argument type="string">element2</argument>
    </argument>
    <tag name="decorator.decorate_this" decorator_id="infinite_iterator"/>
</service>

<service id="infinite_iterator" class="InifiteIterator" public="false">
    <argument type="service" id="__subject__"/>
</service>

The configuration above will create this instance:

$iterator = new InfiniteIterator(
    new ArrayIterator(['element1', 'element2'])
);

"Decorate other" mode

In "decorate other"-mode you declare the subjects you are decorating in the decorator definition itself. A configuration example:

<service id="iterator" class="ArrayIterator">
    <argument type="collection">
        <argument type="string">element1</argument>
        <argument type="string">element2</argument>
    </argument>
</service>

<service id="infinite_iterator" class="InifiteIterator" public="false">
    <argument type="service" id="__subject__"/>
    <tag name="decorator.decorate_other" service_id="iterator"/>
</service>

The configuration above will again create this instance:

$iterator = new InfiniteIterator(
    new ArrayIterator(['element1', 'element2'])
);

Specifying priorities

To control the order of decoration, setting a priority flag for the decorator is supported. Priority can be between PHP_INT_MAX and -PHP_INT_MAX, the default priority is 0.

<service id="infinite_iterator" class="InifiteIterator" public="false">
    <argument type="service" id="__subject__"/>
    <tag name="decorator.decorate_other" service_id="iterator" priority="255"/>
</service>

Using the Bundle programmatically

In cases where you want to reuse the decoration functionality outside of the XML config, you can use the following API in your Compiler Pass. Here is an example to add decorate service common_service with the decorator special_decorator and priority 255.

namespace …;

use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use InterNations\Bundle\DecoratorBundle\Tagger\DecorationTagger;
use Symfony\Component\DependencyInjection\ContainerBuilder;

class MyCompilerPass implements CompilerPassInterface
{
    public function process(ContainerBuilder $container)
    {
        DecorationTagger::tag($container, 'common_service', 'special_decorator', 255);
    }
}

Credits

Based on Dovydas Bartkevicius’ idea, with a bunch of input from Max Beutel.

InterNations / DecoratorBundle