rosamarsky/laravel-command-bus

Simple Command Bus for Laravel framework

2.0.1 2021-09-20 13:20 UTC

This package is auto-updated.

Last update: 2024-03-20 19:05:21 UTC


README

Simple Command Bus for Laravel framework

Installation

composer require rosamarsky/laravel-command-bus

If your Laravel version is less than 5.5, add the following line to the providers array in config / app.php:

Rosamarsky\CommandBus\CommandBusServiceProvider::class,

Example

class UserController extends AbstractController
{
    public function store(Request $request)
    {
        $user = $this->dispatch(new RegisterUser(
            $request->input('email'),
            $request->input('password')
        ));
    
        return $user;
    }
}

Usage

Command

class RegisterUser implements \Rosamarsky\CommandBus\Command
{
    private $email;
    private $password;
    
    public function __construct(string $email, string $password)
    {
        $this->email = $email;
        $this->password = $password;
    }
    
    public function email(): string
    {
        return $this->email;
    }
    
    public function password(): string
    {
        return $this->password;
    }
}

Handler

class RegisterUserHandler implements \Rosamarsky\CommandBus\Handler
{
    private $userRepository;
    
    public function __construct(UserRepository $userRepository)
    {
        $this->userRepository = $userRepository;
    }
    
    public function handle(\Rosamarsky\CommandBus\Command $command): User
    {
        $user = new User(
            $command->email(),
            $command->password()
        );
        
        $this->userRepository->store($user);
        
        return $user;
    }
}

Controllers

class AbsctractController extends \Illuminate\Routing\Controller
{
    private $dispatcher;
    
    public function __construct(\Rosamarsky\CommandBus\CommandBus $dispatcher) 
    {
        $this->dispatcher = $dispatcher;
    }
    
    public function dispatch(\Rosamarsky\CommandBus\Command $command)
    {
        return $this->dispatcher->execute($command);
    }
}
class UserController extends AbstractController
{
    public function store(Request $request)
    {
        $user = $this->dispatch(new RegisterUser(
            $request->input('email'),
            $request->input('password')
        ));
    
        return $user;
    }
}