isabelle/ws_customhtml
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(main): Groups and blocks

Browse Source
This commit is contained in:
isabelle
2026-08-10 16:13:15 +02:00
parent 6aff506cd6
commit 635c13a0ed
39 changed files with 1188 additions and 237 deletions
Download Patch File Download Diff File Expand all files Collapse all files
config/form.yml
+47 -11
View File
@@ -1,34 +1,70 @@
services:
websmid.customhtml.form.type.customhtml:
websmid.customhtml.form.type.customhtml_group:
public: true
class: 'Websmid\CustomHtml\Form\Type\CustomHtmlType'
class: 'Websmid\CustomHtml\Form\Type\CustomHtmlGroupType'
parent: 'form.type.translatable.aware'
tags:
- { name: form.type }
websmid.customhtml.form.customhtml_data_provider:
websmid.customhtml.form.customhtmlgroup_data_provider:
public: true
class: 'Websmid\CustomHtml\Form\DataProvider\CustomHtmlDataProvider'
class: 'Websmid\CustomHtml\Form\DataProvider\CustomHtmlGroupDataProvider'
websmid.customhtml.form.customhtml_data_form_builder:
websmid.customhtml.form.customhtmlgroup_data_form_builder:
public: true
class: 'PrestaShop\PrestaShop\Core\Form\IdentifiableObject\Builder\FormBuilder'
factory:
- '@prestashop.core.form.builder.form_builder_factory'
- 'create'
arguments:
- 'Websmid\CustomHtml\Form\Type\CustomHtmlType'
- '@websmid.customhtml.form.customhtml_data_provider'
- 'Websmid\CustomHtml\Form\Type\CustomHtmlGroupType'
- '@websmid.customhtml.form.customhtmlgroup_data_provider'
websmid.customhtml.form.customhtml_data_handler:
websmid.customhtml.form.customhtmlgroup_data_handler:
public: true
class: 'Websmid\CustomHtml\Form\DataHandler\CustomHtmlDataHandler'
class: 'Websmid\CustomHtml\Form\DataHandler\CustomHtmlGroupDataHandler'
websmid.customhtml.form.customhtml_form_handler:
websmid.customhtml.form.customhtmlgroup_form_handler:
public: true
class: 'PrestaShop\PrestaShop\Core\Form\IdentifiableObject\Handler\FormHandler'
factory:
- '@prestashop.core.form.identifiable_object.handler.form_handler_factory'
- 'create'
arguments:
- '@websmid.customhtml.form.customhtml_data_handler'
- '@websmid.customhtml.form.customhtmlgroup_data_handler'
websmid.customhtml.form.type.customhtml_block:
public: true
class: 'Websmid\CustomHtml\Form\Type\CustomHtmlBlockType'
parent: 'form.type.translatable.aware'
arguments:
- '@websmid.customhtml.form.choice_provider.customhtml_group_choice_provider'
tags:
- { name: form.type }
websmid.customhtml.form.customhtmlblock_data_provider:
public: true
class: 'Websmid\CustomHtml\Form\DataProvider\CustomHtmlBlockDataProvider'
websmid.customhtml.form.customhtmlblock_data_form_builder:
public: true
class: 'PrestaShop\PrestaShop\Core\Form\IdentifiableObject\Builder\FormBuilder'
factory:
- '@prestashop.core.form.builder.form_builder_factory'
- 'create'
arguments:
- 'Websmid\CustomHtml\Form\Type\CustomHtmlBlockType'
- '@websmid.customhtml.form.customhtmlblock_data_provider'
websmid.customhtml.form.customhtmlblock_data_handler:
public: true
class: 'Websmid\CustomHtml\Form\DataHandler\CustomHtmlBlockDataHandler'
websmid.customhtml.form.customhtmlblock_form_handler:
public: true
class: 'PrestaShop\PrestaShop\Core\Form\IdentifiableObject\Handler\FormHandler'
factory:
- '@prestashop.core.form.identifiable_object.handler.form_handler_factory'
- 'create'
arguments:
- '@websmid.customhtml.form.customhtmlblock_data_handler'
config/grid.yml
+45 -10
View File
@@ -1,12 +1,12 @@
services:
websmid.customhtml.grid.definition.factory.customhtml_definition_factory:
websmid.customhtml.grid.definition.factory.customhtmlgroup_definition_factory:
public: true
class: 'Websmid\CustomHtml\Grid\Definition\Factory\CustomHtmlGridDefinitionFactory'
class: 'Websmid\CustomHtml\Grid\Definition\Factory\CustomHtmlGroupGridDefinitionFactory'
parent: 'prestashop.core.grid.definition.factory.abstract_grid_definition'
websmid.customhtml.grid.query.customhtml_query_builder:
websmid.customhtml.grid.query.customhtmlgroup_query_builder:
public: true
class: 'Websmid\CustomHtml\Grid\Query\CustomHtmlQueryBuilder'
class: 'Websmid\CustomHtml\Grid\Query\CustomHtmlGroupQueryBuilder'
parent: 'prestashop.core.grid.abstract_query_builder'
arguments:
- '@prestashop.core.query.doctrine_search_criteria_applicator'
@@ -16,20 +16,55 @@ services:
- '@prestashop.core.grid.query.filter.doctrine_filter_applicator'
- '@prestashop.adapter.legacy.configuration'
websmid.customhtml.grid.data.factory.customhtml_data_factory:
websmid.customhtml.grid.data.factory.customhtmlgroup_data_factory:
public: true
class: '%prestashop.core.grid.data.factory.doctrine_grid_data_factory%'
arguments:
- '@websmid.customhtml.grid.query.customhtml_query_builder'
- '@websmid.customhtml.grid.query.customhtmlgroup_query_builder'
- '@prestashop.core.hook.dispatcher'
- '@prestashop.core.grid.query.doctrine_query_parser'
- 'customhtml'
- 'customhtmlgroup'
websmid.customhtml.grid.customhtml_grid_factory:
websmid.customhtml.grid.customhtmlgroup_grid_factory:
public: true
class: 'PrestaShop\PrestaShop\Core\Grid\GridFactory'
arguments:
- '@websmid.customhtml.grid.definition.factory.customhtml_definition_factory'
- '@websmid.customhtml.grid.data.factory.customhtml_data_factory'
- '@websmid.customhtml.grid.definition.factory.customhtmlgroup_definition_factory'
- '@websmid.customhtml.grid.data.factory.customhtmlgroup_data_factory'
- '@prestashop.core.grid.filter.form_factory'
- '@prestashop.core.hook.dispatcher'
websmid.customhtml.grid.definition.factory.customhtmlblock_definition_factory:
public: true
class: 'Websmid\CustomHtml\Grid\Definition\Factory\CustomHtmlBlockGridDefinitionFactory'
parent: 'prestashop.core.grid.definition.factory.abstract_grid_definition'
websmid.customhtml.grid.query.customhtmlblock_query_builder:
public: true
class: 'Websmid\CustomHtml\Grid\Query\CustomHtmlBlockQueryBuilder'
parent: 'prestashop.core.grid.abstract_query_builder'
arguments:
- '@prestashop.core.query.doctrine_search_criteria_applicator'
- "@=service('prestashop.adapter.legacy.context').getContext().language.id"
- "@=service('prestashop.adapter.legacy.context').getContext().shop.id"
- "@=service('prestashop.adapter.legacy.context').getContext().shop.id_shop_group"
- '@prestashop.core.grid.query.filter.doctrine_filter_applicator'
- '@prestashop.adapter.legacy.configuration'
websmid.customhtml.grid.data.factory.customhtmlblock_data_factory:
public: true
class: '%prestashop.core.grid.data.factory.doctrine_grid_data_factory%'
arguments:
- '@websmid.customhtml.grid.query.customhtmlblock_query_builder'
- '@prestashop.core.hook.dispatcher'
- '@prestashop.core.grid.query.doctrine_query_parser'
- 'customhtmlblock'
websmid.customhtml.grid.customhtmlblock_grid_factory:
public: true
class: 'PrestaShop\PrestaShop\Core\Grid\GridFactory'
arguments:
- '@websmid.customhtml.grid.definition.factory.customhtmlblock_definition_factory'
- '@websmid.customhtml.grid.data.factory.customhtmlblock_data_factory'
- '@prestashop.core.grid.filter.form_factory'
- '@prestashop.core.hook.dispatcher'
config/provider.yml
+4
View File
@@ -0,0 +1,4 @@
services:
websmid.customhtml.form.choice_provider.customhtml_group_choice_provider:
public: true
class: 'Websmid\CustomHtml\Form\ChoiceProvider\CustomHtmlGroupChoiceProvider'
config/routes.yml
+54 -13
View File
@@ -2,31 +2,72 @@ customhtml_index:
path: ws_customhtml
methods: [GET]
defaults:
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlController::indexAction'
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlGroupController::indexAction'
_legacy_controller: AdminCustomHtmlParent
_legacy_link: AdminCustomHtmlParent:index
customhtmlgroup_index:
path: ws_customhtml/group
methods: [GET]
defaults:
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlGroupController::indexAction'
_legacy_controller: AdminCustomHtmlOverview
_legacy_link: AdminCustomHtmlOverview:index
customhtml_search:
path: ws_customhtml
customhtmlgroup_search:
path: ws_customhtml/group
methods: [POST]
defaults:
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlController::searchAction'
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlGroupController::searchAction'
_legacy_controller: AdminCustomHtmlOverview
customhtml_create:
path: ws_customhtml/create
customhtmlgroup_create:
path: ws_customhtml/group/create
methods: [POST, GET]
defaults:
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlController::createAction'
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlGroupController::createAction'
customhtml_edit:
path: ws_customhtml/edit/{idCustomHtml}
customhtmlgroup_edit:
path: ws_customhtml/group/edit/{idCustomHtmlGroup}
methods: [POST, GET]
defaults:
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlController::editAction'
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlGroupController::editAction'
customhtml_delete:
path: ws_customhtml/delete/{idCustomHtml}
customhtmlgroup_delete:
path: ws_customhtml/group/delete/{idCustomHtmlGroup}
methods: [DELETE, GET, POST]
defaults:
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlController::deleteAction'
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlGroupController::deleteAction'
customhtmlblock_index:
path: ws_customhtml/block
methods: [GET]
defaults:
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlBlockController::indexAction'
_legacy_controller: AdminCustomHtmlBlockOverview
_legacy_link: AdminCustomHtmlBlockOverview:index
customhtmlblock_search:
path: ws_customhtml/block
methods: [POST]
defaults:
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlBlockController::searchAction'
_legacy_controller: AdminCustomHtmlBlockOverview
customhtmlblock_create:
path: ws_customhtml/block/create
methods: [POST, GET]
defaults:
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlBlockController::createAction'
customhtmlblock_edit:
path: ws_customhtml/block/edit/{idCustomHtmlBlock}
methods: [POST, GET]
defaults:
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlBlockController::editAction'
customhtmlblock_delete:
path: ws_customhtml/block/delete/{idCustomHtmlBlock}
methods: [DELETE, GET, POST]
defaults:
_controller: 'Websmid\CustomHtml\Controller\CustomHtmlBlockController::deleteAction'
config/services.yml
+1
View File
@@ -1,3 +1,4 @@
imports:
- { resource: form.yml }
- { resource: grid.yml }
- { resource: provider.yml }
src/Config/Config.php
+36 -2
View File
@@ -4,11 +4,21 @@ namespace Websmid\CustomHtml\Config;
class Config
{
const HOOKS = [];
const HOOKS = [
'actionAdminControllerSetMedia',
];
const ADMIN_CONTROLLERS = [
'AdminCustomHtmlParent',
'AdminCustomHtmlOverview',
'AdminCustomHtmlBlockOverview',
];
// Order matters: the parent tab must be registered before its children so
// Tab::getIdFromClassName('AdminCustomHtmlParent') resolves during install.
const TABS = [
[
'class_name' => 'AdminCustomHtmlOverview',
'class_name' => 'AdminCustomHtmlParent',
'parent_class_name' => 'AdminParentThemes',
'name' => [
'en' => 'Custom HTML',
@@ -19,5 +29,29 @@ class Config
'route_name' => 'customhtml_index',
'active' => 1,
],
[
'class_name' => 'AdminCustomHtmlOverview',
'parent_class_name' => 'AdminCustomHtmlParent',
'name' => [
'en' => 'Groups',
'nl' => 'Groepen',
],
'module' => 'ws_customhtml',
'icon' => 'code',
'route_name' => 'customhtmlgroup_index',
'active' => 1,
],
[
'class_name' => 'AdminCustomHtmlBlockOverview',
'parent_class_name' => 'AdminCustomHtmlParent',
'name' => [
'en' => 'Blocks',
'nl' => 'Blokken',
],
'module' => 'ws_customhtml',
'icon' => 'view_module',
'route_name' => 'customhtmlblock_index',
'active' => 1,
],
];
}
src/Controller/CustomHtmlBlockController.php
+134
View File
@@ -0,0 +1,134 @@
<?php
namespace Websmid\CustomHtml\Controller;
use Exception;
use PrestaShopBundle\Controller\Admin\FrameworkBundleAdminController;
use PrestaShopBundle\Security\Voter\PageVoter;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Websmid\CustomHtml\Grid\Definition\Factory\CustomHtmlBlockGridDefinitionFactory;
use Websmid\CustomHtml\Grid\Filters\CustomHtmlBlockFilters;
use Websmid\CustomHtml\Model\CustomHtmlBlock;
use Validate;
class CustomHtmlBlockController extends FrameworkBundleAdminController
{
public function indexAction(Request $request, CustomHtmlBlockFilters $filters): Response
{
if ($request->query->has('idGroup')) {
$filters->addFilter(['id_ws_customhtml_group' => (int) $request->query->get('idGroup')]);
$filters->setNeedsToBePersisted(false);
}
$gridFactory = $this->get('websmid.customhtml.grid.customhtmlblock_grid_factory');
$grid = $gridFactory->getGrid($filters);
return $this->render('@Modules/ws_customhtml/views/templates/admin/grid/customhtmlblock.html.twig', [
'customHtmlBlockGrid' => $this->presentGrid($grid),
'layoutHeaderToolbarBtn' => $this->getToolbarButtons($request->get('_legacy_controller')),
]);
}
public function searchAction(Request $request): RedirectResponse
{
return $this->get('prestashop.bundle.grid.response_builder')->buildSearchResponse(
$this->get('websmid.customhtml.grid.definition.factory.customhtmlblock_definition_factory'),
$request,
CustomHtmlBlockGridDefinitionFactory::GRID_ID,
'customhtmlblock_index'
);
}
public function createAction(Request $request): Response
{
$formBuilder = $this->get('websmid.customhtml.form.customhtmlblock_data_form_builder');
$formHandler = $this->get('websmid.customhtml.form.customhtmlblock_form_handler');
$form = $formBuilder->getForm();
if ($request->isMethod('GET') && $request->query->has('idGroup')) {
$form->get('id_ws_customhtml_group')->setData((int) $request->query->get('idGroup'));
}
$form->handleRequest($request);
try {
$handlerResult = $formHandler->handle($form);
if (null !== $handlerResult->getIdentifiableObjectId()) {
$this->addFlash('success', $this->trans('Successful creation.', 'Admin.Notifications.Success'));
return $this->redirectToRoute('customhtmlblock_index');
}
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, []));
}
return $this->render('@Modules/ws_customhtml/views/templates/admin/form/customhtmlblock_create.html.twig', [
'customHtmlBlockForm' => $form->createView(),
]);
}
public function editAction(Request $request, int $idCustomHtmlBlock): Response
{
$formBuilder = $this->get('websmid.customhtml.form.customhtmlblock_data_form_builder');
$formHandler = $this->get('websmid.customhtml.form.customhtmlblock_form_handler');
$form = $formBuilder->getFormFor($idCustomHtmlBlock);
try {
$form->handleRequest($request);
$handlerResult = $formHandler->handleFor($idCustomHtmlBlock, $form);
if ($handlerResult->isSubmitted() && $handlerResult->isValid()) {
$this->addFlash('success', $this->trans('Successful update.', 'Admin.Notifications.Success'));
return $this->redirectToRoute('customhtmlblock_index');
}
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, []));
}
return $this->render('@Modules/ws_customhtml/views/templates/admin/form/customhtmlblock_edit.html.twig', [
'customHtmlBlockForm' => $form->createView(),
'idCustomHtmlBlock' => $idCustomHtmlBlock,
]);
}
public function deleteAction(Request $request, int $idCustomHtmlBlock): RedirectResponse
{
$block = new CustomHtmlBlock($idCustomHtmlBlock);
if (!Validate::isLoadedObject($block)) {
$this->addFlash('error', $this->trans('Unable to find the block.', 'Modules.Wscustomhtml.Admin'));
return $this->redirectToRoute('customhtmlblock_index');
}
$block->delete();
$this->addFlash('success', $this->trans('Successful deletion.', 'Admin.Notifications.Success'));
return $this->redirectToRoute('customhtmlblock_index');
}
private function getToolbarButtons(?string $securitySubject): array
{
$toolbarButtons = [];
if (!$securitySubject || !$this->isGranted(PageVoter::CREATE, $securitySubject)) {
return $toolbarButtons;
}
$toolbarButtons['customhtmlblock_create'] = [
'href' => $this->generateUrl('customhtmlblock_create'),
'desc' => $this->trans('New block', 'Admin.Actions'),
'icon' => 'add_circle_outline',
'class' => 'btn-primary',
'floating_class' => '',
];
return $toolbarButtons;
}
}
src/Controller/CustomHtmlController.php → src/Controller/CustomHtmlGroupController.php
+35 -35
View File
@@ -8,20 +8,20 @@ use PrestaShopBundle\Security\Voter\PageVoter;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Websmid\CustomHtml\Grid\Definition\Factory\CustomHtmlGridDefinitionFactory;
use Websmid\CustomHtml\Grid\Filters\CustomHtmlFilters;
use Websmid\CustomHtml\Model\CustomHtml;
use Websmid\CustomHtml\Grid\Definition\Factory\CustomHtmlGroupGridDefinitionFactory;
use Websmid\CustomHtml\Grid\Filters\CustomHtmlGroupFilters;
use Websmid\CustomHtml\Model\CustomHtmlGroup;
use Validate;
class CustomHtmlController extends FrameworkBundleAdminController
class CustomHtmlGroupController extends FrameworkBundleAdminController
{
public function indexAction(Request $request, CustomHtmlFilters $filters): Response
public function indexAction(Request $request, CustomHtmlGroupFilters $filters): Response
{
$gridFactory = $this->get('websmid.customhtml.grid.customhtml_grid_factory');
$gridFactory = $this->get('websmid.customhtml.grid.customhtmlgroup_grid_factory');
$grid = $gridFactory->getGrid($filters);
return $this->render('@Modules/ws_customhtml/views/templates/admin/grid/customhtml.html.twig', [
'customHtmlGrid' => $this->presentGrid($grid),
return $this->render('@Modules/ws_customhtml/views/templates/admin/grid/customhtmlgroup.html.twig', [
'customHtmlGroupGrid' => $this->presentGrid($grid),
'layoutHeaderToolbarBtn' => $this->getToolbarButtons($request->get('_legacy_controller')),
]);
}
@@ -29,17 +29,17 @@ class CustomHtmlController extends FrameworkBundleAdminController
public function searchAction(Request $request): RedirectResponse
{
return $this->get('prestashop.bundle.grid.response_builder')->buildSearchResponse(
$this->get('websmid.customhtml.grid.definition.factory.customhtml_definition_factory'),
$this->get('websmid.customhtml.grid.definition.factory.customhtmlgroup_definition_factory'),
$request,
CustomHtmlGridDefinitionFactory::GRID_ID,
'customhtml_index'
CustomHtmlGroupGridDefinitionFactory::GRID_ID,
'customhtmlgroup_index'
);
}
public function createAction(Request $request): Response
{
$formBuilder = $this->get('websmid.customhtml.form.customhtml_data_form_builder');
$formHandler = $this->get('websmid.customhtml.form.customhtml_form_handler');
$formBuilder = $this->get('websmid.customhtml.form.customhtmlgroup_data_form_builder');
$formHandler = $this->get('websmid.customhtml.form.customhtmlgroup_form_handler');
$form = $formBuilder->getForm();
$form->handleRequest($request);
@@ -50,57 +50,57 @@ class CustomHtmlController extends FrameworkBundleAdminController
if (null !== $handlerResult->getIdentifiableObjectId()) {
$this->addFlash('success', $this->trans('Successful creation.', 'Admin.Notifications.Success'));
return $this->redirectToRoute('customhtml_index');
return $this->redirectToRoute('customhtmlgroup_index');
}
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, []));
}
return $this->render('@Modules/ws_customhtml/views/templates/admin/form/customhtml_create.html.twig', [
'customHtmlForm' => $form->createView(),
return $this->render('@Modules/ws_customhtml/views/templates/admin/form/customhtmlgroup_create.html.twig', [
'customHtmlGroupForm' => $form->createView(),
]);
}
public function editAction(Request $request, int $idCustomHtml): Response
public function editAction(Request $request, int $idCustomHtmlGroup): Response
{
$formBuilder = $this->get('websmid.customhtml.form.customhtml_data_form_builder');
$formHandler = $this->get('websmid.customhtml.form.customhtml_form_handler');
$formBuilder = $this->get('websmid.customhtml.form.customhtmlgroup_data_form_builder');
$formHandler = $this->get('websmid.customhtml.form.customhtmlgroup_form_handler');
$form = $formBuilder->getFormFor($idCustomHtml);
$form = $formBuilder->getFormFor($idCustomHtmlGroup);
try {
$form->handleRequest($request);
$handlerResult = $formHandler->handleFor($idCustomHtml, $form);
$handlerResult = $formHandler->handleFor($idCustomHtmlGroup, $form);
if ($handlerResult->isSubmitted() && $handlerResult->isValid()) {
$this->addFlash('success', $this->trans('Successful update.', 'Admin.Notifications.Success'));
return $this->redirectToRoute('customhtml_index');
return $this->redirectToRoute('customhtmlgroup_index');
}
} catch (Exception $e) {
$this->addFlash('error', $this->getErrorMessageForException($e, []));
}
return $this->render('@Modules/ws_customhtml/views/templates/admin/form/customhtml_edit.html.twig', [
'customHtmlForm' => $form->createView(),
'idCustomHtml' => $idCustomHtml,
return $this->render('@Modules/ws_customhtml/views/templates/admin/form/customhtmlgroup_edit.html.twig', [
'customHtmlGroupForm' => $form->createView(),
'idCustomHtmlGroup' => $idCustomHtmlGroup,
]);
}
public function deleteAction(Request $request, int $idCustomHtml): RedirectResponse
public function deleteAction(Request $request, int $idCustomHtmlGroup): RedirectResponse
{
$block = new CustomHtml($idCustomHtml);
$group = new CustomHtmlGroup($idCustomHtmlGroup);
if (!Validate::isLoadedObject($block)) {
$this->addFlash('error', $this->trans('Unable to find the block.', 'Modules.Wscustomhtml.Admin'));
if (!Validate::isLoadedObject($group)) {
$this->addFlash('error', $this->trans('Unable to find the group.', 'Modules.Wscustomhtml.Admin'));
return $this->redirectToRoute('customhtml_index');
return $this->redirectToRoute('customhtmlgroup_index');
}
$block->delete();
$group->delete();
$this->addFlash('success', $this->trans('Successful deletion.', 'Admin.Notifications.Success'));
return $this->redirectToRoute('customhtml_index');
return $this->redirectToRoute('customhtmlgroup_index');
}
private function getToolbarButtons(?string $securitySubject): array
@@ -111,9 +111,9 @@ class CustomHtmlController extends FrameworkBundleAdminController
return $toolbarButtons;
}
$toolbarButtons['customhtml_create'] = [
'href' => $this->generateUrl('customhtml_create'),
'desc' => $this->trans('New block', 'Admin.Actions'),
$toolbarButtons['customhtmlgroup_create'] = [
'href' => $this->generateUrl('customhtmlgroup_create'),
'desc' => $this->trans('New group', 'Admin.Actions'),
'icon' => 'add_circle_outline',
'class' => 'btn-primary',
'floating_class' => '',
src/Form/ChoiceProvider/CustomHtmlGroupChoiceProvider.php
+36
View File
@@ -0,0 +1,36 @@
<?php
namespace Websmid\CustomHtml\Form\ChoiceProvider;
use PrestaShop\PrestaShop\Core\Form\ConfigurableFormChoiceProviderInterface;
use PrestaShop\PrestaShop\Core\Form\FormChoiceAttributeProviderInterface;
use PrestaShop\PrestaShop\Core\Form\FormChoiceProviderInterface;
use Db;
final class CustomHtmlGroupChoiceProvider implements
FormChoiceProviderInterface,
FormChoiceAttributeProviderInterface,
ConfigurableFormChoiceProviderInterface
{
public function getChoices(array $options = []): array
{
$groups = Db::getInstance()->executeS(
'SELECT `id_ws_customhtml_group`, `title`
FROM `' . _DB_PREFIX_ . 'ws_customhtml_group`
ORDER BY `title` ASC'
);
$choices = [];
foreach ($groups as $group) {
$choices[$group['title']] = (int) $group['id_ws_customhtml_group'];
}
return $choices;
}
public function getChoicesAttributes(): array
{
return [];
}
}
src/Form/DataHandler/CustomHtmlBlockDataHandler.php
+44
View File
@@ -0,0 +1,44 @@
<?php
namespace Websmid\CustomHtml\Form\DataHandler;
use PrestaShop\PrestaShop\Core\Form\IdentifiableObject\DataHandler\FormDataHandlerInterface;
use Websmid\CustomHtml\Model\CustomHtmlBlock;
use Validate;
final class CustomHtmlBlockDataHandler implements FormDataHandlerInterface
{
public function create(array $formData)
{
$block = new CustomHtmlBlock();
$block->id_ws_customhtml_group = (int) $formData['id_ws_customhtml_group'];
$block->title = (string) $formData['title'];
$block->show_title = (int) $formData['show_title'];
$block->content = (string) $formData['content'];
$block->active = (int) $formData['active'];
$block->ordering = 0;
if (!$block->add()) {
return false;
}
return $block->id;
}
public function update($id, array $formData)
{
$block = new CustomHtmlBlock((int) $id);
if (!Validate::isLoadedObject($block)) {
return false;
}
$block->id_ws_customhtml_group = (int) $formData['id_ws_customhtml_group'];
$block->title = (string) $formData['title'];
$block->show_title = (int) $formData['show_title'];
$block->content = (string) $formData['content'];
$block->active = (int) $formData['active'];
return (bool) $block->update();
}
}
src/Form/DataHandler/CustomHtmlDataHandler.php → src/Form/DataHandler/CustomHtmlGroupDataHandler.php
+15 -19
View File
@@ -3,48 +3,44 @@
namespace Websmid\CustomHtml\Form\DataHandler;
use PrestaShop\PrestaShop\Core\Form\IdentifiableObject\DataHandler\FormDataHandlerInterface;
use Websmid\CustomHtml\Model\CustomHtml;
use Websmid\CustomHtml\Model\CustomHtmlGroup;
use Context;
use Hook;
use Module;
use Validate;
final class CustomHtmlDataHandler implements FormDataHandlerInterface
final class CustomHtmlGroupDataHandler implements FormDataHandlerInterface
{
public function create(array $formData)
{
$block = new CustomHtml();
$block->hook_name = (string) $formData['hook_name'];
$block->title = (string) $formData['title'];
$block->show_title = (int) $formData['show_title'];
$block->content = (string) $formData['content'];
$block->active = (int) $formData['active'];
$block->ordering = 0;
$group = new CustomHtmlGroup();
$group->title = (string) $formData['title'];
$group->hook_name = (string) $formData['hook_name'];
$group->active = (int) $formData['active'];
$group->ordering = 0;
if (!$block->add()) {
if (!$group->add()) {
return false;
}
$this->checkAndRegisterHookForModule((string) $formData['hook_name']);
return $block->id;
return $group->id;
}
public function update($id, array $formData)
{
$block = new CustomHtml((int) $id);
$group = new CustomHtmlGroup((int) $id);
if (!Validate::isLoadedObject($block)) {
if (!Validate::isLoadedObject($group)) {
return false;
}
$block->hook_name = (string) $formData['hook_name'];
$block->title = (string) $formData['title'];
$block->show_title = (int) $formData['show_title'];
$block->content = (string) $formData['content'];
$block->active = (int) $formData['active'];
$group->title = (string) $formData['title'];
$group->hook_name = (string) $formData['hook_name'];
$group->active = (int) $formData['active'];
if (!$block->update()) {
if (!$group->update()) {
return false;
}
src/Form/DataProvider/CustomHtmlBlockDataProvider.php
+38
View File
@@ -0,0 +1,38 @@
<?php
namespace Websmid\CustomHtml\Form\DataProvider;
use PrestaShop\PrestaShop\Core\Form\IdentifiableObject\DataProvider\FormDataProviderInterface;
use Websmid\CustomHtml\Model\CustomHtmlBlock;
use Validate;
final class CustomHtmlBlockDataProvider implements FormDataProviderInterface
{
public function getData($id)
{
$block = new CustomHtmlBlock((int) $id);
if (!Validate::isLoadedObject($block)) {
return $this->getDefaultData();
}
return [
'id_ws_customhtml_group' => (int) $block->id_ws_customhtml_group,
'title' => $block->title,
'show_title' => (bool) $block->show_title,
'content' => $block->content,
'active' => (bool) $block->active,
];
}
public function getDefaultData()
{
return [
'id_ws_customhtml_group' => 0,
'title' => '',
'show_title' => false,
'content' => '',
'active' => true,
];
}
}
src/Form/DataProvider/CustomHtmlDataProvider.php
-38
View File
@@ -1,38 +0,0 @@
<?php
namespace Websmid\CustomHtml\Form\DataProvider;
use PrestaShop\PrestaShop\Core\Form\IdentifiableObject\DataProvider\FormDataProviderInterface;
use Websmid\CustomHtml\Model\CustomHtml;
use Validate;
final class CustomHtmlDataProvider implements FormDataProviderInterface
{
public function getData($id)
{
$block = new CustomHtml((int) $id);
if (!Validate::isLoadedObject($block)) {
return $this->getDefaultData();
}
return [
'hook_name' => $block->hook_name,
'title' => $block->title,
'show_title' => (bool) $block->show_title,
'content' => $block->content,
'active' => (bool) $block->active,
];
}
public function getDefaultData()
{
return [
'hook_name' => '',
'title' => '',
'show_title' => false,
'content' => '',
'active' => true,
];
}
}
src/Form/DataProvider/CustomHtmlGroupDataProvider.php
+34
View File
@@ -0,0 +1,34 @@
<?php
namespace Websmid\CustomHtml\Form\DataProvider;
use PrestaShop\PrestaShop\Core\Form\IdentifiableObject\DataProvider\FormDataProviderInterface;
use Websmid\CustomHtml\Model\CustomHtmlGroup;
use Validate;
final class CustomHtmlGroupDataProvider implements FormDataProviderInterface
{
public function getData($id)
{
$group = new CustomHtmlGroup((int) $id);
if (!Validate::isLoadedObject($group)) {
return $this->getDefaultData();
}
return [
'title' => $group->title,
'hook_name' => $group->hook_name,
'active' => (bool) $group->active,
];
}
public function getDefaultData()
{
return [
'title' => '',
'hook_name' => '',
'active' => true,
];
}
}
src/Form/Type/CustomHtmlType.php → src/Form/Type/CustomHtmlBlockType.php
+13 -5
View File
@@ -4,25 +4,33 @@ namespace Websmid\CustomHtml\Form\Type;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
use PrestaShop\PrestaShop\Core\Form\ConfigurableFormChoiceProviderInterface;
use PrestaShopBundle\Form\Admin\Type\SwitchType;
use Symfony\Contracts\Translation\TranslatorInterface;
class CustomHtmlType extends AbstractType
class CustomHtmlBlockType extends AbstractType
{
private $translator;
private $groupChoiceProvider;
public function __construct(TranslatorInterface $translator, array $locales)
{
public function __construct(
TranslatorInterface $translator,
array $locales,
ConfigurableFormChoiceProviderInterface $groupChoiceProvider
) {
$this->translator = $translator;
$this->groupChoiceProvider = $groupChoiceProvider;
}
public function buildForm(FormBuilderInterface $formBuilder, array $options): void
{
$formBuilder
->add('hook_name', TextType::class, [
'label' => $this->translator->trans('Hook name', [], 'Modules.Wscustomhtml.Admin'),
->add('id_ws_customhtml_group', ChoiceType::class, [
'label' => $this->translator->trans('Group', [], 'Modules.Wscustomhtml.Admin'),
'choices' => $this->groupChoiceProvider->getChoices(),
'required' => true,
])
->add('title', TextType::class, [
src/Form/Type/CustomHtmlGroupType.php
+36
View File
@@ -0,0 +1,36 @@
<?php
namespace Websmid\CustomHtml\Form\Type;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use PrestaShopBundle\Form\Admin\Type\SwitchType;
use Symfony\Contracts\Translation\TranslatorInterface;
class CustomHtmlGroupType extends AbstractType
{
private $translator;
public function __construct(TranslatorInterface $translator, array $locales)
{
$this->translator = $translator;
}
public function buildForm(FormBuilderInterface $formBuilder, array $options): void
{
$formBuilder
->add('title', TextType::class, [
'label' => $this->translator->trans('Title', [], 'Modules.Wscustomhtml.Admin'),
'required' => true,
])
->add('hook_name', TextType::class, [
'label' => $this->translator->trans('Hook name', [], 'Modules.Wscustomhtml.Admin'),
'required' => true,
])
->add('active', SwitchType::class, [
'label' => $this->translator->trans('Active', [], 'Modules.Wscustomhtml.Admin'),
'required' => false,
]);
}
}
src/Grid/Definition/Factory/CustomHtmlGridDefinitionFactory.php → src/Grid/Definition/Factory/CustomHtmlBlockGridDefinitionFactory.php
+22 -22
View File
@@ -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')
);
}
}
src/Grid/Definition/Factory/CustomHtmlGroupGridDefinitionFactory.php
+173
View File
@@ -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')
);
}
}
src/Grid/Filters/CustomHtmlFilters.php → src/Grid/Filters/CustomHtmlBlockFilters.php
+4 -4
View File
@@ -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' => [],
];
src/Grid/Filters/CustomHtmlGroupFilters.php
+22
View File
@@ -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' => [],
];
}
}
src/Grid/Query/CustomHtmlBlockQueryBuilder.php
+115
View File
@@ -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) . '%');
}
}
}
src/Grid/Query/CustomHtmlQueryBuilder.php → src/Grid/Query/CustomHtmlGroupQueryBuilder.php
+14 -12
View File
@@ -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) . '%');
}
}
src/Model/CustomHtmlBlock.php
+76
View File
@@ -0,0 +1,76 @@
<?php
namespace Websmid\CustomHtml\Model;
use ObjectModel;
use Db;
class CustomHtmlBlock extends ObjectModel
{
/** @var int */
public $id;
/** @var int */
public $id_ws_customhtml_group;
/** @var string */
public $title = '';
/** @var string */
public $content = '';
/** @var int */
public $active = 1;
/** @var int */
public $show_title = 0;
/** @var int */
public $ordering = 0;
/** @var string */
public $date_add;
/** @var string */
public $date_upd;
public static $definition = [
'table' => 'ws_customhtml',
'primary' => 'id_ws_customhtml',
'fields' => [
'id_ws_customhtml_group' => ['type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true],
'title' => ['type' => self::TYPE_STRING, 'validate' => 'isGenericName', 'required' => true, 'size' => 256],
'content' => ['type' => self::TYPE_HTML, 'validate' => 'isCleanHtml'],
'active' => ['type' => self::TYPE_BOOL, 'validate' => 'isBool'],
'show_title' => ['type' => self::TYPE_BOOL, 'validate' => 'isBool'],
'ordering' => ['type' => self::TYPE_INT, 'validate' => 'isInt'],
'date_add' => ['type' => self::TYPE_DATE, 'validate' => 'isDate'],
'date_upd' => ['type' => self::TYPE_DATE, 'validate' => 'isDate'],
],
];
public static function getActiveByGroupIds(array $groupIds): array
{
$groupIds = array_map('intval', $groupIds);
if (empty($groupIds)) {
return [];
}
$result = Db::getInstance()->executeS(
'SELECT `id_ws_customhtml`, `id_ws_customhtml_group`, `title`, `content`, `active`, `show_title`, `ordering`
FROM `' . _DB_PREFIX_ . 'ws_customhtml`
WHERE `id_ws_customhtml_group` IN (' . implode(',', $groupIds) . ')
AND `active` = 1
ORDER BY `ordering` ASC'
);
$blocksByGroup = [];
foreach ($result as $row) {
$blocksByGroup[(int) $row['id_ws_customhtml_group']][] = $row;
}
return $blocksByGroup;
}
}
src/Model/CustomHtml.php → src/Model/CustomHtmlGroup.php
+9 -17
View File
@@ -5,7 +5,7 @@ namespace Websmid\CustomHtml\Model;
use ObjectModel;
use Db;
class CustomHtml extends ObjectModel
class CustomHtmlGroup extends ObjectModel
{
/** @var int */
public $id;
@@ -16,15 +16,9 @@ class CustomHtml extends ObjectModel
/** @var string */
public $title = '';
/** @var string */
public $content = '';
/** @var int */
public $active = 1;
/** @var int */
public $show_title = 0;
/** @var int */
public $ordering = 0;
@@ -35,25 +29,23 @@ class CustomHtml extends ObjectModel
public $date_upd;
public static $definition = [
'table' => 'ws_customhtml',
'primary' => 'id_ws_customhtml',
'table' => 'ws_customhtml_group',
'primary' => 'id_ws_customhtml_group',
'fields' => [
'hook_name' => ['type' => self::TYPE_STRING, 'validate' => 'isGenericName', 'required' => true, 'size' => 64],
'title' => ['type' => self::TYPE_STRING, 'validate' => 'isGenericName', 'required' => true, 'size' => 256],
'content' => ['type' => self::TYPE_HTML, 'validate' => 'isCleanHtml'],
'active' => ['type' => self::TYPE_BOOL, 'validate' => 'isBool'],
'show_title' => ['type' => self::TYPE_BOOL, 'validate' => 'isBool'],
'ordering' => ['type' => self::TYPE_INT, 'validate' => 'isInt'],
'date_add' => ['type' => self::TYPE_DATE, 'validate' => 'isDate'],
'date_upd' => ['type' => self::TYPE_DATE, 'validate' => 'isDate'],
'active' => ['type' => self::TYPE_BOOL, 'validate' => 'isBool'],
'ordering' => ['type' => self::TYPE_INT, 'validate' => 'isInt'],
'date_add' => ['type' => self::TYPE_DATE, 'validate' => 'isDate'],
'date_upd' => ['type' => self::TYPE_DATE, 'validate' => 'isDate'],
],
];
public static function getActiveByHookName(string $hookName): array
{
$result = Db::getInstance()->executeS(
'SELECT `id_ws_customhtml`, `title`, `content`, `active`, `show_title`, `ordering`
FROM `' . _DB_PREFIX_ . 'ws_customhtml`
'SELECT `id_ws_customhtml_group`, `title`, `active`, `ordering`
FROM `' . _DB_PREFIX_ . 'ws_customhtml_group`
WHERE `hook_name` = \'' . pSQL($hookName) . '\'
AND `active` = 1
ORDER BY `ordering` ASC'
src/Module/AdminHooks.php
+13 -1
View File
@@ -2,6 +2,7 @@
namespace Websmid\CustomHtml\Module;
use Websmid\CustomHtml\Config\Config;
use Tools;
trait AdminHooks
@@ -13,6 +14,17 @@ trait AdminHooks
public function getContent()
{
Tools::redirectAdmin($this->get('router')->generate('customhtml_index'));
Tools::redirectAdmin($this->get('router')->generate('customhtmlgroup_index'));
}
public function hookActionAdminControllerSetMedia(): void
{
$controllerName = $this->context->controller->controller_name ?? '';
if (!in_array($controllerName, Config::ADMIN_CONTROLLERS, true)) {
return;
}
$this->context->controller->addCSS($this->getPathUri() . 'views/css/admin/grid.css');
}
}
src/Module/DisplayHooks.php
+26 -4
View File
@@ -2,7 +2,8 @@
namespace Websmid\CustomHtml\Module;
use Websmid\CustomHtml\Model\CustomHtml;
use Websmid\CustomHtml\Model\CustomHtmlBlock;
use Websmid\CustomHtml\Model\CustomHtmlGroup;
use Context;
trait DisplayHooks
@@ -32,15 +33,36 @@ trait DisplayHooks
public function getWidgetVariables($hookName = null, array $configuration = [])
{
$blockList = CustomHtml::getActiveByHookName((string) $hookName);
$groupList = $this->loadActiveGroupsWithBlocks((string) $hookName);
if (empty($blockList)) {
if (empty($groupList)) {
return [];
}
return [
'hookName' => $hookName,
'blockList' => $blockList,
'groupList' => $groupList,
];
}
private function loadActiveGroupsWithBlocks(string $hookName): array
{
$groups = CustomHtmlGroup::getActiveByHookName($hookName);
if (empty($groups)) {
return [];
}
$blocksByGroup = CustomHtmlBlock::getActiveByGroupIds(array_column($groups, 'id_ws_customhtml_group'));
$groups = array_map(static function (array $group) use ($blocksByGroup) {
$group['blocks'] = $blocksByGroup[(int) $group['id_ws_customhtml_group']] ?? [];
return $group;
}, $groups);
return array_values(array_filter($groups, static function (array $group) {
return !empty($group['blocks']);
}));
}
}
src/Module/Install.php
+15 -2
View File
@@ -38,17 +38,30 @@ trait Install
{
$sqlToExec = [];
$sqlToExec[] = '
CREATE TABLE IF NOT EXISTS ' . _DB_PREFIX_ . 'ws_customhtml_group (
`id_ws_customhtml_group` INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY,
`hook_name` VARCHAR(64) NOT NULL,
`title` VARCHAR(256) NOT NULL DEFAULT \'\',
`active` TINYINT(1) NOT NULL DEFAULT 1,
`ordering` INT(11) NOT NULL DEFAULT 0,
`date_add` DATETIME NOT NULL,
`date_upd` DATETIME NOT NULL
);
';
$sqlToExec[] = '
CREATE TABLE IF NOT EXISTS ' . _DB_PREFIX_ . 'ws_customhtml (
`id_ws_customhtml` INT(11) NOT NULL AUTO_INCREMENT PRIMARY KEY,
`hook_name` VARCHAR(64) NOT NULL,
`id_ws_customhtml_group` INT(11) NOT NULL,
`title` VARCHAR(256) NOT NULL DEFAULT \'\',
`content` LONGTEXT,
`active` TINYINT(1) NOT NULL DEFAULT 1,
`show_title` TINYINT(1) NOT NULL DEFAULT 0,
`ordering` INT(11) NOT NULL DEFAULT 0,
`date_add` DATETIME NOT NULL,
`date_upd` DATETIME NOT NULL
`date_upd` DATETIME NOT NULL,
KEY `id_ws_customhtml_group` (`id_ws_customhtml_group`)
);
';
views/css/admin/grid.css
+11
View File
@@ -0,0 +1,11 @@
td.action-type {
display: flex;
align-items: center;
justify-content: center;
}
td.action-type .btn-group-action {
display: flex;
align-items: center;
justify-content: center;
}
views/templates/admin/form/blocks/form.html.twig → views/templates/admin/form/blocks/block_form.html.twig
+6 -6
View File
@@ -1,25 +1,25 @@
{% import '@PrestaShop/Admin/macros.html.twig' as ps %}
{% form_theme customHtmlForm '@PrestaShop/Admin/TwigTemplateForm/prestashop_ui_kit.html.twig' %}
{% form_theme customHtmlBlockForm '@PrestaShop/Admin/TwigTemplateForm/prestashop_ui_kit.html.twig' %}
{% block customhtml_form_block %}
{% block customhtmlblock_form_block %}
<div class="card">
{{ form_start(customHtmlForm) }}
{{ form_start(customHtmlBlockForm) }}
<div class="card-header">
<h3 class="card-header-title">
{{ 'Custom HTML Block'|trans({}, 'Modules.Wscustomhtml.Admin') }}
</h3>
</div>
<div class="card-body">
{{ form_rest(customHtmlForm) }}
{{ form_rest(customHtmlBlockForm) }}
</div>
<div class="card-footer">
<a href="{{ path('customhtml_index') }}" class="btn btn-outline-secondary">
<a href="{{ path('customhtmlblock_index') }}" class="btn btn-outline-secondary">
{{ 'Cancel'|trans({}, 'Admin.Actions') }}
</a>
<button class="btn btn-primary float-right">
{{ 'Save'|trans({}, 'Admin.Actions') }}
</button>
</div>
{{ form_end(customHtmlForm) }}
{{ form_end(customHtmlBlockForm) }}
</div>
{% endblock %}
views/templates/admin/form/blocks/group_form.html.twig
+30
View File
@@ -0,0 +1,30 @@
{% import '@PrestaShop/Admin/macros.html.twig' as ps %}
{% form_theme customHtmlGroupForm '@PrestaShop/Admin/TwigTemplateForm/prestashop_ui_kit.html.twig' %}
{% block customhtmlgroup_form_block %}
<div class="card">
{{ form_start(customHtmlGroupForm) }}
<div class="card-header">
<h3 class="card-header-title">
{{ 'Custom HTML Group'|trans({}, 'Modules.Wscustomhtml.Admin') }}
</h3>
</div>
<div class="card-body">
{{ form_rest(customHtmlGroupForm) }}
</div>
<div class="card-footer">
<a href="{{ path('customhtmlgroup_index') }}" class="btn btn-outline-secondary">
{{ 'Cancel'|trans({}, 'Admin.Actions') }}
</a>
{% if idCustomHtmlGroup is defined %}
<a href="{{ path('customhtmlblock_create', {'idGroup': idCustomHtmlGroup}) }}" class="btn btn-outline-primary">
{{ 'Add block'|trans({}, 'Modules.Wscustomhtml.Admin') }}
</a>
{% endif %}
<button class="btn btn-primary float-right">
{{ 'Save'|trans({}, 'Admin.Actions') }}
</button>
</div>
{{ form_end(customHtmlGroupForm) }}
</div>
{% endblock %}
views/templates/admin/form/customhtml_edit.html.twig → views/templates/admin/form/customhtmlblock_create.html.twig
+2 -4
View File
@@ -1,8 +1,8 @@
{% extends '@PrestaShop/Admin/layout.html.twig' %}
{% block content %}
{% block customhtml_edit_form %}
{% include '@Modules/ws_customhtml/views/templates/admin/form/blocks/form.html.twig' %}
{% block customhtmlblock_create_form %}
{% include '@Modules/ws_customhtml/views/templates/admin/form/blocks/block_form.html.twig' %}
{% endblock %}
{% endblock %}
@@ -11,9 +11,7 @@
<script>
$(document).ready(function () {
window.prestashop.component.initComponents([
'TranslatableField',
'TinyMCEEditor',
'TranslatableInput',
]);
});
</script>
views/templates/admin/form/customhtml_create.html.twig → views/templates/admin/form/customhtmlblock_edit.html.twig
+2 -4
View File
@@ -1,8 +1,8 @@
{% extends '@PrestaShop/Admin/layout.html.twig' %}
{% block content %}
{% block customhtml_create_form %}
{% include '@Modules/ws_customhtml/views/templates/admin/form/blocks/form.html.twig' %}
{% block customhtmlblock_edit_form %}
{% include '@Modules/ws_customhtml/views/templates/admin/form/blocks/block_form.html.twig' %}
{% endblock %}
{% endblock %}
@@ -11,9 +11,7 @@
<script>
$(document).ready(function () {
window.prestashop.component.initComponents([
'TranslatableField',
'TinyMCEEditor',
'TranslatableInput',
]);
});
</script>
views/templates/admin/form/customhtmlgroup_create.html.twig
+7
View File
@@ -0,0 +1,7 @@
{% extends '@PrestaShop/Admin/layout.html.twig' %}
{% block content %}
{% block customhtmlgroup_create_form %}
{% include '@Modules/ws_customhtml/views/templates/admin/form/blocks/group_form.html.twig' %}
{% endblock %}
{% endblock %}
views/templates/admin/form/customhtmlgroup_edit.html.twig
+7
View File
@@ -0,0 +1,7 @@
{% extends '@PrestaShop/Admin/layout.html.twig' %}
{% block content %}
{% block customhtmlgroup_edit_form %}
{% include '@Modules/ws_customhtml/views/templates/admin/form/blocks/group_form.html.twig' %}
{% endblock %}
{% endblock %}
views/templates/admin/grid/customhtml.html.twig
-20
View File
@@ -1,20 +0,0 @@
{% extends '@PrestaShop/Admin/layout.html.twig' %}
{% block content %}
{% block customhtml_list %}
<div class="row">
<div class="col">
{% include '@PrestaShop/Admin/Common/Grid/grid_panel.html.twig' with {'grid': customHtmlGrid} %}
</div>
</div>
{% endblock %}
{% endblock %}
{% block javascripts %}
{{ parent() }}
<script>
$(document).ready(function () {
new window.prestashop.component.Grid('customhtml');
});
</script>
{% endblock %}
views/templates/admin/grid/customhtmlblock.html.twig
+25
View File
@@ -0,0 +1,25 @@
{% extends '@PrestaShop/Admin/layout.html.twig' %}
{% block content %}
{% block customhtmlblock_list %}
<div class="row">
<div class="col">
{% include '@PrestaShop/Admin/Common/Grid/grid_panel.html.twig' with {'grid': customHtmlBlockGrid} %}
</div>
</div>
{% endblock %}
{% endblock %}
{% block javascripts %}
{{ parent() }}
<script>
$(document).ready(function () {
const customhtmlblockGrid = new window.prestashop.component.Grid('customhtmlblock');
customhtmlblockGrid.addExtension(new window.prestashop.component.GridExtensions.SortingExtension());
customhtmlblockGrid.addExtension(new window.prestashop.component.GridExtensions.FiltersResetExtension());
customhtmlblockGrid.addExtension(new window.prestashop.component.GridExtensions.ColumnTogglingExtension());
customhtmlblockGrid.addExtension(new window.prestashop.component.GridExtensions.SubmitRowActionExtension());
});
</script>
{% endblock %}
views/templates/admin/grid/customhtmlgroup.html.twig
+25
View File
@@ -0,0 +1,25 @@
{% extends '@PrestaShop/Admin/layout.html.twig' %}
{% block content %}
{% block customhtmlgroup_list %}
<div class="row">
<div class="col">
{% include '@PrestaShop/Admin/Common/Grid/grid_panel.html.twig' with {'grid': customHtmlGroupGrid} %}
</div>
</div>
{% endblock %}
{% endblock %}
{% block javascripts %}
{{ parent() }}
<script>
$(document).ready(function () {
const customhtmlgroupGrid = new window.prestashop.component.Grid('customhtmlgroup');
customhtmlgroupGrid.addExtension(new window.prestashop.component.GridExtensions.SortingExtension());
customhtmlgroupGrid.addExtension(new window.prestashop.component.GridExtensions.FiltersResetExtension());
customhtmlgroupGrid.addExtension(new window.prestashop.component.GridExtensions.ColumnTogglingExtension());
customhtmlgroupGrid.addExtension(new window.prestashop.component.GridExtensions.SubmitRowActionExtension());
});
</script>
{% endblock %}
views/templates/hook/customhtml_block.tpl
+11 -7
View File
@@ -1,11 +1,15 @@
{if !empty($blockList)}
{if !empty($groupList)}
<div class="customhtml-container {$hookName|escape:'html':'UTF-8'}--container">
{foreach from=$blockList item="block"}
<div class="customhtml-block">
{if $block.show_title && !empty($block.title)}
<div class="customhtml-title">{$block.title|escape:'html':'UTF-8'}</div>
{/if}
<div class="customhtml-content">{$block.content nofilter}</div>
{foreach from=$groupList item="group"}
<div class="customhtml-group">
{foreach from=$group.blocks item="block"}
<div class="customhtml-block">
{if $block.show_title && !empty($block.title)}
<div class="customhtml-title">{$block.title|escape:'html':'UTF-8'}</div>
{/if}
<div class="customhtml-content">{$block.content nofilter}</div>
</div>
{/foreach}
</div>
{/foreach}
</div>
ws_customhtml.php
+1 -1
View File
@@ -29,7 +29,7 @@ class Ws_CustomHtml extends Module implements WidgetInterface
public function __construct()
{
$this->name = 'ws_customhtml';
$this->version = '1.0.0';
$this->version = '1.1.0';
$this->author = 'Isabelle Oving-Anno | De Websmid BV';
$this->need_instance = 0;
$this->bootstrap = true;