michael-rubel/laravel-enhanced-container

This package provides DX tweaks for Service Container in Laravel.

12.0.0 2024-03-12 21:31 UTC

Requires

• php: ^8.1
• illuminate/contracts: ^10.0|^11.0
• spatie/laravel-package-tools: ^1.9

Requires (Dev)

• brianium/paratest: ^6.3|^7.4
• infection/infection: ^0.27.3
• laravel/pint: ^1.0
• nunomaduro/collision: ^6.0|^7.0|^8.0
• nunomaduro/larastan: ^2.0
• orchestra/testbench: ^8.0|^9.0
• phpunit/phpunit: ^9.5|^10.5

MIT

• Michael Rubel

• laravel
• michael-rubel
• laravel-enhanced-container
• lec

README

Laravel Enhanced Container

This package provides additional features for Laravel's Service Container.

The package requires PHP ^8.1 and Laravel ^10.x.

#StandWithUkraine

Contents

• Installation
• Usage
  • Resolve contextual binding outside of constructor
  • Method binding
  • Method forwarding

Installation

Install the package via composer (Laravel 10):

composer require michael-rubel/laravel-enhanced-container

If you need the version for Laravel 9, use:

composer require michael-rubel/laravel-enhanced-container "^10.0"

Usage

Resolve contextual binding outside of constructor

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

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:

class Service
{
    public function yourMethod(int $count): int
    {
        return $count;
    }
}

Bind the service to an interface:

$this->app->bind(ServiceInterface::class, Service::class);

Call your service method through container:

call(ServiceInterface::class)->yourMethod(100);

For example in feature tests:

$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 registered before you use this feature.

$this->app->register(LecServiceProvider::class);

🔝 back to 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:

use MichaelRubel\EnhancedContainer\Core\Forwarding;

Forwarding::enable()
    ->from(Service::class)
    ->to(Repository::class);

You can as well use chained forwarding:

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

Testing

composer test

License

The MIT License (MIT). Please see License File for more information.