petk/php-container

PSR-11 compatible dependency injection container

v0.0.1 2023-06-05 14:27 UTC

Requires

• psr/container: ^2.0

Requires (Dev)

• phpunit/phpunit: ^10.2

MIT

• Peter Kokot

• container
• dependency
• injection

README

Lightweight PSR-11 compatible PHP dependency injection container.

Installation

composer require petk/php-container

Usage

Create, for example, config/container.php file which returns container instance:

<?php

declare(strict_types=1);

use Petk\Container;

// Container instantiation.
$container = new Container();

// Adding dependencies to container is as easy as setting them to the given key.
$container->set(App\Utility::class, function ($c) {
    return new App\Utility();
});

// Adding more complex dependencies can be done like this.
$container->set(App\Database::class, function ($c) {
    return new App\Database($c->get(App\Utility::class));
});

return $container;

Then you can use such container configuration in the application front controller or other application entry files like this:

<?php

declare(strict_types=1);

// Require Composer autoloader.
require __DIR__ . '/vendor/autoload.php';

// Use the Container class.
$container = require __DIR__ . '/../config/container.php';

$database = $container->get(App\Database::class);
// Use $database further.

Circular dependencies

Circular dependencies are a bad practice where two classes have dependencies of each other. See the following example:

<?php

// ...

class ChildClass
{
    public function __construct(private ParentClass $parent)
    {
    }
}

class ParentClass
{
    public function __construct(private ChildClass $child)
    {
    }
}

$container->set(ParentClass::class, function ($c) {
    return new ParentClass($c->get(ChildClass::class));
});

$container->set(ChildClass::class, function ($c) {
    return new ChildClass($c->get(ParentClass::class));
});

// This will throw ContainerCircularDependencyException.
$object = $container->get(Parent::class);

Above will throw the ContainerCircularDependencyException which means constructing dependencies of ParentClass and ChildClass should be done differently. Perhaps you need event driven implementation here or something else.

License and contributing

Contributions are welcome by forking the repository on GitHub. This repository is released under the MIT license.