upgate/laravel-command-bus

Laravel Command Bus

0.2.1 2020-08-15 14:01 UTC

Requires

• php: >=7.2
• illuminate/contracts: ^5.1 || ^6 || ^7
• illuminate/support: ^5.1 || ^6 || ^7

Requires (Dev)

• phpunit/phpunit: ~8.2

BSD-2-Clause

• laravel
• command bus

README

Setup

1. composer require upgate/laravel-command-bus
2. Register Upgate\LaravelCommandBus\CommandBusServiceProvider as a service provider
3. In your service provider, bind Upgate\LaravelCommandBus\HandlerResolver to an implementation of your choice.

HandlerResolver binding examples:

a) PatternHandlerResolver:

$this->app->singleton(
    \Upgate\LaravelCommandBus\HandlerResolver::class,
    function () {
        return new \Upgate\LaravelCommandBus\PatternHandlerResolver(
            '\YourAppNamespace\CommandHandlers\%sHandler'
        );
    }
);

b) MapHandlerResolver:

use YourAppNamespace\Commands;
use YourAppNamespace\CommandHandlers;
// ...
$this->app->singleton(
    \Upgate\LaravelCommandBus\HandlerResolver::class,
    function () {
        return new \Upgate\LaravelCommandBus\MapHandlerResolver(
            [
                Commands\FooCommand::class => Handlers\FooHandler::class,
                Commands\BarCommand::class => Handlers\BarHandler::class,
                // ...
            ]
        );
    }
);

c) Bind your own implementation (must extend \Upgate\LaravelCommandBus\HandlerResolver).

Usage

Simplified example:

// Command
class SignUpCommand {

    public function __construct($email, $password)
    {
        $this->email = $email;
        $this->password = $password;
    }
    
    public function email()
    {
        return $this->email;
    }
    
    public function password()
    {
        return $this->password;
    }
}

// Handler
class SignUpHandler {

    public function __construct(UserRepository $userRepository)
    {
        $this->userRepository = $userRepository;
    }
    
    public function handle(SignUpCommand $command)
    {
        $user = User::signUp($command->email(), $command->password());
        $this->userRepository->store($user);
    }

}

// HTTP Controller
use Upgate\LaravelCommandBus\CommandBus;

class UserController {

    private $commandBus;

    public function __construct(CommandBus $commandBus)
    {
        $this->commandBus = $commandBus;
    }
    
    public function signUp(Request $request)
    {
        $this->commandBus->execute(new SignUpCommand(
            $request->get('email'),
            $request->get('password')
        ));
    }

}

// Console command
use Upgate\LaravelCommandBus\CommandBus;

class SignUpUserConsoleCommand
{

    private $commandBus;

    public function __construct(CommandBus $commandBus)
    {
        $this->commandBus = $commandBus;
    }
    
    public function handle()
    {
        $this->commandBus->execute(new SignUpCommand(
            $this->argument('email'),
            $this->argument('password')
        ));
    }
    
}

Of course, you might (and should) want to introduce Controller and ConsoleCommand abstract classes with executeCommand() methods implemented.