README

componenta/cqrs is the neutral CQRS runtime for PHP 8.4+. main is the CQRS v4 line.

composer require componenta/cqrs

Register Componenta\CQRS\ConfigProvider. It provides the standard command/query buses, locators, operation factory, metadata provider, and CQRS map provider.

Commands and operations

$operation = $commands->dispatch(new CreateUserCommand($email));
$result = $operation->result?->value;

One dispatch() creates one OperationInterface and sends it through the complete command pipeline.

An operation contains:

UUID v7 id;
the command instance;
createdAt, the UTC timestamp when this local operation object was created for dispatch;
attributes with a strict array<string,mixed> contract;
optional OperationResult, whose processedAt records synchronous completion.

createdAt is deliberately not named startedAt: operation creation happens before middleware and is not the same thing as handler execution start. Async transports must not restore producer createdAt as a worker execution timestamp.

CQRS v4 keeps the operation factory separate from middleware composition:

$bus = new Componenta\CQRS\Command\CommandBus(
    commandHandler: $terminalHandler,
    middlewares: [
        $firstMiddleware,
        $secondMiddleware,
    ],
    operationFactory: $operationFactory,
);

The operation factory is optional; OperationFactory is used by default.

Multiple commands

BatchCommandBus is the explicit sequential multi-dispatch decorator:

$batch = new Componenta\CQRS\Command\BatchCommandBus($commands);

$operations = $batch->dispatchMany([
    new FirstCommand(),
    new SecondCommand(),
]);

Each command is dispatched independently through the wrapped bus and receives its own operation. Core no longer contains SequentialMiddleware; nested dispatch() calls use normal reentrant dispatch semantics. Work that must happen after the current command or transaction should use an explicit event, outbox, async transport, or workflow/process manager.

Command middleware

Command middleware implements:

public function execute(
    OperationInterface $operation,
    OperationHandlerInterface $handler,
): OperationInterface;

HandleCommandHandler is the terminal handler. ConfigProvider registers EventMiddleware as a service, but does not insert it into the pipeline automatically. Add it to ConfigKey::COMMAND_MIDDLEWARES when command lifecycle listeners should run.

Middleware order

Middleware execute exactly in the order supplied by application configuration. CommandBus validates the middleware collection and compiles that order; it does not infer, reorder, or reject application topology based on other packages.

The order is therefore part of application behavior. For example, with retry and transaction middleware:

RetryMiddleware
  TransactionMiddleware
    handler

creates a new transaction for each retry attempt, while:

TransactionMiddleware
  RetryMiddleware
    handler

keeps all retry attempts inside one surrounding transaction. Neither topology is rejected by CQRS core; applications choose the semantics they need.

Optional package documentation describes useful ordering patterns and their consequences, but ordering remains configuration responsibility.

Command lifecycle events

EventMiddleware can emit:

CommandProcessEvent before downstream command execution;
CommandProcessedEvent after success;
CommandFailedEvent after failure before rethrow.

Listener failures propagate by default. The position of EventMiddleware relative to policy, transport, retry, lock, transaction, or custom middleware is application-defined.

Queries

$result = $queries->handle(new GetUserQuery($id));

QueryBusInterface::handle(object $query, ContextInterface|array $context = []) normalizes array context to immutable Context. Query context attributes use the same non-empty string-key invariant as operation attributes.

CQRS map and environments

Runtime discovery and compiled execution use one versioned CQRS map model. An empty valid artifact is:

['version' => 2]

The application environment defaults to development when APP_ENV is absent. Therefore a missing APP_ENV or explicit APP_ENV=development may use the live discovery overlay from componenta/cqrs-app. Any explicit non-development environment, including production, staging, and test, is compiled-only and requires a current map artifact.

Build it from development discovery:

APP_ENV=development php bin/console.php app:build

Metadata

CommandMetadataProviderInterface exposes:

$metadata->get($command, Attribute::class);
$metadata->isKnown($command);

CQRS v4's standard CompiledCommandMetadataProvider is strictly map-backed. Missing metadata returns null; it never appears implicitly because the command class happens to exist at runtime. This keeps development discovery and compiled execution on the same metadata contract.

ReflectionCommandMetadataProvider remains available only as an explicit alternative implementation.

Optional packages add their metadata classes through ConfigKey::COMMAND_METADATA_ATTRIBUTES, allowing componenta/cqrs-app to discover and compile the same descriptors.

Discovery attributes

componenta/cqrs-app understands:

#[Componenta\CQRS\Command\Attribute\AsCommandHandler]
#[Componenta\CQRS\Command\Attribute\AsCommandListener]
#[Componenta\CQRS\Query\Attribute\AsQueryHandler]

A handler's message must occupy the first parameter slot. Additional required handler parameters are not dependency-injected by the CQRS runtime.

Optional packages

Package	Responsibility
`componenta/cqrs-app`	Development discovery and build-time map compilation
`componenta/cqrs-policy`	Command/query authorization
`componenta/cqrs-retry`	Retry metadata and middleware
`componenta/cqrs-lock`	Resource locking
`componenta/cqrs-transaction-cycle`	Cycle Database transactions
`componenta/cqrs-transport`	Async transport contracts, serializers, middleware, worker
`componenta/cqrs-transport-cycle`	Cycle Database transport
`componenta/cqrs-transport-console`	Symfony Console worker

Verification

composer test
composer analyse
composer bench

CI targets PHP 8.4/8.5, runs the Pest suite and PHPStan at maximum level, and the ordinary test suite loads benchmark setup as an API compatibility check.

componenta / cqrs

Maintainers

Package info

Statistics

Security