Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrisnharvey/container
Dependency injection container with service providers and proxies
https://github.com/chrisnharvey/container
Last synced: about 4 hours ago
JSON representation
Dependency injection container with service providers and proxies
- Host: GitHub
- URL: https://github.com/chrisnharvey/container
- Owner: chrisnharvey
- License: mit
- Created: 2014-01-24T17:11:00.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-03-09T22:56:46.000Z (over 9 years ago)
- Last Synced: 2024-08-07T14:06:28.696Z (3 months ago)
- Language: PHP
- Homepage:
- Size: 379 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# EncorePHP Container
[](https://github.com/encorephp/container/releases)
[](LICENSE.md)
[](https://travis-ci.org/encorephp/container)
[](https://scrutinizer-ci.com/g/encorephp/container/code-structure)
[](https://scrutinizer-ci.com/g/encorephp/container)
[](https://packagist.org/packages/encorephp/container)
The EncorePHP Container library provides a fast and powerful Dependency Injection Container for your application.
As well as a dependency injection container, we also allow the use of service providers
and proxies.
## Install
Via Composer
``` bash
$ composer require encorephp/container
```
## Usage
### Get a Container Object
```php
require 'vendor/autoload.php';
$container = new Encore\Container\Container;
```
### Bind a concrete class to an interface
```php
$container->bind('\Foo\Bar\BazInterface', '\Foo\Bar\Baz');
```
### Automatic Dependency Resolution
The Container is able to recursively resolve objects and their dependencies by inspecting the type hints on an object's constructor.
```php
namespace Foo\Bar;
class Baz
{
public function __construct(Qux $qux, Corge $corge)
{
$this->qux = $qux;
$this->corge = $corge;
}
public function setQuux(Quux $quux)
{
$this->quux = $quux;
}
}
$container->resolve('\Foo\Bar\Baz');
```
### Defining Arguments
Alternatively, you can specify what to inject into the class upon instantiation.
#### Define Constructor Args
```php
$container->bind('\Foo\Bar\Baz')->addArgs(array('\Foo\Bar\Quux', '\Foo\Bar\Corge'));
$container->resolve('\Foo\Bar\Baz');
```
#### Define Methods to Call with Args
```php
$container->bind('\Foo\Bar\Baz')->withMethod('setQuux', array('\Foo\Bar\Quux'));
$container->resolve('\Foo\Bar\Baz');
```
### Resolve Inherited Dependencies
Another great feature of the the container is the ability to resolve the dependencies
of inherited classes and interfaces. For example, you could bind an interface into the
container which requires a dependency injected via a method, and all classes that implement
that interface will also have that dependency injected automatically.
```php
$container->bind('\Foo\Bar\BazInterface')->withMethod('setQuux', ['\Foo\Bar\Quux']);
$container->bind('\Foo\Bar\Baz');
$container->resolve('\Foo\Bar\Baz');
```
### Child Containers and Scope Resolution
A great feature of the container is it's ability to provide child containers with a separate resolution scope to that of it's parent container. If you bind a concrete class to an interface within one container, you can re-bind it in the child container, without fear of overwriting the original binding in the parent container.
#### Creating a Child Container
There are two ways to create a child container.
```php
$child = $continer->createChild();
// OR
$child = new Container($container);
```
#### Using a Child Container
The primary benefit of using child containers is scope-specific resolution.
```php
$container->bind('FooInterface', 'Foo');
// Assuming class Bar has a FooInterface dependency.
// This would use the Foo implementation.
$bar = $container->resolve('Bar');
// ...
$child = $container->createChild();
$child->bind('FooInterface', 'Baz');
// And this would use the Baz implementation.
$bar = $child->resolve('Bar');
```
## Testing
``` bash
$ phpunit
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## Credits
The EncorePHP Container is based onthe deprecated [league/di](https:/github.com/thephpleague/di)
package.
- [Chris Harvey](https://github.com/chrisnharvey)
- [Don Gilbert](https://github.com/dongilbert)
- [Phil Bennett](https://twitter.com/philipobenito)
- [All Contributors](../../contributors)
- [Original Contributors](https://github.com/thephpleague/di/contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.