jakulov/container

Simple universal Container & DIContainer

dev-master 2016-01-02 20:16 UTC

Requires

• container-interop/container-interop: ^1.1

Requires (Dev)

• phpunit/phpunit: ^5.1

MIT

• Yakov Akulov

README

Simple universal PHP Container & DIContainer (Dependency Injection)

Can be installed with composer

composer require jakulov/container

Implements Container Interoperability

1. Container

Container could be used to store any array data (e.g. configuration or repository) and easy accessing it with dot notation.

$config = ['test' => [
        'key1' => 'value1',
    ]];
$container = \jakulov\Container\Container::getInstance($config);
echo $container->get('test.key1'); // value1

Container and DIContainer uses singleton pattern, so after first initialization of container you can access to it without passing config as argument, like:

// second and other usages of container should not use config
$container = \jakuov\Container\Container::getInstance();

2. DIContainer

Dependency injection container should be used for manager dependencies between services in php application. This quite simple but agile implementation of DI Container.

$config = [
    'foo' => 'bar', 
    // you can use aware-interfaces to manage dependencies in app 
    'container' => [
      'di' => [
          'aware' => [
              // in any service class implements this interface and resolved
              // with DIContainer will be called setInterfaceTest method with argument
              // containing instance of service "service.interface_test"
              'Service\\InterfaceTestServiceAwareInterface' => [
                  'setInterfaceTest' => '@service.interface_test',
              ],
          ],
      ],
    ],
    // configuration of services
    'service' => [
      // service name will be "service.test"
      'test' => [
          'class' => 'Service\\TestService', // class of service
          // arguments of service __construct
          'args' => [
              'argument1',
              'argument2'
          ],
          // setters to call while service initialization
          'aware' => [
              // as dependency you can use:
              'setAnotherTestService' => '@service.another_test', // another service
              'setContainerValue' => ':foo', // container value
              'setScalarValue' => 'value', // or scalar value
          ],
      ],
      'another_test' => [
          'class' => 'Service\\AnotherTestService',
      ],
      'alias_test' => '@another_test',
      'interface_test' => [
          'class' => 'Service\\InterfaceTestService'
      ],
    ],
];
  
$dic = \jakulov\Container\DIContainer::getInstance($config);
$testService = $dic->get('service.test');
echo $testService->argument1; // 'argument1'
echo $testService->containerValue; // 'bar'
echo $testService->scalarValue; // 'value'
echo get_class( $testService->anotherTestService ); // Service\\AnotherTestService
echo get_class( $testService->anotherTestService->interfaceTestService ); // Service\\InterfaceTestService

Service can also resolve dependencies without declaration in config, if it's dependencies declared in class with help of aware interfaces.

$service = $dic->resolve(\Service\UnresolvedTestService::class);

If you want to make you services reusable with multiple requests, you should renew some dependencies on each request. For example it could be HTTP Request instance. If request service declared with id "request", you can provide new object like this:

$request = \Symfony\Component\HttpFoundation\Request::createFromGlobals();
$dic->provide('request', $request); // updated dependency in all services

Tests

Run: ./run_tests.sh

Tests are also examples for usage library