ojezu/add-call-to-remote-service-bundle

Symfony2 bundle that allows injecting method from one service declaration in DI to another

v1.1.0 2018-03-14 10:37 UTC

Requires

• symfony/dependency-injection: ^3.0 || ^2.7
• symfony/http-kernel: ^3.0 || ^2.7
• symfony/property-access: ^3.0 || ^2.7

Requires (Dev)

• squizlabs/php_codesniffer: ^2.3

MIT

• Krzysztof Chrapka

README

This bundle allows adding calls in container to other services, as though they were declared there. Allows some decoupling - the hottest thing in OOP.

Symfony 3.4 and 4.0 Note

As of version 3.4 and 4.0 of Symfony, Dependency Injector is able to find all tagged services on its own:
http://symfony.com/doc/current/service_container/tags.html#reference-tagged-services

This Bundle still works, and can be useful in some cases, e.g. when it's impossible to overwrite or modify declaration of the "parent" class.

Installation

composer require ojezu/add-call-to-remote-service-bundle

Usage

Register this bundle in app/appKernel.php:

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            new OJezu\ConfigurableDiscriminationBundle\AddCallToRemoteServiceBundle(),
            // app bundles
            new Acme\TestBundle\ParentBundle(),
            new Acme\TestBundle\ChildABundle(),
            new Acme\TestBundle\ChildBBundle(),
        );
        return $bundles;
    }
}

Now, instead of:

services:
    acme.root_service:
        class: Acme\Services\RootService
        calls:
            - ['registerChildService', ['Foo', '@acme.children.foo']]
            - ['registerChildService', ['Bar', '@acme.children.bar', {'foo': 'bar'}]]
            
    acme.children.foo:
        class: Acme\Services\Children\FooService
        
    acme.children.bar:
        class: Acme\Services\Children\BarService

You can do this!

services:
    acme.root_service:
        class: Acme\Services\RootService

services:
    acme.children.foo:
        class: Acme\Services\Children\FooService
        public: false
        tags:
          - name: 'ojezu.add_call_to_remote_service'
            remote_service: '@acme.root_service'
            method: 'registerChildService'
            argument.0: 'Foo'
            argument.1: '@'
            argument.2.foo: 'bar'

services:
    acme.children.bar:
        class: Acme\Services\Children\BarService
        public: false
        tags:
          - name: 'ojezu.add_call_to_remote_service'
            remote_service: '@acme.root_service'
            method: 'registerChildService'
            argument.0: 'Bar'
            argument.1: '@'

'@' will resolve to acme.children.foo and acme.children.bar respectively!

Questions

Why argument.0, argument.1, argument.2.foo and not an array?

Symfony/DependencyInjector does not support that. All tag attributes must be scalars, because of XML format supported and used internally by DependencyInjector.

Will this load my services when they are unneeded?

No! This bundle modifies only definitions of services in container, it does not need to (and does not) load referenced services.

License

MIT