feat(main): Groups and blocks

2026-08-10 16:13:15 +02:00
parent 6aff506cd6
commit 635c13a0ed
39 changed files with 1188 additions and 237 deletions
@@ -10,15 +10,18 @@ use PrestaShop\PrestaShop\Core\Grid\Column\ColumnCollection;
 use PrestaShop\PrestaShop\Core\Grid\Column\Type\Common\ActionColumn;
 use PrestaShop\PrestaShop\Core\Grid\Column\Type\DataColumn;
 use PrestaShop\PrestaShop\Core\Grid\Definition\Factory\AbstractGridDefinitionFactory;
+use PrestaShop\PrestaShop\Core\Grid\Definition\Factory\DeleteActionTrait;
 use PrestaShop\PrestaShop\Core\Grid\Filter\Filter;
 use PrestaShop\PrestaShop\Core\Grid\Filter\FilterCollection;
 use PrestaShop\PrestaShop\Core\Hook\HookDispatcherInterface;
 use PrestaShopBundle\Form\Admin\Type\SearchAndResetType;
 use Symfony\Component\Form\Extension\Core\Type\TextType;

-final class CustomHtmlGridDefinitionFactory extends AbstractGridDefinitionFactory
+final class CustomHtmlBlockGridDefinitionFactory extends AbstractGridDefinitionFactory
 {
-    const GRID_ID = 'customhtml';
+    use DeleteActionTrait;
+
+    const GRID_ID = 'customhtmlblock';

    public function __construct(HookDispatcherInterface $dispatcher)
    {
@@ -64,15 +67,20 @@ final class CustomHtmlGridDefinitionFactory extends AbstractGridDefinitionFactor
                ->setOptions(['field' => 'title'])
            )
            ->add(
-                (new DataColumn('hook_name'))
-                ->setName($this->trans('Hook', [], 'Modules.Wscustomhtml.Admin'))
-                ->setOptions(['field' => 'hook_name'])
+                (new DataColumn('group_title'))
+                ->setName($this->trans('Group', [], 'Modules.Wscustomhtml.Admin'))
+                ->setOptions(['field' => 'group_title'])
            )
            ->add(
                (new DataColumn('active'))
                ->setName($this->trans('Active', [], 'Admin.Global'))
                ->setOptions(['field' => 'active'])
            )
+            ->add(
+                (new DataColumn('ordering'))
+                ->setName($this->trans('Position', [], 'Modules.Wscustomhtml.Admin'))
+                ->setOptions(['field' => 'ordering'])
+            )
            ->add(
                (new DataColumn('date_add'))
                ->setName($this->trans('Date added', [], 'Admin.Global'))
@@ -105,11 +113,11 @@ final class CustomHtmlGridDefinitionFactory extends AbstractGridDefinitionFactor
                ])
            )
            ->add(
-                (new Filter('hook_name', TextType::class))
-                ->setAssociatedColumn('hook_name')
+                (new Filter('group_title', TextType::class))
+                ->setAssociatedColumn('group_title')
                ->setTypeOptions([
                    'required' => false,
-                    'attr'     => ['placeholder' => $this->trans('Hook', [], 'Modules.Wscustomhtml.Admin')],
+                    'attr'     => ['placeholder' => $this->trans('Group', [], 'Modules.Wscustomhtml.Admin')],
                ])
            )
            ->add(
@@ -118,7 +126,7 @@ final class CustomHtmlGridDefinitionFactory extends AbstractGridDefinitionFactor
                ->setTypeOptions([
                    'reset_route'        => 'admin_common_reset_search_by_filter_id',
                    'reset_route_params' => ['filterId' => self::GRID_ID],
-                    'redirect_route'     => 'customhtml_index',
+                    'redirect_route'     => 'customhtmlblock_index',
                ])
            );
    }
