https://github.com/thecodingmachine/prefixer-container
This package contains a really minimalist dependency injection container that acts as a proxy in front of a target container. Its goal is to prefix all instances names in the target container.
https://github.com/thecodingmachine/prefixer-container
Last synced: 7 months ago
JSON representation
This package contains a really minimalist dependency injection container that acts as a proxy in front of a target container. Its goal is to prefix all instances names in the target container.
- Host: GitHub
- URL: https://github.com/thecodingmachine/prefixer-container
- Owner: thecodingmachine
- Created: 2015-01-31T17:50:37.000Z (almost 11 years ago)
- Default Branch: 1.0
- Last Pushed: 2015-02-01T14:43:50.000Z (almost 11 years ago)
- Last Synced: 2025-07-10T11:11:29.305Z (7 months ago)
- Language: PHP
- Size: 418 KB
- Stars: 3
- Watchers: 17
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Prefixer-Container
==================
[](https://packagist.org/packages/mouf/prefixer-container)
[](https://packagist.org/packages/mouf/prefixer-container)
[](https://packagist.org/packages/mouf/prefixer-container)
[](https://scrutinizer-ci.com/g/thecodingmachine/prefixer-container/?branch=1.0)
[](https://insight.sensiolabs.com/projects/e6cfc4b4-bc6d-4edc-8e01-ac05352c3689)
[](https://travis-ci.org/thecodingmachine/prefixer-container)
[](https://coveralls.io/r/thecodingmachine/prefixer-container?branch=1.0)
This package contains a really minimalist dependency injection container that can be used to **prefix** all identifiers
in a container. Prefixer-container is compatible with [container-interop](https://github.com/container-interop/container-interop)
and is meant to be used in conjunction with other containers. By itself, Prefix-container does not store any entry. It can only be used
to **wrap an existing container**.
You can use `PrefixerContainer` to put all identifiers of a container in a **namespace**.
Installation
------------
Before using `PrefixerContainer` in your project, add it to your `composer.json` file:
```
$ ./composer.phar require mouf/prefixer-container ~1.0
```
Usage
-----
Imagine you have 2 containers living side-by-side, and a composite container (we will call it the "root" container)
is joining them. Now, both containers declare a same instance named "dbConnection".
If you want to keep access to both instances through the root container, you have a problem, because you have
a naming collision. Of course, you can rename one of those instances, but if the containers are provided by
third party libraries, that might not be possible.
So what you need to do is to rename the instances of one of the containers so that there is no more conflict.
This is where the `PrefixerContainer` kicks in.
By wrapping your containers inside a `PrefixerContainer`, you can change the name of the instances to the outside
world.
Here is a sample code demonstrating the code above:
```php
use Mouf\PrefixerContainer\PrefixerContainer;
use Acclimate\Container\CompositeContainer;
use Interop\Container\ContainerInterface;
use Mouf\Picotainer\Picotainer;
$rootContainer = new CompositeContainer();
// We use Picotainer, a minimalistic container for this demo.
$containerA = new Picotainer([
"dbConnection" => function () { return new DbConnection(...); },
]);
$containerB = new Picotainer([
"dbConnection" => function () { return new OtherDbConnection(...); },
]);
$rootContainer->addContainer(new PrefixerContainer($containerA, 'A.')));
$rootContainer->addContainer(new PrefixerContainer($containerB, 'B.')));
// Get 'dbConnection' from container A:
$dbConnectionA = $rootContainer->get('A.dbConnection');
// Get 'dbConnection' from container B:
$dbConnectionB = $rootContainer->get('B.dbConnection');
// This will throw a NotFoundException:
$willFail = $rootContainer->get('dbConnection');
```
Working with delegate lookup containers
---------------------------------------
If the container you are wrapping is implementing the [delegate lookup feature](https://github.com/container-interop/container-interop/blob/master/docs/Delegate-lookup.md)
(it should!), you will face another problem.
When you use the delegate lookup feature, the dependencies are fetched from the root container. Now, the name of the
dependencies has changed because of the `PrefixerContainer`!
Just image a container with a service that uses the `dbConnection`:
What if we wrap this container in a `PrefixerContainer`? If we query the `A.myService` entry (1), the container will
delegate to the rootContainer the lookup of the `dbConnection` entry. Now, this is a problem, because it should
query the `A.dbConnection` entry.
In order to fix this, the prefixer-container comes with a `DelegateLookupUnprefixerContainer` class. This is a wrapper
you will use to wrap the delegate lookup container. When the `get` method of the wrapper is called, it will first try
to get the instance with the prefix, and if it fails, it will try to get the instance without the prefix.
If we query the `A.myService` entry (1), , the container will delegate to the rootContainer the lookup of the `dbConnection` entry (2).
This goes through the `DelegateLookupUnprefixerContainer` first that will add the "A." prefix (3). The lookup goes through the
root container again, then the prefixer container that strips the "A." and finally, the dependency `dbConnection` is solved. *Job's done!*
Here is a sample code demonstrating the code above:
```php
use Mouf\PrefixerContainer\PrefixerContainer;
use Acclimate\Container\CompositeContainer;
use Interop\Container\ContainerInterface;
use Mouf\Picotainer\Picotainer;
$prefix = "A.";
$rootContainer = new CompositeContainer();
// We use Picotainer, a minimalistic container for this demo.
$container = new Picotainer([
"dbConnection" => function () { return new DbConnection(...); },
// The myService service requires the 'dbConnection'
"myService" => function (ContainerInterface $c) { return new MyService($c->get('dbConnection')); },
], new DelegateLookupUnprefixerContainer($rootContainer, $prefix));
// In the root container, we add a prefixed version of the container
$rootContainer->addContainer(new PrefixerContainer($container, $prefix));
$service = $rootContainer->get('myService');
```
Why the need for this package?
------------------------------
This package is part of a long-term effort to bring [interoperability between DI containers](https://github.com/container-interop/container-interop).
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...)