README

A lightweight CQRS package for Laravel with command/query bus, middleware pipeline, query caching, and retry support.

Requirements

PHP 8.4+
Laravel 11+

Installation

composer require hassanelzarkawy/nactu

Publish the config file:

php artisan vendor:publish --tag=nactu-config

Quick Start

Commands (Write)

Create a command and its handler:

php artisan make:command CreateUser

This generates:

App\Commands\CreateUserCommand
App\Handlers\CreateUserHandler

Dispatch it:

use Nactu\CommandBusInterface;

public function store(CommandBusInterface $bus): void
{
    $bus->dispatch(new CreateUserCommand(
        name: 'Hassan',
        email: 'hassan@example.com',
    ));
}

Queries (Read)

Create a query and its handler:

php artisan make:query ListUsers

This generates:

App\Queries\ListUsersQuery
App\QueryHandlers\ListUsersHandler

Dispatch it:

use Nactu\QueryBusInterface;

public function index(QueryBusInterface $bus): JsonResponse
{
    $users = $bus->dispatch(new ListUsersQuery(
        status: 'active',
    ));

    return response()->json($users);
}

Documentation

Commands — Command bus, handlers, and write operations
Queries — Query bus, cacheable queries, and read operations
Middleware — Built-in and custom middleware
Caching — Query caching, cache keys, and invalidation
Auto-Discovery — Convention-based handler resolution
Console Commands — Code generation commands
Configuration — Full config reference

How It Works

CommandBus (writes)          QueryBus (reads)
     │                            │
     ├─ Retry Middleware          ├─ Cache Middleware
     ├─ Performance Monitor       ├─ Performance Monitor
     │                            │
     └─► Handler                  └─► Handler

Commands and queries have separate middleware stacks. Commands get retry support, queries get caching — no overlap.

License

MIT

hassanelzarkawy / nactu

Maintainers

Package info

Statistics

Security