@@ -131,23 +139,15 @@ final class CustomHtmlGridDefinitionFactory extends AbstractGridDefinitionFactor
                ->setName($this->trans('Edit', [], 'Admin.Actions'))
                ->setIcon('edit')
                ->setOptions([
-                    'route'             => 'customhtml_edit',
-                    'route_param_name'  => 'idCustomHtml',
-                    'route_param_field' => 'id_ws_customhtml',
+                    'route'              => 'customhtmlblock_edit',
+                    'route_param_name'   => 'idCustomHtmlBlock',
+                    'route_param_field'  => 'id_ws_customhtml',
                    'use_inline_display' => true,
-                    'clickable_row'     => true,
+                    'clickable_row'      => true,
                ])
            )
            ->add(
-                (new LinkRowAction('delete'))
-                ->setName($this->trans('Delete', [], 'Admin.Actions'))
-                ->setIcon('delete')
-                ->setOptions([
-                    'route'             => 'customhtml_delete',
-                    'route_param_name'  => 'idCustomHtml',
-                    'route_param_field' => 'id_ws_customhtml',
-                    'use_inline_display' => true,
-                ])
+                $this->buildDeleteAction('customhtmlblock_delete', 'idCustomHtmlBlock', 'id_ws_customhtml')
            );
    }
 }
@@ -0,0 +1,173 @@
+<?php
+
+namespace Websmid\CustomHtml\Grid\Definition\Factory;
+
+use PrestaShop\PrestaShop\Core\Grid\Action\GridActionCollection;
+use PrestaShop\PrestaShop\Core\Grid\Action\Row\RowActionCollection;
+use PrestaShop\PrestaShop\Core\Grid\Action\Row\Type\LinkRowAction;
+use PrestaShop\PrestaShop\Core\Grid\Action\Type\SimpleGridAction;
+use PrestaShop\PrestaShop\Core\Grid\Column\ColumnCollection;
+use PrestaShop\PrestaShop\Core\Grid\Column\Type\Common\ActionColumn;
+use PrestaShop\PrestaShop\Core\Grid\Column\Type\DataColumn;
+use PrestaShop\PrestaShop\Core\Grid\Definition\Factory\AbstractGridDefinitionFactory;
+use PrestaShop\PrestaShop\Core\Grid\Definition\Factory\DeleteActionTrait;
+use PrestaShop\PrestaShop\Core\Grid\Filter\Filter;
+use PrestaShop\PrestaShop\Core\Grid\Filter\FilterCollection;
+use PrestaShop\PrestaShop\Core\Hook\HookDispatcherInterface;
+use PrestaShopBundle\Form\Admin\Type\SearchAndResetType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
+
+final class CustomHtmlGroupGridDefinitionFactory extends AbstractGridDefinitionFactory
+{
+    use DeleteActionTrait;
+
+    const GRID_ID = 'customhtmlgroup';
+
+    public function __construct(HookDispatcherInterface $dispatcher)
+    {
+        parent::__construct($dispatcher);
+    }
+
+    protected function getId(): string
+    {
+        return self::GRID_ID;
+    }
+
+    protected function getName(): string
+    {
+        return $this->trans('Custom HTML Groups', [], 'Modules.Wscustomhtml.Admin');
+    }
+
+    protected function getGridActions()
+    {
+        return (new GridActionCollection())
+            ->add(
+                (new SimpleGridAction('common_refresh_list'))
+                ->setName($this->trans('Refresh list', [], 'Admin.Catalog.Feature'))
+                ->setIcon('refresh')
+            )
+            ->add(
+                (new SimpleGridAction('common_show_query'))
+                ->setName($this->trans('Show SQL query', [], 'Admin.Catalog.Feature'))
+                ->setIcon('code')
+            );
+    }
+
+    protected function getColumns()
+    {
+        return (new ColumnCollection())
+            ->add(
+                (new DataColumn('id_ws_customhtml_group'))
+                ->setName($this->trans('ID', [], 'Admin.Global'))
+                ->setOptions(['field' => 'id_ws_customhtml_group'])
+            )
+            ->add(
+                (new DataColumn('title'))
+                ->setName($this->trans('Title', [], 'Modules.Wscustomhtml.Admin'))
+                ->setOptions(['field' => 'title'])
+            )
+            ->add(
+                (new DataColumn('hook_name'))
+                ->setName($this->trans('Hook', [], 'Modules.Wscustomhtml.Admin'))
+                ->setOptions(['field' => 'hook_name'])
+            )
+            ->add(
+                (new DataColumn('blocks_count'))
+                ->setName($this->trans('Blocks', [], 'Modules.Wscustomhtml.Admin'))
+                ->setOptions(['field' => 'blocks_count', 'sortable' => false])
+            )
+            ->add(
+                (new DataColumn('active'))
+                ->setName($this->trans('Active', [], 'Admin.Global'))
+                ->setOptions(['field' => 'active'])
+            )
+            ->add(
+                (new DataColumn('date_add'))
+                ->setName($this->trans('Date added', [], 'Admin.Global'))
+                ->setOptions(['field' => 'date_add'])
+            )
+            ->add(
+                (new ActionColumn('actions'))
+                ->setName($this->trans('Actions', [], 'Admin.Global'))
+                ->setOptions(['actions' => $this->buildRowActions()])
+            );
+    }
+
+    protected function getFilters()
+    {
+        return (new FilterCollection())
+            ->add(
+                (new Filter('id_ws_customhtml_group', TextType::class))
+                ->setAssociatedColumn('id_ws_customhtml_group')
+                ->setTypeOptions([
+                    'required' => false,
+                    'attr'     => ['placeholder' => $this->trans('ID', [], 'Admin.Global')],
+                ])
+            )
+            ->add(
+                (new Filter('title', TextType::class))
+                ->setAssociatedColumn('title')
+                ->setTypeOptions([
+                    'required' => false,
+                    'attr'     => ['placeholder' => $this->trans('Title', [], 'Modules.Wscustomhtml.Admin')],
+                ])
+            )
+            ->add(
+                (new Filter('hook_name', TextType::class))
+                ->setAssociatedColumn('hook_name')
+                ->setTypeOptions([
+                    'required' => false,
+                    'attr'     => ['placeholder' => $this->trans('Hook', [], 'Modules.Wscustomhtml.Admin')],
+                ])
+            )
+            ->add(
+                (new Filter('actions', SearchAndResetType::class))
+                ->setAssociatedColumn('actions')
+                ->setTypeOptions([
+                    'reset_route'        => 'admin_common_reset_search_by_filter_id',
+                    'reset_route_params' => ['filterId' => self::GRID_ID],
+                    'redirect_route'     => 'customhtmlgroup_index',
+                ])
+            );
+    }
+
+    private function buildRowActions(): RowActionCollection
+    {
+        return (new RowActionCollection())
+            ->add(
+                (new LinkRowAction('view_blocks'))
+                ->setName($this->trans('View blocks', [], 'Modules.Wscustomhtml.Admin'))
+                ->setIcon('visibility')
+                ->setOptions([
+                    'route'             => 'customhtmlblock_index',
+                    'route_param_name'  => 'idGroup',
+                    'route_param_field' => 'id_ws_customhtml_group',
+                ])
+            )
+            ->add(
+                (new LinkRowAction('add_block'))
+                ->setName($this->trans('Add block', [], 'Modules.Wscustomhtml.Admin'))
+                ->setIcon('note_add')
+                ->setOptions([
+                    'route'             => 'customhtmlblock_create',
+                    'route_param_name'  => 'idGroup',
+                    'route_param_field' => 'id_ws_customhtml_group',
+                ])
+            )
+            ->add(
+                (new LinkRowAction('edit'))
+                ->setName($this->trans('Edit', [], 'Admin.Actions'))
+                ->setIcon('edit')
+                ->setOptions([
+                    'route'              => 'customhtmlgroup_edit',
+                    'route_param_name'   => 'idCustomHtmlGroup',
+                    'route_param_field'  => 'id_ws_customhtml_group',
+                    'use_inline_display' => true,
+                    'clickable_row'      => true,
+                ])
+            )
+            ->add(
+                $this->buildDeleteAction('customhtmlgroup_delete', 'idCustomHtmlGroup', 'id_ws_customhtml_group')
+            );
+    }
+}
@@ -3,18 +3,18 @@
 namespace Websmid\CustomHtml\Grid\Filters;

 use PrestaShop\PrestaShop\Core\Search\Filters;
