mouf/pimple-interop

This project is a very simple extension to the Pimple microframework. It adds to Pimple compatibility with the container-interop APIs.

v1.0.0 2014-08-24 17:16 UTC

README

Latest Stable Version Latest Unstable Version License SensioLabsInsight

This package contains an extension to the Pimple DI container that makes Pimple 1 compatible with the container-interop API.

How to use it?

Instead of using the Pimple class, you can use the PimpleInterop class. This class extends Pimple. PimpleInterop implements ContainerInterface. This means you can access your Pimple entries by using the get and has methods. PimpleInterop constructor accepts an optional "root" container as a first argument. This means you can chain PimpleInterop with another container. Dependencies will be fetched from the "root" container rather than from PimpleInterop.

Here is a sample chaining 2 Pimple instances (in the real world, you would rather chain Pimple with a composite container than contains all the DI containers you are working with):

// Let's declare a first container
$pimpleParent = new PimpleInterop();
$pimpleParent['hello'] = 'world';

// Let's declare another container
// Please note the "parent" container is passed in parameter of the constructor.
$pimple = new PimpleInterop($pimpleParent);
$pimple['test']->share(function(ContainerInterop $container) {
	return "Hello ".$container->get('hello');
});

// Prints "Hello world".
echo $pimple->get('test');
// Prints "Hello world" too.
echo $pimple['test'];

Why the need for this package?

This package is part of a long-term effort to bring interoperability between DI containers. The ultimate goal is to make sure that multiple containers can communicate together by sharing entries (one container might use an entry from another container, etc...)

But can't we already do this using Acclimate?

The excellent Acclimate library can already provide an adapter around Pimple. The adapter implements the ContainerInterface.

However, the adapter design pattern cannot be used to have Pimple delegate its dependencies fetching to another container. Indeed, to implement this feature, you need to modify the very behaviour of the container, and the adapter design pattern is not always well suited for this.

Also, there are other cases where the adapter design pattern is not enough. For instance, the Silex MVC microframework is directly extending the Pimple class. We could fork the Silex MVC microframework to make it use PimpleInterop instead of Pimple easily. However, it would be almost impossible for Silex to use the adapted Pimple instance from Acclimate (because Silex relies on all the methods of Pimple that are not implemented by the adapter).