Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elazar/auryn-container-interop
container-interop compatibility for Auryn
https://github.com/elazar/auryn-container-interop
auryn container-interop dependency-injection php psr-11
Last synced: 2 months ago
JSON representation
container-interop compatibility for Auryn
- Host: GitHub
- URL: https://github.com/elazar/auryn-container-interop
- Owner: elazar
- License: mit
- Created: 2016-06-25T19:46:49.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-01T14:40:23.000Z (over 6 years ago)
- Last Synced: 2024-10-03T10:48:39.888Z (3 months ago)
- Topics: auryn, container-interop, dependency-injection, php, psr-11
- Language: PHP
- Size: 10.7 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# auryn-container-interop
[](https://travis-ci.org/elazar/auryn-container-interop)
[PSR-11](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-11-container.md) compatibility for [Auryn](https://github.com/rdlowrey/Auryn)
## License
This library is licensed under the [MIT License](https://opensource.org/licenses/MIT).
## Installation
Use [composer](https://getcomposer.org/).
```
composer require elazar/auryn-container-interop
```
## Usage
```php
use Elazar\Auryn\Container;
use Acme\SomeDependency;
$container = new Container;
if ($container->has(SomeDependency::class)) {
// ...
}
$instance = $container->get(SomeDependency::class);
// All public methods of Auryn\Injector are available
$instance = $container->make(SomeDependency::class);
```
Be sure you are familiar with [how Auryn works](https://github.com/rdlowrey/Auryn#how-it-works).
As recommended by its author, avoid using it as a [service locator](https://en.wikipedia.org/wiki/Service_locator_pattern).
## Implementation
While I agree with a lot of the discussion in [this issue](https://github.com/rdlowrey/Auryn/issues/77)
regarding why new projects can use Auryn directly without a *PSR-11*
implementation, I do think that such an implementation can be useful for
integrating Auryn with third-party libraries that use *PSR-11*, such
as [zend-expressive](https://github.com/zendframework/zend-expressive).
The implementation in this repository takes a small amount of liberty with this
passage from [Section 1.1.2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-11-container.md#112-reading-from-a-container)
of the *PSR-11* specification:
> `has` ... MUST return `true` if an entry identifier is known to the container
Auryn uses [fully qualified names](https://en.wikipedia.org/wiki/Fully_qualified_name)
for classes and interfaces to identify dependencies where most container
implementations use user-designated names. As such, it's possible for Auryn to
instantiate a class even if it contains no definitions for that class (e.g.
if the class has no required constructor parameters or if those parameters are
themselves instantiable classes).
Because of this, `ContainerInterface->has()` in this *PSR-11*
implementation will return `true` if either the underlying `Auryn\Injector`
instance has definitions for a requested class or interface or if a requested
class is defined and considered instantiable (i.e. is not `abstract` and has a
`public` implementation of `__construct()`). While some may view this as
technically incorrect, it seems consistent to me with the overall spirit and
intentions of the *PSR-11* standard.
## Development
To run the PHPUnit test suite:
```
composer run-script test
```