Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michael-rubel/laravel-enhanced-container
Laravel Service Container on steroids.
https://github.com/michael-rubel/laravel-enhanced-container
container enhanced ioc-container laravel looking-for-contributors php service-container
Last synced: 12 days ago
JSON representation
Laravel Service Container on steroids.
- Host: GitHub
- URL: https://github.com/michael-rubel/laravel-enhanced-container
- Owner: michael-rubel
- License: mit
- Created: 2021-09-14T06:05:30.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-17T10:50:18.000Z (8 months ago)
- Last Synced: 2024-04-14T12:40:26.188Z (7 months ago)
- Topics: container, enhanced, ioc-container, laravel, looking-for-contributors, php, service-container
- Language: PHP
- Homepage:
- Size: 580 KB
- Stars: 83
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Laravel Enhanced Container
[](https://packagist.org/packages/michael-rubel/laravel-enhanced-container)
[](https://packagist.org/packages/michael-rubel/laravel-enhanced-container)
[](https://scrutinizer-ci.com/g/michael-rubel/laravel-enhanced-container/?branch=main)
[](https://scrutinizer-ci.com/g/michael-rubel/laravel-enhanced-container/?branch=main)
[](https://github.com/michael-rubel/laravel-enhanced-container/actions)
[](https://github.com/michael-rubel/laravel-enhanced-container/actions)
This package provides additional features for Laravel's Service Container.
## #StandWithUkraine
[](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
## Contents
* [Installation](#installation)
* [Usage](#usage)
+ [Resolve contextual binding outside of constructor](#resolve-contextual-binding-outside-of-constructor)
+ [Method binding](#method-binding)
+ [Method forwarding](#method-forwarding)
## Installation
Install the package via composer (Laravel 11):
```bash
composer require michael-rubel/laravel-enhanced-container
```
If you need the package for older versions of Laravel, check [changelog](https://github.com/michael-rubel/laravel-enhanced-container/releases).
## Usage
### Resolve contextual binding outside of constructor
```php
call(ServiceInterface::class, context: static::class);
// The `call` method automatically resolves the implementation from the interface you passed.
// If you pass the context, the proxy tries to resolve contextual binding instead of global binding first.
```
[🔝 back to contents](#contents)
### Method binding
This feature makes it possible to override the behavior of methods accessed using the `call`.
Assuming that is your function in the service class:
```php
class Service
{
public function yourMethod(int $count): int
{
return $count;
}
}
```
Bind the service to an interface:
```php
$this->app->bind(ServiceInterface::class, Service::class);
```
Call your service method through container:
```php
call(ServiceInterface::class)->yourMethod(100);
```
For example in feature tests:
```php
$this->app->bind(ApiGatewayContract::class, InternalApiGateway::class);
bind(ApiGatewayContract::class)->method('performRequest', function ($service, $app, $params) {
// Note: you can access `$params` passed to the method call.
return true;
});
$apiGateway = call(ApiGatewayContract::class);
$request = $apiGateway->performRequest();
$this->assertTrue($request);
```
Note: if you rely on interfaces, the proxy will automatically resolve bound implementation for you.
#### Note for package creators
If you want to use method binding in your own package, you need to make sure the [`LecServiceProvider`](https://github.com/michael-rubel/laravel-enhanced-container/blob/main/src/LecServiceProvider.php) registered before you use this feature.
```php
$this->app->register(LecServiceProvider::class);
```
[🔝 back to contents](#contents)
### Method forwarding
This feature automatically forwards the method if it doesn't exist in your class to the second one defined in the forwarding configuration.
You can define forwarding in your ServiceProvider:
```php
use MichaelRubel\EnhancedContainer\Core\Forwarding;
Forwarding::enable()
->from(Service::class)
->to(Repository::class);
```
You can as well use chained forwarding:
```php
Forwarding::enable()
->from(Service::class)
->to(Repository::class)
->from(Repository::class)
->to(Model::class);
```
#### Important notes
- Pay attention to which internal instance you're now working on in `CallProxy` when using forwarding. The instance may change without your awareness. If you interact with the same methods/properties on a different instance, the `InstanceInteractionException` will be thrown.
- If you use `PHPStan/Larastan` you'll need to add the `@method` docblock to the service to make it static-analyzable, otherwise it will return an error that the method doesn't exist in the class.
[🔝 back to contents](#contents)
## Testing
```bash
composer test
```
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.