gears/di

This package is abandoned and no longer maintained. No replacement package was suggested.

The gears dependency injection container.

v0.2.1 2014-11-21 05:21 UTC

Requires (Dev)

• codegyre/robo: *
• mockery/mockery: *
• phpunit/phpunit: 4.*

MIT

• container
• dependency
• di
• injection
• ioc

README

So we have all heard of this thing called Dependency Injection. Its been around for ages in other enterprise enviroments like Java, .Net, etc. But it's sort of new to the PHP world.

Most will understand the general concept but if not check out:

• http://www.phptherightway.com/#dependency_injection

How to Install

Installation via composer is easy:

composer require gears/di:*

How to Use

Firstly this container is like Pimple but it is not Pimple. There are some unique differences so pay attention.

Basic example:

// lets import the class
use Gears\Di\Container;

// create a new container object
$container = new Container();

// define some services
$container['session_storage'] = function ()
{
	return new SessionStorage('SESSION_ID');
};

$container['session'] = function ()
{
	return new Session($this['session_storage']);
};

// get the session object
$session = $container['session'];

// define factory service
$container['session_factory'] = $container->factory(function()
{
	return new Session($this['session_storage']);
});

// define container parameters / attributes
$container['cookie_name'] = 'SESSION_ID';

// protecting parameters
$container['random_func'] = $container->protect(function()
{
	return rand();
});

For someone that has previously used the Pimple container you should note that instead of the container being passed in via a function parameter. It is available via the $this variable. This is because we bind the closure to the container.

Using a Service Provider:

use Gears\Di\Container;
use Gears\Di\ServiceProviderInterface;

class FooProvider implements ServiceProviderInterface
{
	public function register(Container $c)
	{
		$c['FooService'] = function(){ return new Foo(); };
	}
}

$container = new Container();
$container->register(new FooProvider());
$container['FooService']->bar();

Object Syntax:

// you can also use the container like this.
$container = new Container();

$container->session_storage = function ()
{
	return new SessionStorage('SESSION_ID');
};

$container->session = function ()
{
	return new Session($this->session_storage);
};

$session = $container->session;

Extending the Container:

class Mail extends Container
{
	// note how we prefix the word inject.
	// this tells us that the property is injectable
	protected $injectTo;

	// private properties however will always be
	// private and can not be injected directly.
	private $sendMailPath;

	// so if you tried to inject fooBar it will fail
	private $injectFooBar;

	// from a naming standpoint I think it is best if you name the injectable
	// properties such that it tells you the type that should be injected.
	// however this isn't enforced.
	protected $injectMessage;

	protected $injectTransportService;

	// this is where we can define default services for our container.
	protected function setDefaults()
	{
		// notice how we set them without the word inject
		$this->to = '[e-mail]';

		// I could have defined this above directly on the property
		// but I would rather keep everything consistent.
		$this->sendMailPath = '/bin/sendmail';

		$this->message = function()
		{
			return new Message('Hello World');
		};

		// take note of the camel case property name vs the definition above.
		$this->transportService = function()
		{
			return new SendMailTransport($this->sendMailPath);
		};

		// you can use factory and protect too
		// note you don't have to explicitly define a class property.
		// but just note that both abc and xyz are public properties.
		$this->abc = $this->factory(function(){ return new Abc(); });
		$this->xyz = $this->protect(function($a,$b){ return $a+$b; });
	}

	public function send()
	{
		$this->message->setTo($this->to);
		return $this->transportService->send($this->message);
	}
}

$mail = new Mail();
$mail->send(); // sends an email to me saying Hello World

$mail = new Mail();
$mail->to = '[e-mail]';
$mail->ip = '127.0.0.1';
$mail->message = function(){ return new Message('bar'); };
$mail->transportService = function(){ return new SmtpTransport($this->ip); };
$mail->send(); // sends an email to [e-mail] via 127.0.0.1 saying bar

// the above could be re written as
$mail = new Mail
([
	'to' => '[e-mail]',
	'ip' => '127.0.0.1',
	'message' => function(){ return new Message('bar'); },
	'transportService' => function(){ return new SmtpTransport($this->ip); },
]);
$mail->send();

Credits

This is definitely inspired by Fabien's Pimple Di Container. http://pimple.sensiolabs.org/

Developed by Brad Jones - [e-mail]