lcobucci/di-builder

Dependency Injection Builder for PHP 5.3+ applications

Installs: 1 849

Dependents: 3

Stars: 2

Watchers: 2

Forks: 3

Language: PHP

3.1.0 2015-08-28 01:13 UTC

README

Build Status Scrutinizer Code Quality Code Coverage Total Downloads Latest Stable Version

This library tries to help the usage of the Symfony2 dependecy injection Component by offering an easy interface to build and load your dependency injection container.

Features

  • Multiple container files or paths: you can create the container from one or more files and paths, this is useful when dealing with modules;
  • Multiple file loader: you can select if you want to create your container from XML (default), YAML, PHP or mixed mode (delegates the loading by the extension of file);
  • Usage of your own container base class: sometimes you may use a different class to inherit your container (rather than Symfony\Component\DependencyInjection\Container;
  • Automatic dump creation: instead of building your container for all requests you will do that only when things change (development mode only);
  • Configuration handlers: you are able to inject handlers to be executed before the container compilation process (to change the services definitions);
  • Dynamic parameters: if you need to configure parameters that may change according with the environment automatically (like base project directory using __DIR__).

Installation using composer

Just add "lcobucci/di-builder": "~3.0" to your composer.json and do a composer update or you can run:

composer require lcobucci/di-builder:~3.0

Basic usage

The usage is really simple, just trust the Lcobucci\DependencyInjection\Builder interface and all should be good =)

Take a look:

<?php
/* Composer autoloader was required before this */ 

use Lcobucci\DependencyInjection\ContainerBuilder;
use Lcobucci\DependencyInjection\Config\Handlers\ContainerAware;
use Lcobucci\DependencyInjection\Generators\Php as PhpGenerator;

$container = (new ContainerBuilder())->setGenerator(new PhpGenerator()) // Changes the generator
                                     ->addFile(__DIR__ . '/config/services.php') // Appends a file to create the container
                                     ->addPath(__DIR__ . '/src/Users/config') // Appends a new path to locate files
                                     ->addFile('services.php') // Appends a file to create the container (to be used with the configured paths)
                                     ->useDevelopmentMode() // Enables the development mode (production is the default)
                                     ->setDumpDir(__DIR__ . '/tmp') // Changes the dump directory
                                     ->setParameter('app.basedir', __DIR__) // Configures a dynamic parameter
                                     ->addHandler(new ContainerAware()) // Appends a new configuration handler
                                     ->getContainer(); // Retrieves the container =)

Pretty easy, right?

Handlers

The handlers are very great to change your container before the compile process. And you can create your own handler by just implementing the Lcobucci\DependencyInjection\Config\Handler interface. Like this:

use Lcobucci\DependencyInjection\Config\Handler;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
use Symfony\Component\DependencyInjection\Reference;

class EventListenerInjector implements Handler
{
    /**
     * {@inheritdoc}
     */
    public function __invoke(ContainerBuilder $builder)
    {
        $dispatcher = $builder->getDefinition('event.dispatcher');   

        foreach ($builder->findTaggedServiceIds('event.listener') as $service => $listenerConfig) {
            $dispatcher->addMethodCall(
                'addListener',
                [$listenerConfig['event'], new Reference($service), $listenerConfig['priority']]
            );
        }
    }
}

Happy coding ;)