Create grid query builder

Skill jeffsenso/prestashop-skills/skills/prestashop-module-development/ps9-core-ai/Component/Grid/skills/create-grid-query-builder

Prestashop Developer Skills

Install

npx -y skills add jeffsenso/prestashop-skills --skill create-grid-query-builder

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

4 stars4 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Create 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}".

SKILL.md

3.3 KB, as published. Nobody here has run it

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 page
getCountQueryBuilder(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 _lang table 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 the RecordCollection
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.