Create Query

Query Generator

Generate CQRS-compliant Queries and Query Handlers with tests.

Query Characteristics

• Immutable: final readonly class
• Interrogative naming: Get/Find/List + noun
• No side effects: Handler never modifies state
• Returns DTOs: Never returns domain entities
• Read-optimized: Can use dedicated read models

Generation Process

Step 1: Generate Query

Path: src/Application/{BoundedContext}/Query/

1. {Name}Query.php — Immutable query DTO with parameters

Step 2: Generate Handler

Path: src/Application/{BoundedContext}/Handler/

1. {Name}Handler.php — Read model consumer

Step 3: Generate DTOs

Path: src/Application/{BoundedContext}/DTO/

1. {Name}DTO.php — Result data structure
2. PaginatedResultDTO.php — For list queries (optional)

Step 4: Generate Read Model Interface

Path: src/Application/{BoundedContext}/ReadModel/

1. {Name}ReadModelInterface.php — Query methods contract

Step 5: Generate Tests

Path: tests/Unit/Application/{BoundedContext}/

File Placement

Query Naming Conventions

Quick Template Reference

Query

final readonly class {Name}Query
{
    public function __construct(
        public {IdType} $id
    ) {}
}

Query with Pagination

final readonly class List{Name}Query
{
    public function __construct(
        public ?{FilterType} $filter = null,
        public int $limit = 20,
        public int $offset = 0,
        public string $sortBy = 'created_at',
        public string $sortDirection = 'desc'
    ) {
        if ($limit < 1 || $limit > 100) {
            throw new \InvalidArgumentException('Limit must be between 1 and 100');
        }
    }
}

Handler

final readonly class {Name}Handler
{
    public function __construct(
        private {ReadModelInterface} $readModel
    ) {}

    public function __invoke({Name}Query $query): {ResultDTO}
    {
        $result = $this->readModel->findById($query->id->value);

        if ($result === null) {
            throw new {NotFoundException}($query->id);
        }

        return $result;
    }
}

Anti-patterns to Avoid

References

For complete PHP templates and examples, see:

• references/templates.md — Query, Handler, DTO, PaginatedResult, ReadModel templates
• references/examples.md — GetOrderDetails, ListOrders, OrderDTO examples and tests

Converted and distributed by TomeVault — claim your Tome and manage your conversions.