Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ghostwriter/container
Provides a Dependency Injection Service Container for PHP
https://github.com/ghostwriter/container
container dependency-injection ghostwriter php psr-11 service-container
Last synced: about 1 month ago
JSON representation
Provides a Dependency Injection Service Container for PHP
- Host: GitHub
- URL: https://github.com/ghostwriter/container
- Owner: ghostwriter
- License: bsd-3-clause
- Created: 2021-11-24T15:09:35.000Z (almost 3 years ago)
- Default Branch: 4.0.x
- Last Pushed: 2024-10-09T18:18:49.000Z (about 1 month ago)
- Last Synced: 2024-10-09T19:08:04.606Z (about 1 month ago)
- Topics: container, dependency-injection, ghostwriter, php, psr-11, service-container
- Language: PHP
- Homepage: https://github.com/ghostwriter/container
- Size: 1.03 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Container
[](https://github.com/ghostwriter/container/actions/workflows/automation.yml)
[](https://www.php.net/supported-versions)
[](https://github.com/sponsors/ghostwriter)
[](https://dashboard.stryker-mutator.io/reports/github.com/ghostwriter/container/main)
[](https://codecov.io/gh/ghostwriter/container)
[](https://shepherd.dev/github/ghostwriter/container)
[](https://packagist.org/packages/ghostwriter/container)
[](https://packagist.org/packages/ghostwriter/container)
Provides an extensible Dependency Injection Service Container for Automated Object Composition, Interception, and Lifetime Management.
## Installation
You can install the package via composer:
``` bash
composer require ghostwriter/container
```
## Usage
### Simple usage
Registering a service on the given container.
```php
final readonly class Service
{
public function __construct(
private Dependency $dependency
) {}
public function dependency():Dependency
{
return $this->dependency;
}
}
$container = Container::getInstance();
$service = $container->get(Service::class);
assert($service instanceof Service); // true
assert($service->dependency() instanceof Dependency); // true
```
### Attributes
Registering services using attributes.
#### `#[Inject]`
Registering a service on the container using attributes.
```php
use Ghostwriter\Container\Attribute\Inject;
final readonly class Service
{
public function __construct(
#[Inject(Dependency::class)]
private DependencyInterface $dependency
) {}
public function dependency():Dependency
{
return $this->dependency;
}
}
// the above is equivalent to the following
// $container->alias(Dependency::class, DependencyInterface::class);
final readonly class Service
{
public function __construct(
#[Inject(Dependency::class, Service::class)]
private DependencyInterface $dependency
) {}
public function dependency():Dependency
{
return $this->dependency;
}
}
// the above is equivalent to the following
// $container->bind(Service::class, DependencyInterface::class, Dependency::class);
```
---
Registering a service factory on the container using attributes.
#### `#[Factory]`
```php
use Ghostwriter\Container\Attribute\Factory;
#[Factory(ServiceFactory::class)]
final readonly class Service
{
public function __construct(
#[Factory(DependencyFactory::class)]
private Dependency $dependency
) {}
public function dependency():Dependency
{
return $this->dependency;
}
}
// the above is equivalent to the following
// $container->factory(Dependency::class, DependencyFactory::class);
// $container->factory(Service::class, ServiceFactory::class);
```
---
#### `#[Extension]`
Registering a service extension on the container using attributes.
```php
use Ghostwriter\Container\Attribute\Extension;
#[Extension(ServiceExtension::class)]
final readonly class Service
{
public function __construct(
#[Extension(DependencyExtension::class)]
private Dependency $dependency
) {}
public function dependency():Dependency
{
return $this->dependency;
}
}
// the above is equivalent to the following
// $container->extend(Service::class, ServiceExtension::class);
// $container->extend(Dependency::class, DependencyExtension::class);
```
### Service Providers
Registering a service provider on the container.
```php
interface TaskInterface {}
final readonly class Task implements TaskInterface {}
final class Tasks
{
private array $tasks = [];
public function addTask(TaskInterface $task)
{
$this->tasks[] = $task;
}
}
final readonly class TasksServiceProvider implements ServiceProviderInterface
{
public function __invoke(ContainerInterface $container)
{
$container->alias(TaskInterface::class, Task::class);
$container->set(Tasks::class, static function (Container $container) {
/** @var Tasks $tasks */
$tasks = $container->build(Tasks::class);
foreach ($container->tagged(Task::class) as $service) {
$tasks->addTask($service);
}
return $tasks;
}, [Tasks::class, 'tasks']);
}
}
$container->provide(TasksServiceProvider::class);
$service = $container->get(TaskInterface::class);
assert($service instanceof Task); // true
```
### Contextual Bindings
Registering a Contextual Bindings on the container.
```php
interface ClientInterface { }
final readonly class RestClient implements ClientInterface {
}
final readonly class GraphQLClient implements ClientInterface {
}
final readonly class GitHub
{
public function __construct(
private ClientInterface $client
) {
}
public function getClient(): ClientInterface
{
return $this->client;
}
}
// When GitHub::class asks for ClientInterface::class, it would receive an instance of GraphQLClient::class.
$container->bind(GitHub::class, ClientInterface::class, GraphQLClient::class);
// When any other service asks for ClientInterface::class, it would receive an instance of RestClient::class.
$container->alias(ClientInterface::class, RestClient::class);
```
### Service Extensions
Registering a service extension on the container.
```php
/**
* @implements ExtensionInterface
*/
final readonly class GitHubExtension implements ExtensionInterface
{
/**
* @param GitHubClient $service
* @return GitHubClient
*/
public function __invoke(ContainerInterface $container, object $service): object
{
$service->setEnterpriseUrl(
$container->get(GitHubClient::GITHUB_HOST)
);
return $service;
}
}
$container->alias(GitHubClientInterface::class, GitHubClient::class);
$container->extend(GitHubClientInterface::class, $container->get(GitHubExtention::class));
```
### Service Factory
Registering a service factory on the container.
```php
final readonly class Dependency {}
final readonly class Service
{
public function __construct(
private Dependency $dependency
){}
public function dependency():Dependency
{
return $this->dependency;
}
}
final readonly class ServiceFactory {
public function __invoke(Container $container): Service
{
return new Service($container->get(Dependency::class));
}
}
$container = Container::getInstance();
$container->factory(Service::class, ServiceFactory::class);
$service = $container->get(Service::class);
assert($service instanceof Service); // true
assert($service->dependency() instanceof Dependency); // true
```
### Testing
``` bash
composer test
```
### Changelog
Please see [CHANGELOG.md](./CHANGELOG.md) for more information what has changed recently.
### Security
If you discover any security related issues, please email `[email protected]` instead of using the issue tracker.
## Sponsors
[[`Become a GitHub Sponsor`](https://github.com/sponsors/ghostwriter)]
## Credits
- [Nathanael Esayeas](https://github.com/ghostwriter)
- [All Contributors](https://github.com/ghostwriter/container/contributors)
## License
The BSD-3-Clause. Please see [License File](./LICENSE) for more information.