jeffsenso/prestashop-skills / skills/prestashop-module-development/ps9-core-ai/Component/Grid/skills/create-grid-query-builder
create-grid-query-builder
VerifiedCreate the Doctrine DBAL QueryBuilder that fetches grid rows, and optionally a GridDataFactory decorator for post-processing. The column aliases must exactly match the column IDs in the Grid Definition. Trigger: "create grid query builder for {Domain}".
create-grid-query-builder
Read @.ai/Component/Grid/CONTEXT.md for the factory trilogy and GridDataFactory decoration pattern.
1. Query Builder
Create src/Adapter/{Domain}/Grid/Query/{Domain}QueryBuilder.php implementing DoctrineQueryBuilderInterface or extending AbstractDoctrineQueryBuilder:
Two required methods:
getSearchQueryBuilder(SearchCriteriaInterface $searchCriteria): QueryBuilder— returns rows for the current pagegetCountQueryBuilder(SearchCriteriaInterface $searchCriteria): QueryBuilder— returns total count (no LIMIT/OFFSET)
Building the query
- Base query:
SELECT c.id_{domain}, c.name, c.active FROM ps_{domain} c - For each filter in
$searchCriteria->getFilters(), add a WHERE clause with parameterized values - Apply sorting: map
$searchCriteria->getOrderBy()to actual column expressions - Apply pagination:
->setFirstResult($offset)->setMaxResults($limit)(search query only, not count) - For multilingual columns: LEFT JOIN the
_langtable with the current language ID
Reference: src/Core/Grid/Query/LanguageQueryBuilder.php (simple), src/Adapter/Manufacturer/QueryBuilder/ManufacturerQueryBuilder.php (with joins)
2. GridDataFactory (standard)
For most grids, the standard DoctrineGridDataFactory is sufficient — it calls the query builder automatically. Just wire it in DI:
prestashop.core.grid.data.factory.{domain}:
class: 'PrestaShop\PrestaShop\Core\Grid\Data\Factory\DoctrineGridDataFactory'
arguments:
- '@prestashop.core.admin.{domain}.query_builder'
# ... hook dispatcher, query parser, etc.
3. GridDataFactory decorator (if post-processing needed)
When grid data needs transformation after query execution (e.g. resolving image URLs from IDs, formatting computed columns), create a decorator:
- Create a class implementing
GridDataFactoryInterface - Inject the original
GridDataFactory - In
getData(SearchCriteriaInterface $searchCriteria): call the wrapped factory, then modify theRecordCollection - Register with
decorates:in DI YAML
class {Domain}GridDataFactory implements GridDataFactoryInterface
{
public function __construct(
private readonly GridDataFactoryInterface $dataFactory,
) {}
public function getData(SearchCriteriaInterface $searchCriteria): GridData
{
$gridData = $this->dataFactory->getData($searchCriteria);
$modifiedRecords = $this->applyModifications($gridData->getRecords());
return new GridData($modifiedRecords, $gridData->getRecordsTotal(), $gridData->getQuery());
}
}
Reference: Check existing *GridDataFactory decorators in src/Adapter/ for examples.
Rules
Conventions (column alias matching, parameterized queries, PK aliasing, count query rules, decoration preference) are in Grid/CONTEXT.md.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |