Create Cqrs Queries
Developmentcreate-cqrs-queriesCreate Cqrs Queries is an Agent Skill for development published in the PrestaShop/PrestaShop repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Create the read-side CQRS layer: queries, result DTOs, and query handler interfaces. Covers Get{Domain}ForEditing (single entity for edit form) and optionally Get{Domain}sForListing (grid data source). Trigger: "create queries for {Domain}", "set up read side for {Domain}".
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/PrestaShop/PrestaShop/blob/HEAD/.ai/Component/CQRS/skills/create-cqrs-queries/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/create-cqrs-queries, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
create-cqrs-queries
Read CQRS/CONTEXT.md for conventions (scalar inputs/VO getters, QueryResult scalar-only rule).
1. Get-for-editing query
Create src/Core/Domain/{Domain}/Query/Get{Domain}ForEditing.php:
- Constructor takes
int $id(scalar) - Getter returns VO:
getId(): {Domain}Id - Queries are read-only data objects — no side effects
2. Result DTO
Create src/Core/Domain/{Domain}/QueryResult/Editable{Domain}.php:
- Constructor parameters: all fields the edit form needs to pre-fill (scalar types only — see CONTEXT.md)
- Public getter for every field
- Immutable: no setters, all values set at construction
Reference: src/Core/Domain/Tax/QueryResult/EditableTax.php (simple), src/Core/Domain/Manufacturer/QueryResult/EditableManufacturer.php (with associations)
3. List query (assess first)
Most PS grids use SearchCriteria + grid QueryBuilder directly — no explicit CQRS query class needed.
Check the domain convention before creating a list query:
- If the domain uses
SearchCriteria+QueryBuilderin the grid: skip this step - If the domain uses an explicit query: create
Get{Domain}sForListing.phpwithSearchCriteriaparameter
Reference: Most domains (Tax, Manufacturer, Category) use the grid QueryBuilder pattern without an explicit list query.
4. Query handler interfaces
Create in src/Core/Domain/{Domain}/QueryHandler/:
Get{Domain}ForEditingHandlerInterfacewithhandle(Get{Domain}ForEditing $query): Editable{Domain}- If list query exists, create corresponding interface
- Query handlers always return data (typed DTO or array) — never void
Rules
Conventions (scalar-only DTOs, read-only queries) are in CQRS/CONTEXT.md. Skill-specific reminders:
- Map ALL editable fields in the DTO — missing fields cause empty form fields on edit
- Return typed DTOs, not ObjectModel instances