create-grid-definition

create-grid-definition

Read @.ai/Component/Grid/CONTEXT.md for the factory trilogy (GridDefinitionFactory → GridDataFactory → GridFactory) and SearchCriteria patterns.

1. Grid Definition Factory

Create src/Core/Grid/Definition/Factory/{Domain}GridDefinitionFactory.php extending AbstractGridDefinitionFactory:

• Define a public const GRID_ID = '{domain}' constant — this is the single source of truth for the grid identifier, shared with the {Domain}Filters class to ensure the filter persistence in DB maps to the correct grid
• getId(): string — return self::GRID_ID
• getName(): string — translatable grid name
• getColumns(): ColumnCollection — all columns (see section 2)
• getFilters(): FilterCollection — filterable columns (see section 4)
• getGridActions(): GridActionCollection — grid-level actions (e.g. export)
• getRowActions(): RowActionCollection — per-row actions (see section 3)
• getBulkActions(): BulkActionCollection — multi-select actions (see section 3)

Reference: src/Core/Grid/Definition/Factory/TaxGridDefinitionFactory.php (simple), src/Core/Grid/Definition/Factory/ManufacturerGridDefinitionFactory.php (two grids)

2. Column types

Column type	When to use	Notes
BulkActionColumn	Row selection checkbox	Always first column
DataColumn	Plain text (name, email, date)	Most common
ToggleColumn	Clickable boolean toggle (active status)	Requires AJAX toggle route
ImageColumn	Image thumbnail (logo)
LinkColumn	Text with hyperlink
PositionColumn	Drag handle for reordering	See create-position-column skill
ActionColumn	Row actions dropdown	Always last column

See Grid/CONTEXT.md for column ordering and naming conventions.

3. Row actions and bulk actions

Row actions

Add in getRowActions():

• LinkRowAction for edit — links to admin_{domain}s_edit route with {id} parameter
• For delete, use the DeleteActionTrait::buildDeleteAction() helper — it returns a SubmitRowAction pre-wired with the standard delete confirmation modal (translatable title, confirm/cancel buttons, danger styling). Prefer it over building the action manually:

  use PrestaShop\PrestaShop\Core\Grid\Definition\Factory\DeleteActionTrait;
  
  class {Domain}GridDefinitionFactory extends AbstractGridDefinitionFactory
  {
      use DeleteActionTrait;
  
      protected function getRowActions(): RowActionCollection
      {
          return (new RowActionCollection())
              ->add(/* edit LinkRowAction */)
              ->add($this->buildDeleteAction(
                  'admin_{domain}s_delete',  // route
                  '{domain}Id',              // route param name
                  '{domain}Id',              // row field providing the value
              ));
      }
  }
  

• Order: edit first, delete last