jsoumelidis/zend-sf-di-config

PSR-11 Symfony DI container configurator for ZF and Expressive applications

0.4.0 2018-04-12 20:58 UTC

This package is not auto-updated.

Last update: 2020-01-10 01:31:54 UTC


README

Build Status Coverage Status

This library provides utilities to configure a PSR-11 compatible Symfony DI Container using zend-servicemanager configuration.

Installation

Run the following to install this library:

$ composer require jsoumelidis/zend-sf-di-config

Configuration

To get a configured Symfony DI container, do the following:

<?php
use JSoumelidis\SymfonyDI\Config\Config;
use JSoumelidis\SymfonyDI\Config\ContainerFactory;

$factory = new ContainerFactory();

$container = $factory(
    new Config([
        'dependencies' => [
            'services'   => [],
            'invokables' => [],
            'factories'  => [],
            'aliases'    => [],
            'delegators' => [],
        ],
        // ... other configuration
    ])
);

The dependencies sub associative array can contain the following keys:

  • services: an associative array that maps a key to a specific service instance.
  • invokables: an associative array that map a key to a constructor-less service; i.e., for services that do not require arguments to the constructor. The key and service name may be the same; if they are not, the name is treated as an alias.
  • factories: an associative array that maps a service name to a factory class name, or any callable. Factory classes must be instantiable without arguments, and callable once instantiated (i.e., implement the __invoke() method).
  • aliases: an associative array that maps an alias to a service name (or another alias).
  • delegators: an associative array that maps service names to lists of delegator factory keys, see the Expressive delegators documentation for more details.

Please note, that the whole configuration is available in the $container on config key:

$config = $container->get('config');

Using with Expressive

Replace the contents of config/container.php with the following:

<?php

use JSoumelidis\SymfonyDI\Config\Config;
use JSoumelidis\SymfonyDI\Config\ContainerFactory;

$config  = require __DIR__ . '/config.php';
$factory = new ContainerFactory();

return $factory(new Config($config));

Pre-configuring the ContainerBuilder

One can pass an already instantiated ContainerBuilder as 2nd argument to ContainerFactory

<?php

use JSoumelidis\SymfonyDI\Config\Config;
use JSoumelidis\SymfonyDI\Config\ContainerFactory;

$config  = require __DIR__ . '/config.php';

$containerBuilder = new \Symfony\Component\DependencyInjection\ContainerBuilder();

//...Your work here...

$factory = new ContainerFactory();
return $factory(new Config($config), $containerBuilder);

Dumping/Caching the Container

Symfony DI Container's dumping functionality is now supported. See the following example for using with expressive. For more information about compiling, dumping and caching Symfony DIC's configuration visit symfony documentation here

This functionality requires symfony/config package

<?php
use JSoumelidis\SymfonyDI\Config\Config;
use JSoumelidis\SymfonyDI\Config\ContainerFactory;
use Symfony\Component\DependencyInjection\Dumper\PhpDumper;

$factory = new ContainerFactory();

$config = require __DIR__ . '/config.php';
$cachedContainerFile = 'someFileToDumpContainerConfiguration.php';

$containerConfig = new Config($config, true); //set 2nd argument to true while
                                              //instantiating Config to register
                                              //services as synthetic

if (file_exists($cachedContainerFile)) {
    //load cached container
    require_once($cachedContainerFile);
    
    //boot the cached container
    $container = new ProjectServiceContainer(); //Default class for Symfony DI
    
    //re-set synthetic services, this is mandatory
    $containerConfig->setSyntheticServices($container);
    
    return $container;
}

$container = $factory($containerConfig);

//... other user configuration here

$container->compile();
file_put_contents($cachedContainerFile, (new PhpDumper($container))->dump());

return $container;