haszi/dicontainer

There is no license information available for the latest version (1.0.0) of this package.

A learning exercise of a PSR-11 compatible dependency injection container

1.0.0 2023-10-28 12:52 UTC

Requires

• php: >=8.0
• psr/container: ^2.0

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.4
• vimeo/psalm: ^5.15

Unknown License

README

A basic PSR-11 compatible dependency injection container written to learn about the concepts and implementation of object composition, lifetime managmenent and interception provided by DICs. Basic object composition and lifetime management functionality has been implemented (see features and limitations) with no support for interception of calls to managed objects.

Requirements

PHP 8.0+

Installation

Install with Composer

composer require haszi/dicontainer

Getting started

Create a container

use haszi\DI\Container;

$container = new Container();

PSR-11 compatibility

if ($container->has('MyClass')) {
  $myObject = $container->get('MyClass');
}

Register transient services

Transient services (returning a new instance each time you get them from the container) can be registered using a string representing a classname or a closure.

Classname

$container->set('comment', Comment::class);

Closure

$container->set(Comment::class, function () {
  return new Comment();
});

Register shared services

Shared services (returning the same instance each time you get it from the container)can be registered using a string representing a classname, a closure or an instantiated object. All shared service objects are lazily initialized on first use.

Classname

$container->setShared('database', DatabaseConnection::class);

Closure

$container->setShared(DatabaseConnection::class, function () {
  return new DatabaseConnection();
});

Instantiated Object

$db = new DatabaseConnection();

$container->setShared(DatabaseConnection::class, $db);

Register scoped services

Scoped services are identical to shared service with the exception that the instantiated objects can be flushed without deregistering the service itself. A common use for scoped services are request objects in an event loop.

Classname

$container->setScoped('request', Request::class);

Closure

$container->setScoped(Request::class, function () {
  return new Request();
});

Instantiated Object

$request = new Request();

$container->setScoped(Request::class, $request);

Flush initialized scoped objects

$container->unsetScopedInstances(Request::class);

Deregister services

$container->unset(DatabaseConnection::class);

Features

Supported

• object composition
  • constructor injection
    • auto-wiring
• lifetime management
  • transient services (new object returned on each get request)
  • shared services (the same object returned on each get request)
  • scoped services (the same object returned on each get request with the instantiated object being disposable)

Not supported

• object composition
  • setter and property injection
  • injection of:
    • union and intersection types
    • passing in values to built-in types (array, callable, bool, float, int, string, iterable, object, mixed)
• interception