ericksonreyes/command-bus

Simple Command Bus Class for PHP 8

dev-master 2023-03-12 21:13 UTC

Requires

• php: 8.1.*

Requires (Dev)

• fakerphp/faker: 1.20.*
• friends-of-phpspec/phpspec-code-coverage: 6.1.*
• mockery/mockery: 1.5.*
• phing/phing: 2.17.*
• php-coveralls/php-coveralls: 2.5.*
• php-parallel-lint/php-console-color: 1.0.*
• php-parallel-lint/php-console-highlighter: 1.0.*
• php-parallel-lint/php-parallel-lint: 1.3.*
• php-parallel-lint/php-var-dump-check: 0.*
• phpmd/phpmd: 2.13.*
• phpspec/phpspec: 7.2.*
• phpunit/phpunit: 9.5.*
• povils/phpmnd: 3.0.*
• sebastian/phpcpd: 6.0.*
• squizlabs/php_codesniffer: 3.7.*

MIT

• Erickson Reyes

README

Nothing fancy. I just created my command bus that I've been copy-pasting over and over again. I usually move most of the business or application logic away from framework controllers (MVC) and put it into commands and handlers.

But I don't want to couple the command handler with the framework controller. I want to be able to assign and switch them via a dependency injection library.

Installation

composer require ericksonreyes/command-bus

Example (Lumen Framework + Symfony Dependency Injection)

Symfony Service Container Configuration

services:

  uuid_generator:
    class: App\Services\UuidGenerator

  user_repository:
    class: App\Repositories\UserRepository

  user_registration_service:
    class: Application\Users\Service\UserRegistrationService
    arguments:
    - '@user_repository'

Lumen Controller

namespace App\Http\Controllers;

use App\Repository\UserRepository;
use Illuminate\Support\Facades\URL;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Illuminate\Routing\Controller as BaseController;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Application\Users\UseCase\RegisterUser;

/**
* Class UserRegistrationController
 * @package App\Http\Controllers
 */
class UserRegistrationController extends BaseController {

    /**
     * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
     * @param \Illuminate\Http\Request $request
     * @return \Illuminate\Http\Response
    */
    public function store(
        ContainerInterface $container, 
        Request $request
    ): Response {
        try {
            $url = URL::current();
            $id = $uuidGenerator->generate(prefix: 'user-');
            $uuidGenerator = $container->get('uuid_generator');
            $handler = $container->get('user_registration_service');
            
            $command = new RegisterUser(
                $id,
                $request->get('email'),
                $request->get('password'),
                $request->get('password_confirmation')
            );
            $handler->handleThis($command);
            
            return \response([
                '_embedded' => [
                    '_links' => [
                        'self' => [
                            'href' => url("{$url}/{$id}")
                        ]
                    ],
                    'id' => $id                            
                ]
            ], 201);
        }
        catch (\Exception $exception) {
            $httpCode = 500;
            if ($exception->getCode() >= 400 && $exception->getCode() < 600) {
                $httpCode =$exception->getCode();
            }
            
            return \response([
                '_error' => [
                    'code' => get_class($exception),
                    'message' => $exception->getMessage()            
                ]
            ], $httpCode);
        }
    }
   
}

Author

• Erickson Reyes (GitHub, GitLab, LinkedIn and Packagist).

License

See LICENSE

Gitlab

This project is also available in GitLab