-use Websmid\CustomHtml\Grid\Definition\Factory\CustomHtmlGridDefinitionFactory;
+use Websmid\CustomHtml\Grid\Definition\Factory\CustomHtmlBlockGridDefinitionFactory;

-final class CustomHtmlFilters extends Filters
+final class CustomHtmlBlockFilters extends Filters
 {
-    protected $filterId = CustomHtmlGridDefinitionFactory::GRID_ID;
+    protected $filterId = CustomHtmlBlockGridDefinitionFactory::GRID_ID;

    public static function getDefaults(): array
    {
        return [
            'limit'     => 10,
            'offset'    => 0,
-            'orderBy'   => 'wch.id_ws_customhtml',
+            'orderBy'   => 'wchb.id_ws_customhtml',
            'sortOrder' => 'asc',
            'filters'   => [],
        ];
@@ -0,0 +1,22 @@
+<?php
+
+namespace Websmid\CustomHtml\Grid\Filters;
+
+use PrestaShop\PrestaShop\Core\Search\Filters;
+use Websmid\CustomHtml\Grid\Definition\Factory\CustomHtmlGroupGridDefinitionFactory;
+
+final class CustomHtmlGroupFilters extends Filters
+{
+    protected $filterId = CustomHtmlGroupGridDefinitionFactory::GRID_ID;
+
+    public static function getDefaults(): array
+    {
+        return [
+            'limit'     => 10,
+            'offset'    => 0,
+            'orderBy'   => 'wchg.id_ws_customhtml_group',
+            'sortOrder' => 'asc',
+            'filters'   => [],
+        ];
+    }
+}
@@ -0,0 +1,115 @@
+<?php
+
+namespace Websmid\CustomHtml\Grid\Query;
+
+use Doctrine\DBAL\Connection;
+use PrestaShop\PrestaShop\Adapter\Configuration;
+use PrestaShop\PrestaShop\Core\Grid\Query\AbstractDoctrineQueryBuilder;
+use PrestaShop\PrestaShop\Core\Grid\Query\DoctrineSearchCriteriaApplicatorInterface;
+use PrestaShop\PrestaShop\Core\Grid\Query\Filter\DoctrineFilterApplicatorInterface;
+use PrestaShop\PrestaShop\Core\Grid\Search\SearchCriteriaInterface;
+
+final class CustomHtmlBlockQueryBuilder extends AbstractDoctrineQueryBuilder
+{
+    private $searchCriteriaApplicator;
+    private $contextLanguageId;
+    private $contextShopId;
+    private $contextShopGroupId;
+    private $filterApplicator;
+    private $configuration;
+
+    public function __construct(
+        Connection $connection,
+        string $dbPrefix,
+        DoctrineSearchCriteriaApplicatorInterface $searchCriteriaApplicator,
+        int $contextLanguageId,
+        int $contextShopId,
+        int $contextShopGroupId,
+        DoctrineFilterApplicatorInterface $filterApplicator,
+        Configuration $configuration
+    ) {
+        parent::__construct($connection, $dbPrefix);
+        $this->searchCriteriaApplicator = $searchCriteriaApplicator;
+        $this->contextLanguageId = $contextLanguageId;
+        $this->contextShopId = $contextShopId;
+        $this->contextShopGroupId = $contextShopGroupId;
+        $this->filterApplicator = $filterApplicator;
+        $this->configuration = $configuration;
+    }
+
+    public function getSearchQueryBuilder(SearchCriteriaInterface $searchCriteria)
+    {
+        $qb = $this->getBaseQuery();
+
+        $qb->select(
+            'wchb.`id_ws_customhtml`',
+            'wchb.`title`',
+            'wchg.`title` AS group_title',
+            'wchb.`active`',
+            'wchb.`ordering`',
+            'wchb.`date_add`'
+        );
+
+        $this->applyFilters($qb, $searchCriteria);
+
+        $qb
+            ->orderBy($searchCriteria->getOrderBy(), $searchCriteria->getOrderWay())
+            ->setFirstResult($searchCriteria->getOffset() ?? 0)
+            ->setMaxResults($searchCriteria->getLimit());
+
+        return $qb;
+    }
+
+    public function getCountQueryBuilder(SearchCriteriaInterface $searchCriteria)
+    {
+        $qb = $this->getBaseQuery();
+        $qb->select('COUNT(wchb.`id_ws_customhtml`)');
+
+        $this->applyFilters($qb, $searchCriteria);
+
+        return $qb;
+    }
+
+    private function getBaseQuery()
+    {
+        return $this->connection
+            ->createQueryBuilder()
+            ->from($this->dbPrefix . 'ws_customhtml', 'wchb')
+            ->leftJoin(
+                'wchb',
+                $this->dbPrefix . 'ws_customhtml_group',
+                'wchg',
+                'wchg.`id_ws_customhtml_group` = wchb.`id_ws_customhtml_group`'
+            );
+    }
+
+    private function applyFilters($qb, SearchCriteriaInterface $searchCriteria): void
+    {
+        foreach ($searchCriteria->getFilters() as $filterName => $filterValue) {
+            if ($filterName === 'actions') {
+                continue;
+            }
+
+            if ($filterName === 'id_ws_customhtml') {
+                $qb->andWhere('wchb.`id_ws_customhtml` = :id_ws_customhtml')
+                   ->setParameter('id_ws_customhtml', (int) $filterValue);
+                continue;
+            }
+
+            if ($filterName === 'id_ws_customhtml_group') {
+                $qb->andWhere('wchb.`id_ws_customhtml_group` = :id_ws_customhtml_group')
+                   ->setParameter('id_ws_customhtml_group', (int) $filterValue);
+                continue;
+            }
+
+            if ($filterName === 'group_title') {
+                $qb->andWhere('wchg.`title` LIKE :group_title')
+                   ->setParameter('group_title', '%' . pSQL($filterValue) . '%');
+                continue;
+            }
+
+            $qb->andWhere('wchb.`' . $filterName . '` LIKE :' . $filterName)
+               ->setParameter($filterName, '%' . pSQL($filterValue) . '%');
+        }
+    }
+}
@@ -9,7 +9,7 @@ use PrestaShop\PrestaShop\Core\Grid\Query\DoctrineSearchCriteriaApplicatorInterf
 use PrestaShop\PrestaShop\Core\Grid\Query\Filter\DoctrineFilterApplicatorInterface;
 use PrestaShop\PrestaShop\Core\Grid\Search\SearchCriteriaInterface;

-final class CustomHtmlQueryBuilder extends AbstractDoctrineQueryBuilder
+final class CustomHtmlGroupQueryBuilder extends AbstractDoctrineQueryBuilder
 {
    private $searchCriteriaApplicator;
    private $contextLanguageId;
@@ -42,11 +42,13 @@ final class CustomHtmlQueryBuilder extends AbstractDoctrineQueryBuilder
        $qb = $this->getBaseQuery();

        $qb->select(
-            'wch.`id_ws_customhtml`',
-            'wch.`title`',
-            'wch.`hook_name`',
-            'wch.`active`',
-            'wch.`date_add`'
+            'wchg.`id_ws_customhtml_group`',
+            'wchg.`title`',
+            'wchg.`hook_name`',
+            'wchg.`active`',
+            'wchg.`date_add`',
+            '(SELECT COUNT(*) FROM `' . $this->dbPrefix . 'ws_customhtml` wch
+                WHERE wch.`id_ws_customhtml_group` = wchg.`id_ws_customhtml_group`) AS blocks_count'
        );

        $this->applyFilters($qb, $searchCriteria);
@@ -62,7 +64,7 @@ final class CustomHtmlQueryBuilder extends AbstractDoctrineQueryBuilder
    public function getCountQueryBuilder(SearchCriteriaInterface $searchCriteria)
    {
        $qb = $this->getBaseQuery();
-        $qb->select('COUNT(wch.`id_ws_customhtml`)');
+        $qb->select('COUNT(wchg.`id_ws_customhtml_group`)');

        $this->applyFilters($qb, $searchCriteria);

@@ -73,7 +75,7 @@ final class CustomHtmlQueryBuilder extends AbstractDoctrineQueryBuilder
    {
        return $this->connection
            ->createQueryBuilder()
-            ->from($this->dbPrefix . 'ws_customhtml', 'wch');
+            ->from($this->dbPrefix . 'ws_customhtml_group', 'wchg');
    }

    private function applyFilters($qb, SearchCriteriaInterface $searchCriteria): void
@@ -83,13 +85,13 @@ final class CustomHtmlQueryBuilder extends AbstractDoctrineQueryBuilder
                continue;
            }

-            if ($filterName === 'id_ws_customhtml') {
-                $qb->andWhere('wch.`id_ws_customhtml` = :id_ws_customhtml')
-                   ->setParameter('id_ws_customhtml', (int) $filterValue);
+            if ($filterName === 'id_ws_customhtml_group') {
+                $qb->andWhere('wchg.`id_ws_customhtml_group` = :id_ws_customhtml_group')
+                   ->setParameter('id_ws_customhtml_group', (int) $filterValue);
                continue;
            }

-            $qb->andWhere('wch.`' . $filterName . '` LIKE :' . $filterName)
+            $qb->andWhere('wchg.`' . $filterName . '` LIKE :' . $filterName)
               ->setParameter($filterName, '%' . pSQL($filterValue) . '%');
        }
    }