christianblos/symfony-di-annotation

Allows you to configure symfony dependency injections via annotations

2.0.0 2020-07-31 10:15 UTC

This package is auto-updated.

Last update: 2022-07-29 01:29:59 UTC


README

This library is an extension of the Symfony DependencyInjection Component. It allows you to configure the DI Container using annotations directly in your classes.

Set up

1. Install via composer:

composer require christianblos/symfony-di-annotation

2. Add compiler pass to the ContainerBuilder

<?php
use Symfony\Component\DependencyInjection\Annotation\Compiler\AnnotationPass;
use Symfony\Component\DependencyInjection\ContainerBuilder;

$containerBuilder = new ContainerBuilder();

$srcDirs = ['path/to/classes']; // the path(s) to your classes which contain annotations

$containerBuilder->addCompilerPass(AnnotationPass::createDefault($srcDirs));

(see symfony documentation for more information about the ContainerBuilder)

Basic Usage

Just add the @Service annotation to all of your services and they will be registered to the DIC automatically:

<?php
use Symfony\Component\DependencyInjection\Annotation\Service;

/**
 * @Service
 */
class SomeRepository
{

}
<?php
use Symfony\Component\DependencyInjection\Annotation\Service;

/**
 * @Service(public=true)
 */
class SomeService
{
    public function __construct(SomeRepository $repo)
    {
        // $repo will be injected automatically
    }
}

Now you can simply retrieve the service from the container:

$someService = $container->get(SomeService::class);

Note: You can also add multiple @Service annotations if you want to configure two services of the same class. Then you also need to set the id of the service like @Service(id="myService") because you can not have two services with the same id (By default, the id is the full class name).

Inject params

You can also inject params by adding it to the annotation:

<?php
use Symfony\Component\DependencyInjection\Annotation\Service;

/**
 * @Service(
 *     inject={
 *         "someParam"="%foo%"
 *     }
 * )
 */
class SomeService
{
    public function __construct($someParam)
    {
        // - "someParam" ist the name of the variable
        // - "%foo%" means you want to inject the "foo" parameter from the container
    }
}

Modify container

It is possible to modify the whole container by using method annotations. One possible use case is an event listener. Depending on your implementation it could look like this:

class MyListener
{
    /**
     * @ListenTo(UserRegistered::class)
     */
    public function doSomethingWhenUserRegistered($event)
    {
    
    }
}

Note: This is just an example of what is possible. The "ListenTo" Annotation is not implemented in this library! See the example of how you can implement it.

More examples

You can find some examples in the examples folder.