Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bayfrontmedia/container
An easy to use PSR-11 compatible dependency injection container.
https://github.com/bayfrontmedia/container
container dependency di injection php psr-11
Last synced: about 5 hours ago
JSON representation
An easy to use PSR-11 compatible dependency injection container.
- Host: GitHub
- URL: https://github.com/bayfrontmedia/container
- Owner: bayfrontmedia
- License: mit
- Created: 2020-08-01T22:09:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-26T20:47:21.000Z (almost 2 years ago)
- Last Synced: 2024-09-15T13:33:33.191Z (about 2 months ago)
- Topics: container, dependency, di, injection, php, psr-11
- Language: PHP
- Homepage:
- Size: 44.9 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
## Container
An easy to use PSR-11 compatible dependency injection container.
- [License](#license)
- [Author](#author)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
## License
This project is open source and available under the [MIT License](LICENSE).
## Author
- [Bayfront Media homepage](https://www.bayfrontmedia.com?utm_source=github&utm_medium=direct)
- [Bayfront Media GitHub](https://github.com/bayfrontmedia)
## Requirements
* PHP `^8.0`
## Installation
```
composer require bayfrontmedia/container
```
## Usage
### Start using the container
```
use Bayfront\Container;
$container = new Container();
```
### Public methods
- [set](#set)
- [getEntries](#getentries)
- [get](#get)
- [make](#make)
- [has](#has)
- [remove](#remove)
- [setAlias](#setalias)
- [getAliases](#getaliases)
- [hasAlias](#hasalias)
- [removeAlias](#removealias)
### set
**Description:**
Set an entry into the container.
Anonymous functions (closures) are called on the first `get()`.
**Parameters:**
- `$id` (string)
- `$value` (mixed)
- `$overwrite = false` (bool): If false, a `ContainerException` is thrown if an entry with the same ID already exists.
Otherwise, it is overwritten.
**Returns:**
- (void)
**Throws:**
- `Bayfront\Container\ContainerException`
**Example:**
Any type of value can be set in the container.
Services with dependencies can be set using an anonymous function (a `\Closure`)
which returns an instance of the class.
The first time a service is requested from the container using `get()`,
the anonymous function is called and the result is saved.
On subsequent calls, the same ID always returns the same result.
The anonymous function always calls the container instance as the first argument.
This allows you to reference other items from the container, if needed.
If you do not need access to the container, the parameter may be omitted from the function signature.
```php
// Set a service with no dependencies
$container->set('Fully\Namespaced\ClassName', function () {
return new ClassName();
});
// Set a service with dependencies
$container->set('Fully\Namespaced\ClassName', function (ContainerInterface $container) {
$dependency = $container->get('Fully\Namespaced\Dependency');
return new ClassName($dependency);
});
// Any type of value can be set, then used as a parameter
$container->set('classname_config', [
// Config array
]);
$container->set('Fully\Namespaced\ClassName', function (ContainerInterface $container) {
$config = $container->get('classname_config');
return new ClassName($config);
});
// Preexisting class instances can be set without using an anonymous function
$class = new ClassName();
$container->set('ClassName', $class);
```
### getEntries
**Description:**
Returns an array of all ID's existing in the container.
**Parameters:**
- None.
**Returns:**
- (array)
**Example:**
```php
$entries = $container->getEntries();
```
### get
**Description:**
Get an entry from the container by its ID or alias.
**Parameters:**
- `$id` (string)
**Returns:**
- (mixed)
**Throws:**
- `Bayfront\Container\NotFoundException`
**Example:**
```php
$service = $container->get('Fully\Namespaced\ClassName');
```
### make
**Description:**
Makes and returns a new class instance, automatically injecting dependencies which exist in the container.
**Parameters:**
- `$class` (string)
- `$params = []` (array): Additional parameters to pass to the class constructor.
**Returns:**
- (mixed)
**Throws:**
- `Bayfront\Container\ContainerException`
- `Bayfront\Container\NotFoundException`
**Example:**
```php
class ClassName {
protected $service;
protected $config;
public function __construct(AnotherService $service, array $config)
{
$this->service = $service;
$this->config = $config;
}
}
$instance = $container->make('Fully\Namespaced\ClassName', [
'config' => []
]);
```
### has
**Description:**
Does entry or alias exist in the container?
(ie: Can an entry be resolved using `get()` with this ID?)
**Parameters:**
- `$id` (string): ID or alias
**Returns:**
- (bool)
**Example:**
```php
if ($container->has('Fully\Namespaced\ClassName')) {
// Do something
}
```
### remove
**Description:**
Remove entry from container, if existing.
**Parameters:**
- `$id` (string)
**Returns:**
- (void)
**Example:**
```php
$container->remove('Fully\Namespaced\ClassName');
```
### setAlias
**Description:**
Set an alias for a given ID.
**Parameters:**
- `$alias` (string)
- `$id` (string)
- `$overwrite = false` (bool): If false, a `ContainerException` is thrown if an alias with the same name already exists.
Otherwise, it will be overwritten.
**Returns:**
- (void)
**Throws:**
- `Bayfront\Container\ContainerException`
**Example:**
```php
$container->setAlias('alias', 'Fully\Namespaced\ClassName');
```
One benefit of aliases is that they allow you to retrieve entries from the container in a concise, easy to remember manner.
In addition, aliases allow you to bind an interface to an implementation.
For example:
```php
$container->setAlias('Fully\Namespaced\Implementation', 'Fully\Namespaced\Interface');
```
Now, whenever a class requires an implementation of `Fully\Namespaced\Interface`,
an instance of `Fully\Namespaced\Implementation` will be returned, if existing in the container.
### getAliases
**Description:**
Returns an array of all existing aliases.
**Parameters:**
- None.
**Returns:**
- (array)
**Example:**
```php
$aliases = $container->getAliases();
```
### hasAlias
**Description:**
Does alias exist?
**Parameters:**
- `$alias` (string)
**Returns:**
- (bool)
**Example:**
```php
if ($container->hasAlias('alias')) {
// Do something
}
```
### removeAlias
**Description:**
Remove alias.
**Parameters:**
- `$alias` (string)
**Returns:**
- (void)
**Example:**
```php
$container->removeAlias('alias');
```