bowphp/cqrs

Command Query Responsibility Segregation

1.2.1 2023-08-23 19:35 UTC

Requires

• php: ^8.1
• bowphp/framework: ^5.0

Requires (Dev)

• phpunit/phpunit: ^10.1@dev
• squizlabs/php_codesniffer: 4.0.x-dev

MIT

• Franck DAKIA

README

CQRS (Command Query Responsibility Segregation). It's a pattern that I first heard described by Greg Young. At its heart is the notion that you can use a different model to update information than the model you use to read information. For some situations, this separation can be valuable but beware that for most systems CQRS adds risky complexity.

For more information

Install

The package uses php >= 8.1

composer require bowphp/cqrs

Help

First, create the example command:

use Bow\CQRS\Command\CommandInterface;

class CreateUserCommand implements CommandInterface
{
    public function __construct(
        public string $username,
        public string $email
    ) {}
}

Create the handler here:

use Bow\CQRS\Command\CommandHandlerInterface;

class CreateUserCommandHandler implements CommandHandlerInterface
{
    public function __construct(public UserService $userService) {}

    public function process(CommandInterface $command): mixed
    {
        if ($this->userService->exists($command->email)) {
            throw new UserServiceException(
                "The user already exists"
            );
        }

        return $this->userService->create([
            "username" => $command->username,
            "email" => $command->email
        ]);
    }
}

Add command to the register in App\Configurations\ApplicationConfiguration::class:

use Bow\CQRS\Registration as CQRSRegistration;

public function run()
{
    CQRSRegistration::commands([
        CreateUserCommand::class => CreateUserCommandHandler::class
    ]);
}

Execute the command in the controller:

namespace App\Controllers;

use App\Controllers\Controller;
use App\Commands\CreateUserCommand;

class UserController extends Controller
{
    public function __construct(private CommandBus $commandBus) {}

    public function __invoke(Request $request)
    {
        $payload = $request->only(['username', 'email']);
        $command = new CreateUserCommand(
            $payload['username'],
            $payload['email']
        );

        $result = $this->commandBus->execute($command);

        return redirect()
            ->back()
            ->withFlash("message", "User created");
    }
}

Put a new route:

$app->post("/users/create", UserController::class);

Contributing

Thank you for considering contributing to Bow Framework! The contribution guide is in the framework documentation.

• Franck DAKIA
• Thank's collaborators

Contact

[e-mail] - @papacdev

Please, if there is a bug in the project. Contact me by email or leave me a message on slack. or join us on slack