jshannon63/cobalt

Autowired Dependency Injection Container for PHP with Dependency Caching

v1.2.1 2018-04-17 18:59 UTC

Requires

• php: ^7.1
• psr/container: ^1.0

Requires (Dev)

• phpunit/phpunit: ~7.0

MIT

• Jim Shannon

• container
• php
• di
• ioc
• autowire
• interop
• dependency-injection-container
• service-container
• PSR-11
• application-framework
• ico-container

README

Cobalt - An Autowired Dependency Injection Container for PHP

Realized in fewer than 160 lines of source.

Well documented, perfect for building/learning.

100% PHPUnit test coverage

One of the fastest PHP dynamic autowired containers available

Cobalt was created to push the performance limits on what a PHP based dynamic autowired DI container can achieve. The Container::class implements the PSR-11 ContainerInterface and provides many of the features found in more notable container projects. Additionally, dependency caching capabilities make the Cobalt container a great choice for performance intensive applications. Cobalt and its simplistic code are perfect for learning or for use within projects or frameworks.

The Cobalt service container has the following features:

1. Single class container implementing the PSR-11 ContainerInterface.
2. ArrayAccess methods for container bindings.
3. Constructor injection of type-hinted dependencies.
4. Dependency injection through bind method closures.
5. Autowired dependency resolution using Reflection.
6. Top down inversion of control (IoC).
7. Shared mode option (singleton only).
8. Bind existing instances into the container.
9. A self-binding global container instance.

Installation

composer require jshannon63/cobalt  

Usage

Creating the container

use Jshannon63\Cobalt\Container;
 
// create a default container 
  
$app = new Container();
  
// or, create a singleton only services container
  
$app = new Container('shared');
    

Binding into the container

Binding does not instantiate the class. Instantiation is deferred until requested from the container. The bind method accepts 3 parameters... the abstract name, the concrete implementation name and a true or false for defining as a singleton. Notice in all three versions we use different abstract names. This is to show that the abstract name is free-form and is used as the "key" for array storage of bindings.

bind($abstract, $concrete=null, $singleton=false)

// a simple binding using only the class name
  
$app->bind(Foo::class);
  
// or, bind an interface with a desired concrete implementation.
// can be switched out easily on one place in your code.
  
$app->bind('FooInterface', Foo::class);
  
// or, bind an interface or other label to a closure to
// directly control dependency injection.
  
$app->bind('FooInterface', function(){
    return new Foo('123-456-7890');
};
  
// or, use array access to bind a new instance directly.
  
$app['Foo'] = new Foo();

Resolving out of the container

$instance = resolve($abstract); (resolve checks for existing binding before instantiating)

$foo = $app->resolve(FooInterface::class);
  
// or
  
$foo = $app[FooInterface::class]; 
  
// or
  
$foo = $app->get(FooInterface::class);

Note: Trying to resolve will throw an exception if the requested binding does not exist.

Using the make() method

The make method will bind() then resolve() to return a fully instantiated binding.

$instance = make($abstract, $concrete, $singleton=false)

$foo = make(FooInterface::class, Foo());

Creating an alias to a binding

alias($alias, $binding)

Allows creating additional $id string keys for accessing existing container bindings.

alias('myfoo', FooInterface::class);

Binding an existing instance

$instance = instance($abstract, $instance)

$instance = $app->instance('Foo', new Foo);

Note: The instance method is deprecated but retained for backward compatibility. Instead, use bind($id, $instance) to register an existing intance.

Checking if a binding exists

$bool = has($abstract)

$bool = $app->has('Foo');

Get the values of a single binding

$array = getBinding($abstract)

$array = $app->getBinding($abstract);

Getting a list of bindings

$array = getBindings()

$array = $app->getBindings();