communitales/command-bus

Communitales Command Bus Component

2.1.0 2024-04-19 18:06 UTC

Requires

• php: >=8.3
• communitales/log: ^3.1
• communitales/status-bus: ^2.0

Requires (Dev)

• doctrine/orm: ^3.1
• friendsofphp/php-cs-fixer: ^3.51
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3
• phpunit/phpunit: ^10.5
• psalm/plugin-phpunit: ^0.19.0
• rector/rector: ^1.0
• vimeo/psalm: ^5.23

Conflicts

• doctrine/orm: <3.0

MIT

• php
• command-bus

README

Decouple applications with a synchronous command bus.

Setup

composer require communitales/command-bus

Setup for Symfony in services.yaml:

services:

    _instanceof:
        Communitales\Component\CommandBus\CommandBusAwareInterface:
            calls:
                - [setCommandBus, ['@Communitales\Component\CommandBus\CommandBus']]

        Communitales\Component\CommandBus\Handler\CommandHandlerInterface:
            tags: ['communitales.command_handler']


    Communitales\Component\CommandBus\CommandBus:
        arguments:
            - !tagged_iterator communitales.command_handler

Usage

Example of a command:

namespace App\Domain\Command\Customer;

use Communitales\Component\CommandBus\Command\CommandInterface;
use App\Entity\Customer;

readonly class CreateCustomerCommand implements CommandInterface
{
    public function __construct(public Customer $customer)
    {
    }
}

Example of a command handler:

namespace App\Domain\Handler\Customer;

use App\Domain\Command\Customer\CreateCustomerCommand;
use App\Domain\Command\Customer\DeleteCustomerCommand;
use App\Domain\Command\Customer\UpdateCustomerCommand;
use App\Repository\CustomerRepository;
use Communitales\Component\CommandBus\Command\CommandInterface;
use Communitales\Component\CommandBus\Handler\CommandHandlerInterface;
use Communitales\Component\CommandBus\Handler\CommandHandlerTrait;
use Communitales\Component\CommandBus\Handler\Result\CommandHandlerResultInterface;
use Communitales\Component\CommandBus\Handler\Result\SuccessResult;
use Communitales\Component\StatusBus\StatusMessage;
use Override;
use Symfony\Component\Translation\TranslatableMessage;

use function sprintf;

class CustomerCommandHandler implements CommandHandlerInterface
{
    use CommandHandlerTrait;

    public function __construct(private readonly CustomerRepository $customerRepository) {
    }

    #[Override]
    public function canHandle(CommandInterface $command): bool
    {
        return $command instanceof CreateCustomerCommand
            || $command instanceof UpdateCustomerCommand
            || $command instanceof DeleteCustomerCommand;
    }

    private function createCustomer(CreateCustomerCommand $command): CommandHandlerResultInterface
    {
        $customer = $command->customer;

        $this->customerRepository->save($customer);

        return new SuccessResult(
            StatusMessage::createSuccessMessage(
                new TranslatableMessage(
                    'domain_customer.result_created', ['name' => $customer->getName()]
                )
            )
        );
    }

    private function updateCustomer(UpdateCustomerCommand $command): CommandHandlerResultInterface
    {
        // ...
    }

    private function deleteCustomer(DeleteCustomerCommand $command): CommandHandlerResultInterface
    {
        // ...
    }
}