README

Box, a smart autowiring container for PHP.

Getting started

Installation

This library can be installed using composer, if you don't have it already, download it.

You can either run this command :

composer require delights/box

Or by adding a requirement in your composer.json :

{
  "require": {
    "delights/box": "0.3.0"  
  }
}

Don't forget to run composer install after adding the requirement.

Before diving into the autowiring and stuff, we need to create a container instance.

use Delights\Box\Container;

$container = new Container();

Bindings

You can bind something into the container, it works just like a key => value array.

$container->bind('key', 'value');
echo $container->resolve('key'); // prints "value"

You may want to bind a class in a closure if you need more specific arguments,

$container->bind(Crawler::class, function () {
    return new Crawler('f4dg65gd6fg465g');
});

Every time you ask for a Crawler::class, this closure will be executed and a fresh instance of Crawler will be created. To avoid that, you can use the singleton method.

$container->singleton(Connection::class, function () {
    return new Connection();
});

Now, the Connection class will be instantiated once, and the closure never executed again.

You may want to use an interface for your Crawler so you can easily swap instances and stuff. However, you want to retrieve the Crawler instance when CrawlerInterface is needed. Instead of manually bind these classes, you can use the bindToImplementation method.

$container->bindToImplementation(CrawlerInterface::class, Crawler::class);
// same as
$container->bindToImplementation(CrawlerInterface::class, new Crawler);
// same as
$container->bindToImplementation(CrawlerInterface::class, function () {
    return new Crawler;
});

Resolving

Smartly resolving parameters is the primary goal of this package. You can resolve anything that needs parameter including, constructors, closures, methods, functions. We even support resolving properties if there is an annotation .

Autowiring

Autowiring allows the container to auto-magically resolve dependencies using the Reflection API.

use Delights\Box\Container;
$container = new Container();

class SomeClass {}
$container->resolve(SomeClass::class); // returns an instance of "SomeClass" 

class SomeOtherClass {
    public function __construct(SomeClass $dep) {
        $this->dep = $dep;
    }
}
$container->resolve(SomeOtherClass::class); 
// returns an instance of "SomeOtherClass"
// with $this->dep set to an instance of "SomeClass"

The container can resolve non-typed argument but only in two cases : they should either allow null or have a default value.

Resolving an object method

class PostsRepository {
    public function all() {
        return ['My article'];    
    }
}

class PostController {
    public function index(PostsRepository $repository) {
        return $repository->all();    
    }
}

$container->call(PostController::class, 'index');
// This returns |'My article']

Resolving a Closure

$container->closure(function (SomeClass $class) {
    return $class instanceof SomeClass;
}); // returns true

Resolve with arbitrary parameters

class Vec2 {
    protected int $x;
    protected int $y;

    public function __construct(int $x, int $y) {
        $this->x = $x;
        $this->y = $y;
    }
}
$container->resolve(Vec2::class, [
    'x' => 2,
    'y' => 4
]); // returns an instance of "Vec2"

The order does not matter, in our example, it can be either [x, y] or [y, x].

You can pass arbitrary parameters to any resolve function.

Singleton

You may want to have a global Container that keeps the same bindings across your app.

Usually, you want to avoid this kind of behavior.

use Delights\Box\PersistentContainer;

PersistentContainer::getInstance();

Here, we this is the first time you call it, a new instance will be created. However, if you already created one, the same instance will be returned.

Static Proxies

There is a little shortcut.

use Delights\Box\PersistentContainer;

// instead of this
PersistentContainer::getInstance()->bind('some', 'thing');

// you can do that
PersistentContainer::bind('some', 'thing');

This is available for any of the PersistentContainer public methods.

Security

If you discover any security related issues, please email oss@dorns.fr instead of using the issue tracker.

Credits

Félix Dorn

Licensing

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

delights / box

Maintainers

Details