From c167e55819418dfa223715122aac1eb80352e6dc Mon Sep 17 00:00:00 2001 From: Robin Morel Date: Thu, 10 Sep 2026 15:38:14 +0200 Subject: [PATCH 01/19] chore: require Thelia 3.0 and bump to 2.0.0 --- Config/module.xml | 4 ++-- composer.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Config/module.xml b/Config/module.xml index ddf184f..68dbe5c 100644 --- a/Config/module.xml +++ b/Config/module.xml @@ -20,7 +20,7 @@ en_US fr_FR - 1.2.0 + 2.0.0 Delage Mathis @@ -44,7 +44,7 @@ HookSearch --> - 2.4.0 + 3.0.0 other 0 0 diff --git a/composer.json b/composer.json index 4f089f9..9cd3aa0 100644 --- a/composer.json +++ b/composer.json @@ -3,7 +3,7 @@ "license": "LGPL-3.0-or-later", "type": "thelia-module", "require": { - "thelia/installer": "~1.1" + "thelia/installer": "^1.6" }, "extra": { "installer-name": "CustomFrontMenu" From f44882ec6326b3d1e3aa6a81c4e70b1288899649 Mon Sep 17 00:00:00 2001 From: Robin Morel Date: Thu, 10 Sep 2026 15:44:48 +0200 Subject: [PATCH 02/19] feat(front): render the menu through a Twig function instead of a Smarty plugin --- README.md | 29 ++++--- Service/CustomFrontMenuLoadService.php | 39 +++++++--- Smarty/Plugins/CustomFrontMenuPlugin.php | 53 ------------- Twig/CustomFrontMenuExtension.php | 76 +++++++++++++++++++ templates/front/menu.html.twig | 27 +++++++ .../assets/css/customFrontMenu.css.html | 40 ---------- .../frontOffice/default/customFrontMenu.html | 28 ------- 7 files changed, 151 insertions(+), 141 deletions(-) delete mode 100644 Smarty/Plugins/CustomFrontMenuPlugin.php create mode 100644 Twig/CustomFrontMenuExtension.php create mode 100644 templates/front/menu.html.twig delete mode 100644 templates/frontOffice/default/assets/css/customFrontMenu.css.html delete mode 100644 templates/frontOffice/default/customFrontMenu.html diff --git a/README.md b/README.md index 128e0f7..1e9fc2f 100644 --- a/README.md +++ b/README.md @@ -33,14 +33,19 @@ Menu items can be added, deleted, renamed or moved. Translations can be made dir Each menu item is linked to a URL. This can be entered directly or associated with a `brand`, `category`, `content`, `folder` or `product`. -In front-office, each menu should be called by a smarty plugin manually. - -To override the css file, you can replace or modify : `templates/frontOffice/default/assets/css/customFrontMenu.css.html`. +In front-office, each menu is rendered by calling the `custom_front_menu()` Twig function +in your theme. The module ships markup only: style the `.cfm-menu` classes from your theme. ## Example -```smarty -{CustomFrontMenuPlugin menu_id=388} +```twig +{{ custom_front_menu(388) }} +``` + +The visitor's locale is used by default. Pass a second argument to force one: + +```twig +{{ custom_front_menu(388, 'fr_FR') }} ``` _________________ @@ -80,12 +85,18 @@ Les éléments du menu peuvent être ajoutés, supprimés, renommés ou déplac Chaque élément du menu est lié à une URL. Celle-ci peut être saisie directement ou associée à un `brand`, `category`, `content`, `folder` ou `product`. -Dans le front-office, chaque menu doit être appelé manuellement par un plugin smarty. +Dans le front-office, chaque menu est rendu en appelant la fonction Twig `custom_front_menu()` dans votre thème. -Pour remplacer le fichier css, vous pouvez remplacer ou modifier : `templates/frontOffice/default/assets/css/customFrontMenu.css.html`. +Le module ne fournit que le markup : les classes `.cfm-menu` sont à styler depuis votre thème. ## Exemple -```smarty -{CustomFrontMenuPlugin menu_id=388} +```twig +{{ custom_front_menu(388) }} +``` + +La locale du visiteur est utilisée par défaut. Un second argument permet de la forcer : + +```twig +{{ custom_front_menu(388, 'fr_FR') }} ``` diff --git a/Service/CustomFrontMenuLoadService.php b/Service/CustomFrontMenuLoadService.php index 394792e..67e1942 100644 --- a/Service/CustomFrontMenuLoadService.php +++ b/Service/CustomFrontMenuLoadService.php @@ -1,5 +1,7 @@ strtolower($type), strtolower($type).'_id' => $id]; - if($lang) { - $parameters['lang'] = $lang; + $queryClass = match (strtolower($view)) { + 'brand' => BrandQuery::class, + 'category' => CategoryQuery::class, + 'content' => ContentQuery::class, + 'folder' => FolderQuery::class, + 'product' => ProductQuery::class, + default => null, + }; + + if (null === $queryClass) { + return null; } - return URL::getInstance()->absoluteUrl('', $parameters); + + $target = $queryClass::create()->findPk($viewId); + + // Target deleted since the menu was composed: no link rather than a broken one. + return $target?->getUrl($locale); } /** @@ -198,7 +215,7 @@ public function loadTableBrowserLang(CustomFrontMenuItem $parent, string $lang) $view = $descendant->getView(); $viewId = $descendant->getViewId(); if ($view && $viewId) { - $newArray['url'] = $this->generateUrl($view, $viewId, $lang); + $newArray['url'] = $this->resolvePublicUrl($view, (int) $viewId, $lang) ?? ''; } } diff --git a/Smarty/Plugins/CustomFrontMenuPlugin.php b/Smarty/Plugins/CustomFrontMenuPlugin.php deleted file mode 100644 index 1b1f50e..0000000 --- a/Smarty/Plugins/CustomFrontMenuPlugin.php +++ /dev/null @@ -1,53 +0,0 @@ -requestStack->getCurrentRequest()->getSession()->getLang()->getLocale(); - - if (!$params['menu_id']) { - throw new \InvalidArgumentException('The menu_id parameter is required', 1); - } - - $menu = $this->customFrontMenuService->getMenu($params['menu_id']); - if (!$menu) { - throw new \InvalidArgumentException('The menu does not exist', 2); - } - - $menuItems = $this->CustomFrontMenuLoadService->loadTableBrowserLang($menu, $lang); - $smarty->assign('menuItems', $menuItems); - - $cssPath = $smarty->getTemplateDir("CustomFrontMenu"). "assets/css/customFrontMenu.css.html"; - $smarty->display($cssPath); - $templatePath = $smarty->getTemplateDir("CustomFrontMenu"). "customFrontMenu.html"; - $smarty->display($templatePath); - } -} \ No newline at end of file diff --git a/Twig/CustomFrontMenuExtension.php b/Twig/CustomFrontMenuExtension.php new file mode 100644 index 0000000..a812a0d --- /dev/null +++ b/Twig/CustomFrontMenuExtension.php @@ -0,0 +1,76 @@ +render(...), + ['needs_environment' => true, 'is_safe' => ['html']], + ), + ]; + } + + public function render(Environment $twig, int $menuId, ?string $locale = null): string + { + $menu = $this->menuService->getMenu($menuId); + + // A theme asking for a menu that no longer exists gets nothing, not an + // exception: a deleted menu must not take the whole page down. + if (null === $menu) { + return ''; + } + + return $twig->render(self::TEMPLATE, [ + 'menuItems' => $this->loadService->loadTableBrowserLang($menu, $locale ?? $this->locale()), + ]); + } + + private function locale(): string + { + /** @var Session|null $session */ + $session = $this->requestStack->getCurrentRequest()?->getSession(); + + return $session?->getLang()?->getLocale() ?? 'en_US'; + } +} diff --git a/templates/front/menu.html.twig b/templates/front/menu.html.twig new file mode 100644 index 0000000..bf002b4 --- /dev/null +++ b/templates/front/menu.html.twig @@ -0,0 +1,27 @@ +{# + Markup only: the module ships no stylesheet, the theme styles .cfm-menu. + Rendered by the custom_front_menu() Twig function. +#} +{% macro items(menuItems) %} + {% for item in menuItems %} +
  • + {% if item.url is defined and item.url is not empty %} + {{ item.title }} + {% else %} + {{ item.title }} + {% endif %} + + {% if item.children is defined and item.children is not empty %} +
      + {{ _self.items(item.children) }} +
    + {% endif %} +
    • + {% endfor %} +{% endmacro %} + + diff --git a/templates/frontOffice/default/assets/css/customFrontMenu.css.html b/templates/frontOffice/default/assets/css/customFrontMenu.css.html deleted file mode 100644 index 1476135..0000000 --- a/templates/frontOffice/default/assets/css/customFrontMenu.css.html +++ /dev/null @@ -1,40 +0,0 @@ - \ No newline at end of file diff --git a/templates/frontOffice/default/customFrontMenu.html b/templates/frontOffice/default/customFrontMenu.html deleted file mode 100644 index 802b909..0000000 --- a/templates/frontOffice/default/customFrontMenu.html +++ /dev/null @@ -1,28 +0,0 @@ -{function name=printMenu} - {foreach $menuItems as $menuItem} -
  • - {if isset($menuItem.url) && $menuItem.url != ""} - {$menuItem.title} - {else} - {$menuItem.title} - {/if} - - -
      - {if isset($menuItem.children) && $menuItem.children|count > 0} - {call name=printMenu menuItems=$menuItem.children} - {/if} -
    -
    • - {/foreach} -{/function} - - From b8666c162c2c208ddd154ef666b7d0d0e17d0c12 Mon Sep 17 00:00:00 2001 From: Robin Morel Date: Thu, 10 Sep 2026 16:09:56 +0200 Subject: [PATCH 03/19] feat(back-office): port the composition screen to the default-twig theme --- Controller/MenuController.php | 251 +++++---- CustomFrontMenu.php | 17 +- Hook/ConfigHook.php | 96 ++-- .../{default => default-twig}/en_US.php | 0 .../{default => default-twig}/es_ES.php | 0 .../{default => default-twig}/fr_FR.php | 0 .../{default => default-twig}/it_IT.php | 0 Service/BackOffice/MenuTargetCatalog.php | 81 +++ .../assets/css/styles.css | 0 .../assets/js/main.js | 83 +-- .../default-twig/module-config.html.twig | 325 ++++++++++++ .../backOffice/default/module-config.html | 484 ------------------ 12 files changed, 657 insertions(+), 680 deletions(-) rename I18n/backOffice/{default => default-twig}/en_US.php (100%) rename I18n/backOffice/{default => default-twig}/es_ES.php (100%) rename I18n/backOffice/{default => default-twig}/fr_FR.php (100%) rename I18n/backOffice/{default => default-twig}/it_IT.php (100%) create mode 100644 Service/BackOffice/MenuTargetCatalog.php rename templates/backOffice/{default => default-twig}/assets/css/styles.css (100%) rename templates/backOffice/{default => default-twig}/assets/js/main.js (94%) create mode 100644 templates/backOffice/default-twig/module-config.html.twig delete mode 100644 templates/backOffice/default/module-config.html diff --git a/Controller/MenuController.php b/Controller/MenuController.php index a504e8d..def7d4a 100644 --- a/Controller/MenuController.php +++ b/Controller/MenuController.php @@ -1,75 +1,119 @@ requestStack->getCurrentRequest()->getSession(); + if (null !== $response = $this->checkAuth(AdminResources::MODULE, 'CustomFrontMenu', AccessManager::UPDATE)) { + return $response; + } + + $this->getTokenProvider()->checkToken((string) $request->request->get('_token', '')); + + return null; + } + + private function backToScreen(): RedirectResponse + { + return new RedirectResponse(URL::getInstance()->absoluteUrl(self::COOKIE_PATH)); + } + + private function rememberMenu(int $menuId): void + { + setcookie(self::COOKIE_NAME, (string) $menuId, [ + 'path' => self::COOKIE_PATH, + 'httponly' => true, + 'samesite' => 'Lax', + ]); } /** * Load the menu selected by the user. - * @param Request $request The user request with the desired menu id - * @return RedirectResponse */ - #[Route("/admin/module/CustomFrontMenu/selectMenu", name: "admin.customfrontmenu.select.menu", methods: ["POST"])] - public function selectOtherMenu(Request $request) : RedirectResponse + #[Route('/admin/module/CustomFrontMenu/selectMenu', name: 'admin.customfrontmenu.select.menu', methods: ['POST'])] + public function selectOtherMenu(Request $request): Response { - $menuId = intval(str_replace("menu-selected-", "", $request->get('menuId'))); + if (null !== $denied = $this->denyUnlessAllowed($request)) { + return $denied; + } - setcookie('menuId', $menuId); + $this->rememberMenu((int) str_replace('menu-selected-', '', (string) $request->get('menuId'))); - return new RedirectResponse(URL::getInstance()->absoluteUrl('/admin/module/CustomFrontMenu')); + return $this->backToScreen(); } /** * Save the selected menu items in database. - * @param Request $request The user request with the menu items and the selected menu id - * @param CustomFrontMenuSaveService $customFrontMenuSave The saving service - * @param CustomFrontMenuService $customFrontMenuService + * * @throws PropelException - * @throws Exception */ - #[Route("/admin/module/CustomFrontMenu/save", name:"admin.customfrontmenu.save", methods:["POST"])] - public function saveMenuItems(Request $request, CustomFrontMenuSaveService $customFrontMenuSave, CustomFrontMenuService $customFrontMenuService) : RedirectResponse - { + #[Route('/admin/module/CustomFrontMenu/save', name: 'admin.customfrontmenu.save', methods: ['POST'])] + public function saveMenuItems( + Request $request, + CustomFrontMenuSaveService $customFrontMenuSave, + CustomFrontMenuService $customFrontMenuService, + ): Response { + if (null !== $denied = $this->denyUnlessAllowed($request)) { + return $denied; + } - $dataJson = $request->get('menuData'); - $newMenu = json_decode($dataJson, true); - $menuId = json_decode($request->get('menuDataId')); + $newMenu = json_decode((string) $request->get('menuData'), true); + $menuId = json_decode((string) $request->get('menuDataId')); + + if (!\is_array($newMenu)) { + throw new \InvalidArgumentException('Save failed: the menu payload is not a list of items'); + } - if (!$menuId || $menuId === 'undefined' || $menuId === 'null') { - throw new Exception('Save failed : the menu id cannot be null or empty'); + if (!\is_int($menuId) || 0 === $menuId) { + throw new \InvalidArgumentException('Save failed: the menu id cannot be null or empty'); } $menuToCheck = $customFrontMenuService->getMenu($menuId); - if (!$menuToCheck || $menuToCheck->getLevel() !== 1) { - throw new Exception('Save failed : the menu id is invalid'); + if (!$menuToCheck || 1 !== $menuToCheck->getLevel()) { + throw new \InvalidArgumentException('Save failed: the menu id is invalid'); } // Delete all the items currently in database for the menu to save @@ -78,105 +122,128 @@ public function saveMenuItems(Request $request, CustomFrontMenuSaveService $cust // Add all new items in database $customFrontMenuSave->saveTableBrowser($newMenu, $menu); - $this->getSession()->getFlashBag()->add('success', Translator::getInstance()->trans('This menu has been successfully saved !', [], CustomFrontMenu::DOMAIN_NAME)); + $this->getSession()->getFlashBag()->add( + 'success', + Translator::getInstance()->trans('This menu has been successfully saved !', [], CustomFrontMenu::DOMAIN_NAME), + ); - return new RedirectResponse(URL::getInstance()->absoluteUrl('/admin/module/CustomFrontMenu')); + return $this->backToScreen(); } /** - * Add a new menu with the name given by the user. - * The user is redirected in this new menu. - * @param Request $request The user request with the menu name - * @param CustomFrontMenuLoadService $customFrontMenuLoadService The loading service - * @param CustomFrontMenuService $customFrontMenuService The menu service - * @throws Exception + * Add a new menu with the name given by the user, and select it. + * + * @throws PropelException */ - #[Route("/admin/module/CustomFrontMenu/add", name: "admin.customfrontmenu.addmenu", methods: ["POST"])] - public function addMenu(Request $request, CustomFrontMenuLoadService $customFrontMenuLoadService, CustomFrontMenuService $customFrontMenuService) : RedirectResponse + #[Route('/admin/module/CustomFrontMenu/add', name: 'admin.customfrontmenu.addmenu', methods: ['POST'])] + public function addMenu(Request $request, CustomFrontMenuService $customFrontMenuService): Response { - $menuName = $request->get('menuName'); + if (null !== $denied = $this->denyUnlessAllowed($request)) { + return $denied; + } + $root = $customFrontMenuService->getRoot(); - $itemId = $customFrontMenuService->addMenu($root, $menuName); - $this->loadMenuItems($customFrontMenuLoadService, $customFrontMenuService, $itemId); - setcookie('menuId', $itemId); + $itemId = $customFrontMenuService->addMenu($root, (string) $request->get('menuName')); - $this->getSession()->getFlashBag()->add('success', Translator::getInstance()->trans('New menu added successfully', [], CustomFrontMenu::DOMAIN_NAME)); + $this->rememberMenu($itemId); - return new RedirectResponse(URL::getInstance()->absoluteUrl('/admin/module/CustomFrontMenu')); + $this->getSession()->getFlashBag()->add( + 'success', + Translator::getInstance()->trans('New menu added successfully', [], CustomFrontMenu::DOMAIN_NAME), + ); + + return $this->backToScreen(); } /** * Delete the current menu. - * The user is redirected in the first menu if it exists. - * @param Request $request The user request with the menu id - * @param CustomFrontMenuService $customFrontMenuService The menu service - * @throws Exception */ - #[Route("/admin/module/CustomFrontMenu/delete", name:"admin.customfrontmenu.deletemenu", methods:["POST"])] - public function deleteMenu(Request $request, CustomFrontMenuService $customFrontMenuService) : RedirectResponse + #[Route('/admin/module/CustomFrontMenu/delete', name: 'admin.customfrontmenu.deletemenu', methods: ['POST'])] + public function deleteMenu(Request $request, CustomFrontMenuService $customFrontMenuService): Response { - $firstCurrentMenuId = $request->get('menuId'); - if($firstCurrentMenuId === null || $firstCurrentMenuId === 'menu-selected-') { - throw new Exception('Delete failed : the menu id cannot be null or empty'); + if (null !== $denied = $this->denyUnlessAllowed($request)) { + return $denied; } - $currentMenuId = intval(str_replace("menu-selected-", "", $firstCurrentMenuId)); + $rawMenuId = (string) $request->get('menuId', ''); - $customFrontMenuService->deleteMenu($currentMenuId); + if ('' === $rawMenuId || 'menu-selected-' === $rawMenuId) { + throw new \InvalidArgumentException('Delete failed: the menu id cannot be null or empty'); + } - $this->getSession()->getFlashBag()->add('success', Translator::getInstance()->trans('Current menu deleted successfully', [], CustomFrontMenu::DOMAIN_NAME)); + $customFrontMenuService->deleteMenu((int) str_replace('menu-selected-', '', $rawMenuId)); - if (isset($_COOKIE['menuId'])) { - setcookie('menuId', -1); - } + $this->getSession()->getFlashBag()->add( + 'success', + Translator::getInstance()->trans('Current menu deleted successfully', [], CustomFrontMenu::DOMAIN_NAME), + ); - return new RedirectResponse(URL::getInstance()->absoluteUrl('/admin/module/CustomFrontMenu')); - } + $this->rememberMenu(-1); - /** - * Clear all flashes - */ - #[Route("/admin/module/CustomFrontMenu/clearFlashes", name:"admin.customfrontmenu.clearflashes", methods:["GET"])] - public function clearFlashes() : Response - { - $this->getSession()->getFlashBag()->clear(); - // Clear the response too to limit the data returned by http - return new Response('', ResponseAlias::HTTP_OK); + return $this->backToScreen(); } /** - * Load the menu items - * @param CustomFrontMenuLoadService $customFrontMenuLoadService The loading service - * @param CustomFrontMenuService $customFrontMenuService The menu service - * @param ?int $menuId The id of the menu to load - * @return array All the data necessary to load the page content : Menu names, menu items and the current menu id. + * Everything the composition screen needs to render. + * + * @return array + * * @throws PropelException */ - public function loadMenuItems(CustomFrontMenuLoadService $customFrontMenuLoadService, CustomFrontMenuService $customFrontMenuService, ?int $menuId = null) : array - { + public function loadMenuItems( + CustomFrontMenuLoadService $customFrontMenuLoadService, + CustomFrontMenuService $customFrontMenuService, + ?int $menuId = null, + ): array { $menuNames = $customFrontMenuLoadService->loadSelectMenu($customFrontMenuService->getRoot()); $data = []; - if (!$menuId && count($menuNames) > 0) { - $menuId = intval(str_replace("menu-selected-", "", $menuNames[0]['id'])); + if (!$menuId && \count($menuNames) > 0) { + $menuId = (int) str_replace('menu-selected-', '', $menuNames[0]['id']); } - if($menuId) { + if ($menuId) { $menu = $customFrontMenuService->getMenu($menuId); - if (!$menu || $menu->getLevel() !== 1) { - $this->getSession()->getFlashBag()->add('fail', Translator::getInstance()->trans('This menu does not exists', [], CustomFrontMenu::DOMAIN_NAME)); - $menuId = intval(str_replace("menu-selected-", "", $menuNames[0]['id'])); - setcookie('menuId', $menuId, ['path' => '/admin/module/CustomFrontMenu']); + + if (!$menu || 1 !== $menu->getLevel()) { + $this->getSession()->getFlashBag()->add( + 'fail', + Translator::getInstance()->trans('This menu does not exists', [], CustomFrontMenu::DOMAIN_NAME), + ); + + if (0 === \count($menuNames)) { + return $this->screenData($menuNames, [], 0); + } + + $menuId = (int) str_replace('menu-selected-', '', $menuNames[0]['id']); + $this->rememberMenu($menuId); $menu = $customFrontMenuService->getMenu($menuId); } - $data = $customFrontMenuLoadService->loadTableBrowser($menu); + if ($menu) { + $data = $customFrontMenuLoadService->loadTableBrowser($menu); + } } + return $this->screenData($menuNames, $data, (int) $menuId); + } + + /** + * @param array> $menuNames + * @param array $menuItems + * + * @return array + */ + private function screenData(array $menuNames, array $menuItems, int $menuId): array + { + $locale = $this->getSession()->getAdminLang()->getLocale(); + return [ 'menuNames' => json_encode($menuNames), - 'menuItems' => json_encode($data), - 'currentMenuId' => utf8_encode($menuId) + 'menuItems' => json_encode($menuItems), + 'currentMenuId' => $menuId, + 'locale' => $locale, + 'targets' => $this->targetCatalog->targets($locale), ]; } -} \ No newline at end of file +} diff --git a/CustomFrontMenu.php b/CustomFrontMenu.php index 2619046..6038fdc 100644 --- a/CustomFrontMenu.php +++ b/CustomFrontMenu.php @@ -1,4 +1,7 @@ name('*.sql') ->depth(0) ->sortByName() - ->in(__DIR__.DS.'Config'.DS.'update'); + ->in($updateDir); $database = new Database($con); @@ -69,7 +80,7 @@ public function destroy(ConnectionInterface $con = null, $deleteModuleData = fal public static function configureServices(ServicesConfigurator $servicesConfigurator): void { $servicesConfigurator->load(self::getModuleCode().'\\', __DIR__) - ->exclude([THELIA_MODULE_DIR . ucfirst(self::getModuleCode()). "/I18n/*"]) + ->exclude([__DIR__.'/I18n/*']) ->autowire(true) ->autoconfigure(true); } diff --git a/Hook/ConfigHook.php b/Hook/ConfigHook.php index af3d51d..7b31d24 100644 --- a/Hook/ConfigHook.php +++ b/Hook/ConfigHook.php @@ -1,5 +1,17 @@ [ - [ - "type" => "back", - "method" => "addMenuJs" - ] + 'module.config-js' => [ + ['type' => 'back', 'method' => 'addMenuJs'], + ], + 'main.head-css' => [ + ['type' => 'back', 'method' => 'addMenuCss'], ], - "main.head-css" => [ - [ - "type" => "back", - "method" => "addMenuCss" - ] + 'module.configuration' => [ + ['type' => 'back', 'method' => 'onModuleConfiguration'], ], - "module.configuration" => [ - [ - "type" => "back", - "method" => "onModuleConfiguration" - ] - ] ]; } - public function addMenuJs(HookRenderEvent $event):void + public function addMenuJs(HookRenderEvent $event): void { - $event->add($this->addJS("assets/js/main.js")); + $event->add($this->addJS('assets/js/main.js')); } - public function addMenuCss(HookRenderEvent $event):void + public function addMenuCss(HookRenderEvent $event): void { - $event->add($this->addCSS("assets/css/styles.css")); + $event->add($this->addCSS('assets/css/styles.css')); } /** * @throws PropelException */ - public function onModuleConfiguration(HookRenderEvent $event) : void + public function onModuleConfiguration(HookRenderEvent $event): void { - if (isset($_COOKIE['menuId']) && $_COOKIE['menuId'] != -1) { - $data = $this->menuController->loadMenuItems($this->customFrontMenuLoadService, $this->customFrontMenuService, $_COOKIE['menuId']); - } else { - $data = $this->menuController->loadMenuItems($this->customFrontMenuLoadService, $this->customFrontMenuService); + $event->add($this->render('module-config.html.twig', $this->menuController->loadMenuItems( + $this->customFrontMenuLoadService, + $this->customFrontMenuService, + $this->selectedMenuId(), + ))); + } + + /** + * The screen remembers the menu being composed in a cookie, so it survives a redirect + * after save. The value is client-controlled: anything but a positive integer means + * "no selection" and lets the screen fall back to the first menu. + */ + private function selectedMenuId(): ?int + { + $raw = $this->requestStack->getCurrentRequest()?->cookies->get('menuId'); + + if (!\is_string($raw) || 1 !== preg_match('/^\d+$/', $raw)) { + return null; } - $event->add($this->render("module-config.html", $data)); + $menuId = (int) $raw; + + return $menuId > 0 ? $menuId : null; } } diff --git a/I18n/backOffice/default/en_US.php b/I18n/backOffice/default-twig/en_US.php similarity index 100% rename from I18n/backOffice/default/en_US.php rename to I18n/backOffice/default-twig/en_US.php diff --git a/I18n/backOffice/default/es_ES.php b/I18n/backOffice/default-twig/es_ES.php similarity index 100% rename from I18n/backOffice/default/es_ES.php rename to I18n/backOffice/default-twig/es_ES.php diff --git a/I18n/backOffice/default/fr_FR.php b/I18n/backOffice/default-twig/fr_FR.php similarity index 100% rename from I18n/backOffice/default/fr_FR.php rename to I18n/backOffice/default-twig/fr_FR.php diff --git a/I18n/backOffice/default/it_IT.php b/I18n/backOffice/default-twig/it_IT.php similarity index 100% rename from I18n/backOffice/default/it_IT.php rename to I18n/backOffice/default-twig/it_IT.php diff --git a/Service/BackOffice/MenuTargetCatalog.php b/Service/BackOffice/MenuTargetCatalog.php new file mode 100644 index 0000000..d19dddd --- /dev/null +++ b/Service/BackOffice/MenuTargetCatalog.php @@ -0,0 +1,81 @@ + tag per row, so a shop with + * ten thousand products shipped ten thousand script tags. This runs the same five queries + * once and hands the screen a single payload to put in a data- attribute. + */ +final readonly class MenuTargetCatalog +{ + private const FALLBACK_LOCALE = 'en_US'; + + /** + * @return array>> + */ + public function targets(?string $locale = null): array + { + $locale ??= self::FALLBACK_LOCALE; + + return [ + 'brand' => $this->rows(BrandQuery::create(), $locale), + 'category' => $this->rows(CategoryQuery::create(), $locale), + 'content' => $this->rows(ContentQuery::create(), $locale), + 'folder' => $this->rows(FolderQuery::create(), $locale), + 'product' => $this->rows(ProductQuery::create(), $locale, withReference: true), + ]; + } + + /** + * @return list> + */ + private function rows(ModelCriteria $query, string $locale, bool $withReference = false): array + { + // LEFT_JOIN, not the default inner join: an item with no translation in this + // locale must still be pickable, titleless rather than absent. + $results = $query + ->joinWithI18n($locale, Criteria::LEFT_JOIN) + ->orderById() + ->find(); + + $rows = []; + + foreach ($results as $result) { + $row = [ + 'id' => (int) $result->getId(), + 'title' => (string) $result->getTitle(), + ]; + + if ($withReference) { + $row['reference'] = (string) $result->getRef(); + } + + $rows[] = $row; + } + + return $rows; + } +} diff --git a/templates/backOffice/default/assets/css/styles.css b/templates/backOffice/default-twig/assets/css/styles.css similarity index 100% rename from templates/backOffice/default/assets/css/styles.css rename to templates/backOffice/default-twig/assets/css/styles.css diff --git a/templates/backOffice/default/assets/js/main.js b/templates/backOffice/default-twig/assets/js/main.js similarity index 94% rename from templates/backOffice/default/assets/js/main.js rename to templates/backOffice/default-twig/assets/js/main.js index 75e776c..78ff569 100644 --- a/templates/backOffice/default/assets/js/main.js +++ b/templates/backOffice/default-twig/assets/js/main.js @@ -1,14 +1,14 @@ +// The screen hands its payload over in data- attributes on #cfm-screen: the catalogue +// of pickable targets, the menus, the current selection, the locale and the JS strings. +const CFM_SCREEN = document.getElementById('cfm-screen') + var MENU_NAMES var MENU_LIST -var CURRENT_SELECTED_MENU_ID -var LOCALE -var loopsDictionary = { - "brand": brandLoopData, - "category": categoryLoopData, - "content": contentLoopData, - "folder": folderLoopData, - "product": productLoopData -}; +var CURRENT_SELECTED_MENU_ID = parseInt(CFM_SCREEN.dataset.cfmCurrentMenuId, 10) +var LOCALE = CFM_SCREEN.dataset.cfmLocale +var loopsDictionary = JSON.parse(CFM_SCREEN.dataset.cfmTargets) +var translations = JSON.parse(CFM_SCREEN.dataset.cfmTranslations) +var buttonState = 'hide' let CURRENT_ID = null let allowUnload = false let selectedLanguage @@ -51,8 +51,7 @@ function getValueByLocaleOf(element, locale) { function closeClosestModal(element) { let modal = element.closest('.modal'); if (modal) { - let modalId = modal.getAttribute('id'); - $(`#${modalId}`).modal('hide'); + bootstrap.Modal.getOrCreateInstance(modal).hide(); } } // End close closest modal @@ -163,7 +162,7 @@ function addMenu() { errorMessageEmpty.style.display = 'none'; errorMessageBackQuote.style.display = 'block'; } else { - $('#ConfirmAddMenu').modal('hide'); + bootstrap.Modal.getOrCreateInstance(document.getElementById('ConfirmAddMenu')).hide(); errorMessageEmpty.style.display = 'none'; errorMessageBackQuote.style.display = 'none'; document.getElementById('addMenuForm').submit(); @@ -685,19 +684,19 @@ function generateMenuRecursive(menuItem) { ` + getValueByLocaleOf(menuItem.title) + `` + arrowSpan + `
    - - + + - - + + - - + +
    - - + +
      @@ -1205,38 +1204,6 @@ function resetTargetField(select) { } // End search product -// Flashes - -// Function to remove flash messages from the DOM -function removeFlashMessages() { - const flashMessages = document.getElementsByClassName('alert-flash-to-delete') - Array.from(flashMessages).forEach(function (message) { - message.remove() - }); -} - -// Function to notify server to clear flash messages -function clearFlashMessagesOnServer() { - let xhr = new XMLHttpRequest() - xhr.open('GET', '/admin/module/CustomFrontMenu/clearFlashes', true) - - xhr.onreadystatechange = function () { - if (xhr.readyState === 4) { - if (xhr.status !== 200) { - console.error('Network response was not ok:', xhr.statusText) - } - } - }; - - xhr.onerror = function () { - console.error('Error:', xhr.statusText); - } - - xhr.send() -} - -// End flashes - // Event Listener window.addEventListener('beforeunload', function(event) { if (!allowUnload) { @@ -1256,8 +1223,8 @@ document.getElementById('selectMenuName').addEventListener('change', function() window.onload = function() { // Get data - MENU_NAMES = getFromJson(menuNames) - MENU_LIST = getFromJson(menuItems) + MENU_NAMES = getFromJson(CFM_SCREEN.dataset.cfmMenuNames) + MENU_LIST = getFromJson(CFM_SCREEN.dataset.cfmMenuItems) replaceAllQuotesAndPercent(MENU_LIST) for (let menu of MENU_NAMES){ menu.title = putQuoteAndPercent(menu.title) @@ -1277,14 +1244,6 @@ window.onload = function() { }) } - // Manage flashes - if (document.getElementsByClassName('alert-flash-to-delete').length > 0) { - clearFlashMessagesOnServer() - document.addEventListener('click', function() { - removeFlashMessages() - }) - } - addOptionsOfSelectedCategory(); } // End Initialization \ No newline at end of file diff --git a/templates/backOffice/default-twig/module-config.html.twig b/templates/backOffice/default-twig/module-config.html.twig new file mode 100644 index 0000000..e4cf8c3 --- /dev/null +++ b/templates/backOffice/default-twig/module-config.html.twig @@ -0,0 +1,325 @@ +{# + Menu composition screen, rendered by ConfigHook on the module.configuration hook. + + The catalogue of pickable targets travels in one data- attribute rather than the five + {loop} blocks of the Smarty screen, which emitted one - - - - -{loop type="brand" name="brand_loop"} - -{/loop} - -{loop type="category" name="category_loop"} - -{/loop} - -{loop type="content" name="content_loop"} - -{/loop} - -{loop type="folder" name="folder_loop"} - -{/loop} - -{loop type="product" name="product_loop"} - -{/loop} - - - -
      -
      - - - - -
      - - {if isset($smarty.session["_symfony_flashes"]["success"])} - {foreach $smarty.session["_symfony_flashes"]["success"] as $message} -
      - {$message} -
      - {/foreach} - {/if} - {if isset($smarty.session["_symfony_flashes"]["warning"])} - {foreach $smarty.session["_symfony_flashes"]["warning"] as $message} -
      - {$message} -
      - {/foreach} - {/if} - {if isset($smarty.session["_symfony_flashes"]["fail"])} - {foreach $smarty.session["_symfony_flashes"]["fail"] as $message} -
      - {$message} -
      - {/foreach} - {/if} - -
      -

      {intl l="Preview menu" d="customfrontmenu.bo.default"}

      - - -
      - - -
      - - -
      - -
      -
      - -
      - - -
      - -
      - - -
      -
      - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file From d46a19c743f268d0a2e035bb8edb3d4bd171609b Mon Sep 17 00:00:00 2001 From: Robin Morel Date: Thu, 10 Sep 2026 16:19:06 +0200 Subject: [PATCH 04/19] feat(api): expose the menu tree as a read-only API Platform resource --- Api/Resource/CustomFrontMenu.php | 51 +++++ Api/State/CustomFrontMenuProvider.php | 59 ++++++ .../Front/CustomFrontMenuAPIController.php | 55 ------ README.md | 14 ++ Service/CustomFrontMenuLoadService.php | 96 +--------- Service/Front/MenuTreeResolver.php | 174 ++++++++++++++++++ Twig/CustomFrontMenuExtension.php | 14 +- templates/front/menu.html.twig | 4 +- 8 files changed, 306 insertions(+), 161 deletions(-) create mode 100644 Api/Resource/CustomFrontMenu.php create mode 100644 Api/State/CustomFrontMenuProvider.php delete mode 100644 Controller/Front/CustomFrontMenuAPIController.php create mode 100644 Service/Front/MenuTreeResolver.php diff --git a/Api/Resource/CustomFrontMenu.php b/Api/Resource/CustomFrontMenu.php new file mode 100644 index 0000000..bd5f207 --- /dev/null +++ b/Api/Resource/CustomFrontMenu.php @@ -0,0 +1,51 @@ + [self::GROUP_FRONT_READ]], + provider: CustomFrontMenuProvider::class, + ), + ], +)] +class CustomFrontMenu +{ + public const GROUP_FRONT_READ = 'custom_front_menu:front:read'; + + #[Groups([self::GROUP_FRONT_READ])] + public int $id = 0; + + /** + * Nodes of {id, title, href, children}, children nested to any depth. + * + * @var list> + */ + #[Groups([self::GROUP_FRONT_READ])] + public array $items = []; +} diff --git a/Api/State/CustomFrontMenuProvider.php b/Api/State/CustomFrontMenuProvider.php new file mode 100644 index 0000000..08c29b5 --- /dev/null +++ b/Api/State/CustomFrontMenuProvider.php @@ -0,0 +1,59 @@ + + */ +final readonly class CustomFrontMenuProvider implements ProviderInterface +{ + public function __construct( + private MenuTreeResolver $treeResolver, + private LangService $langService, + ) { + } + + /** + * @param array $uriVariables + * @param array $context + */ + public function provide(Operation $operation, array $uriVariables = [], array $context = []): ?CustomFrontMenu + { + $menuId = (int) ($uriVariables['id'] ?? 0); + + if ($menuId <= 0) { + throw new NotFoundHttpException('Menu not found'); + } + + $items = $this->treeResolver->resolve($menuId, $this->langService->getLocale() ?? 'en_US'); + + if (null === $items) { + throw new NotFoundHttpException('Menu not found'); + } + + $menu = new CustomFrontMenu(); + $menu->id = $menuId; + $menu->items = $items; + + return $menu; + } +} diff --git a/Controller/Front/CustomFrontMenuAPIController.php b/Controller/Front/CustomFrontMenuAPIController.php deleted file mode 100644 index 861e26a..0000000 --- a/Controller/Front/CustomFrontMenuAPIController.php +++ /dev/null @@ -1,55 +0,0 @@ -loadTableBrowser($customFornMenuService->getMenu($id)); - if ($menu === null) { - return OpenApiService::jsonResponse('Menu not found', Response::HTTP_NOT_FOUND); - } - if (count($menu) === 0) { - return OpenApiService::jsonResponse('Menu has no children', Response::HTTP_NO_CONTENT); - } - return OpenApiService::jsonResponse($menu, Response::HTTP_OK); - } -} \ No newline at end of file diff --git a/README.md b/README.md index 1e9fc2f..3283ec2 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,20 @@ The visitor's locale is used by default. Pass a second argument to force one: {{ custom_front_menu(388, 'fr_FR') }} ``` +Entries whose target is deleted or unpublished are dropped from the rendered menu. + +## API + +The composed tree is also readable over HTTP, read-only: + +``` +GET /api/front/custom-front-menus/{id} +``` + +It answers `{id, items}`, each item being `{id, title, href, children}`. It replaces the +`open_api/custom-front-menu/{id}` endpoint of the 1.x line, which relied on the OpenApi +module that Thelia 3 no longer ships. + _________________ ## Version française diff --git a/Service/CustomFrontMenuLoadService.php b/Service/CustomFrontMenuLoadService.php index 67e1942..f4e381b 100644 --- a/Service/CustomFrontMenuLoadService.php +++ b/Service/CustomFrontMenuLoadService.php @@ -7,7 +7,6 @@ use CustomFrontMenu\Model\CustomFrontMenuItem; use CustomFrontMenu\Model\CustomFrontMenuItemI18nQuery; use Exception; -use Propel\Runtime\Propel; use Symfony\Component\HttpFoundation\RequestStack; use Propel\Runtime\Exception\PropelException; use Thelia\Core\HttpFoundation\Session\Session; @@ -47,36 +46,6 @@ public function loadSelectMenu(CustomFrontMenuItem $root) : array return $dataArray; } - /** - * Public URL of a menu target, in the given locale. - * - * getUrl() goes through URL::retrieve(), which returns the rewritten URL when the - * target has one and falls back to the ?view=&{view}_id= form when it has not, so - * the menu links match what the rest of the front links to. - * - * @throws PropelException - */ - public function resolvePublicUrl(string $view, int $viewId, string $locale): ?string - { - $queryClass = match (strtolower($view)) { - 'brand' => BrandQuery::class, - 'category' => CategoryQuery::class, - 'content' => ContentQuery::class, - 'folder' => FolderQuery::class, - 'product' => ProductQuery::class, - default => null, - }; - - if (null === $queryClass) { - return null; - } - - $target = $queryClass::create()->findPk($viewId); - - // Target deleted since the menu was composed: no link rather than a broken one. - return $target?->getUrl($locale); - } - /** * Load all elements from the database recursively to parse them in an array * @param CustomFrontMenuItem $parent @@ -168,67 +137,4 @@ public function loadTableBrowser(CustomFrontMenuItem $parent) : array return $dataArray; } - /** - * Load all elements from the database recursively to parse them in an array with a lang - * @param CustomFrontMenuItem $parent - * @param string $lang - * @return array All the descendants items of the menu root given in parameter - * @throws PropelException - */ - public function loadTableBrowserLang(CustomFrontMenuItem $parent, string $lang) : array - { - $dataArray = []; - $descendants = $parent->getChildren(); - foreach ($descendants as $descendant) { - $newArray = []; - $I18nMenus = CustomFrontMenuItemI18nQuery::create()->findById($descendant->getId()); - - if (count($I18nMenus) <= 0){ - throw new PropelException('No content found for the given id:' . $descendant->getId()); - } - - $found = false; - $title = ''; - $url = ''; - foreach ($I18nMenus as $I18nMenu) { - if ($I18nMenu->getLocale() === $lang) { - $title = $I18nMenu->getTitle(); - $url = $I18nMenu->getUrl(); - $found = true; - break; - } - elseif ($I18nMenu->getLocale() === 'en_US') { - $title = $I18nMenu->getTitle(); - $url = $I18nMenu->getUrl(); - } - } - - if (!$found) { - $title = $I18nMenus->getColumnValues('title')[0]; - $url = $I18nMenus->getColumnValues('url')[0]; - } - - $newArray['title'] = $title; - $newArray['url'] = $url; - - if (Validator::viewIsValid($descendant->getView())) { - $view = $descendant->getView(); - $viewId = $descendant->getViewId(); - if ($view && $viewId) { - $newArray['url'] = $this->resolvePublicUrl($view, (int) $viewId, $lang) ?? ''; - } - } - - $newArray['depth'] = $descendant->getLevel() - 2; - $newArray['id'] = $this - ->COUNT_ID; - ++$this->COUNT_ID; - - if ($descendant->hasChildren()) { - $newArray['children'] = $this->loadTableBrowserLang($descendant, $lang); - } - $dataArray[] = $newArray; - } - return $dataArray; - } -} \ No newline at end of file +} diff --git a/Service/Front/MenuTreeResolver.php b/Service/Front/MenuTreeResolver.php new file mode 100644 index 0000000..3eb3ae2 --- /dev/null +++ b/Service/Front/MenuTreeResolver.php @@ -0,0 +1,174 @@ + BrandQuery::class, + 'category' => CategoryQuery::class, + 'content' => ContentQuery::class, + 'folder' => FolderQuery::class, + 'product' => ProductQuery::class, + ]; + + /** + * @return list>|null null when no such menu exists + * + * @throws PropelException + */ + public function resolve(int $menuId, string $locale): ?array + { + $menu = CustomFrontMenuItemQuery::create()->findOneById($menuId); + + if (null === $menu) { + return null; + } + + return $this->branch($menu, $locale); + } + + /** + * @return list> + * + * @throws PropelException + */ + private function branch(CustomFrontMenuItem $parent, string $locale): array + { + $nodes = []; + + foreach ($parent->getChildren() as $child) { + $node = $this->node($child, $locale); + + if (null === $node) { + continue; + } + + $node['children'] = $child->hasChildren() ? $this->branch($child, $locale) : []; + $nodes[] = $node; + } + + return $nodes; + } + + /** + * @return array|null null when the entry must not be rendered + * + * @throws PropelException + */ + private function node(CustomFrontMenuItem $item, string $locale): ?array + { + $view = strtolower((string) $item->getView()); + $viewId = (int) $item->getViewId(); + + // A typed entry stands or falls with its target; a free URL or an untargeted + // label has nothing to check. + if (isset(self::TARGET_QUERIES[$view]) && $viewId > 0) { + $href = $this->publishedTargetUrl($view, $viewId, $locale); + + if (null === $href) { + return null; + } + + return [ + 'id' => (int) $item->getId(), + 'title' => $this->title($item, $locale), + 'href' => $href, + ]; + } + + return [ + 'id' => (int) $item->getId(), + 'title' => $this->title($item, $locale), + 'href' => $this->freeUrl($item, $locale), + ]; + } + + /** + * @throws PropelException + */ + private function publishedTargetUrl(string $view, int $viewId, string $locale): ?string + { + $queryClass = self::TARGET_QUERIES[$view]; + + $target = $queryClass::create() + ->filterByVisible(1) + ->findPk($viewId); + + return $target?->getUrl($locale); + } + + /** + * @throws PropelException + */ + private function title(CustomFrontMenuItem $item, string $locale): string + { + return $this->i18nValue($item, $locale, 'title'); + } + + /** + * @throws PropelException + */ + private function freeUrl(CustomFrontMenuItem $item, string $locale): string + { + return $this->i18nValue($item, $locale, 'url'); + } + + /** + * Locale, then en_US, then whatever exists: an entry with no translation in the + * visitor's language still has to render. + * + * @throws PropelException + */ + private function i18nValue(CustomFrontMenuItem $item, string $locale, string $column): string + { + $translations = CustomFrontMenuItemI18nQuery::create()->findById($item->getId()); + + $fallback = ''; + + foreach ($translations as $translation) { + $value = (string) ('title' === $column ? $translation->getTitle() : $translation->getUrl()); + + if ($translation->getLocale() === $locale) { + return $value; + } + + if ('' === $fallback || 'en_US' === $translation->getLocale()) { + $fallback = $value; + } + } + + return $fallback; + } +} diff --git a/Twig/CustomFrontMenuExtension.php b/Twig/CustomFrontMenuExtension.php index a812a0d..b0c3834 100644 --- a/Twig/CustomFrontMenuExtension.php +++ b/Twig/CustomFrontMenuExtension.php @@ -15,8 +15,7 @@ namespace CustomFrontMenu\Twig; -use CustomFrontMenu\Service\CustomFrontMenuLoadService; -use CustomFrontMenu\Service\CustomFrontMenuService; +use CustomFrontMenu\Service\Front\MenuTreeResolver; use Symfony\Component\HttpFoundation\RequestStack; use Thelia\Core\HttpFoundation\Session\Session; use Twig\Environment; @@ -34,8 +33,7 @@ final class CustomFrontMenuExtension extends AbstractExtension private const TEMPLATE = '@CustomFrontMenuModule/front/menu.html.twig'; public function __construct( - private readonly CustomFrontMenuService $menuService, - private readonly CustomFrontMenuLoadService $loadService, + private readonly MenuTreeResolver $treeResolver, private readonly RequestStack $requestStack, ) { } @@ -53,17 +51,15 @@ public function getFunctions(): array public function render(Environment $twig, int $menuId, ?string $locale = null): string { - $menu = $this->menuService->getMenu($menuId); + $menuItems = $this->treeResolver->resolve($menuId, $locale ?? $this->locale()); // A theme asking for a menu that no longer exists gets nothing, not an // exception: a deleted menu must not take the whole page down. - if (null === $menu) { + if (null === $menuItems) { return ''; } - return $twig->render(self::TEMPLATE, [ - 'menuItems' => $this->loadService->loadTableBrowserLang($menu, $locale ?? $this->locale()), - ]); + return $twig->render(self::TEMPLATE, ['menuItems' => $menuItems]); } private function locale(): string diff --git a/templates/front/menu.html.twig b/templates/front/menu.html.twig index bf002b4..7244061 100644 --- a/templates/front/menu.html.twig +++ b/templates/front/menu.html.twig @@ -5,8 +5,8 @@ {% macro items(menuItems) %} {% for item in menuItems %}
    • - {% if item.url is defined and item.url is not empty %} - {{ item.title }} + {% if item.href is defined and item.href is not empty %} + {{ item.title }} {% else %} {{ item.title }} {% endif %} From afb816b86c45d5bd3ce72492ead4d2ffffa5a407 Mon Sep 17 00:00:00 2001 From: Robin Morel Date: Thu, 10 Sep 2026 16:20:53 +0200 Subject: [PATCH 05/19] chore: drop the empty deprecated routing.xml --- Config/routing.xml | 6 ------ 1 file changed, 6 deletions(-) delete mode 100644 Config/routing.xml diff --git a/Config/routing.xml b/Config/routing.xml deleted file mode 100644 index b2ce795..0000000 --- a/Config/routing.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - From 9e22e74985ac77203e7cdc24e39e468fa5a76378 Mon Sep 17 00:00:00 2001 From: Robin Morel Date: Thu, 10 Sep 2026 16:28:42 +0200 Subject: [PATCH 06/19] fix(model): pass null, not an empty string, to the nullable view_id setter --- Service/CustomFrontMenuSaveService.php | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Service/CustomFrontMenuSaveService.php b/Service/CustomFrontMenuSaveService.php index 683c0c5..091071c 100644 --- a/Service/CustomFrontMenuSaveService.php +++ b/Service/CustomFrontMenuSaveService.php @@ -1,5 +1,7 @@ save(); } else { $item->setView('Empty') - ->setViewId('') + ->setViewId(null) ->save(); } @@ -112,7 +114,7 @@ public function saveTableBrowser(array $dataArray, CustomFrontMenuItem $parent) } if (!$found) { $item->setView('Empty') - ->setViewId('') + ->setViewId(null) ->save(); } } From 65e98516ab2efe8c3b2dbaf81e090722503632cd Mon Sep 17 00:00:00 2001 From: Robin Morel Date: Thu, 10 Sep 2026 16:29:16 +0200 Subject: [PATCH 07/19] docs: drop the OpenApi module prerequisite --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3283ec2..b2e4d36 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,8 @@ This module lets you create dynamic menus. ### Prerequisites -The OpenApi module must be activated to enable CustomFrontMenu. +Thelia 3.0 or later. The menu API is served by the core API Platform stack: no +additional module is required. ### Manually @@ -74,7 +75,8 @@ Ce module vous permet de créer des menus dynamiques. ### Prérequis -Le module OpenApi doit être activé pour utiliser CustomFrontMenu. +Thelia 3.0 ou supérieur. L'API du menu est servie par API Platform, fourni par le +cœur : aucun module supplémentaire n'est requis. ### Manuellement From a97630a17e666110bfa3e53ffe4fc46bbf1d6e8b Mon Sep 17 00:00:00 2001 From: Robin Morel Date: Thu, 10 Sep 2026 16:32:16 +0200 Subject: [PATCH 08/19] fix: resolve every static analysis finding reported at level 5 --- Api/State/CustomFrontMenuProvider.php | 2 +- Controller/MenuController.php | 23 ++++++++++++++++++----- CustomFrontMenu.php | 5 ++--- Service/BackOffice/MenuTargetCatalog.php | 2 ++ Service/CustomFrontMenuLoadService.php | 11 ++++++++--- Service/CustomFrontMenuService.php | 8 +++++++- Service/Validator.php | 12 ++++++------ 7 files changed, 44 insertions(+), 19 deletions(-) diff --git a/Api/State/CustomFrontMenuProvider.php b/Api/State/CustomFrontMenuProvider.php index 08c29b5..29cdc70 100644 --- a/Api/State/CustomFrontMenuProvider.php +++ b/Api/State/CustomFrontMenuProvider.php @@ -36,7 +36,7 @@ public function __construct( * @param array $uriVariables * @param array $context */ - public function provide(Operation $operation, array $uriVariables = [], array $context = []): ?CustomFrontMenu + public function provide(Operation $operation, array $uriVariables = [], array $context = []): CustomFrontMenu { $menuId = (int) ($uriVariables['id'] ?? 0); diff --git a/Controller/MenuController.php b/Controller/MenuController.php index def7d4a..5ef208a 100644 --- a/Controller/MenuController.php +++ b/Controller/MenuController.php @@ -25,6 +25,7 @@ use Symfony\Component\Routing\Attribute\Route; use Thelia\Controller\Admin\BaseAdminController; use Thelia\Core\HttpFoundation\Request; +use Thelia\Core\HttpFoundation\Session\Session; use Thelia\Core\Security\AccessManager; use Thelia\Core\Security\Resource\AdminResources; use Thelia\Core\Translation\Translator; @@ -40,6 +41,18 @@ public function __construct( ) { } + /** + * BaseController types getSession() as SessionInterface, but flashes and the admin + * language live on the Thelia session. + */ + private function theliaSession(): Session + { + /** @var Session $session */ + $session = $this->getSession(); + + return $session; + } + /** * Composing a menu is an administration operation: it needs the module resource, * and each POST carries the one-shot token. @@ -122,7 +135,7 @@ public function saveMenuItems( // Add all new items in database $customFrontMenuSave->saveTableBrowser($newMenu, $menu); - $this->getSession()->getFlashBag()->add( + $this->theliaSession()->getFlashBag()->add( 'success', Translator::getInstance()->trans('This menu has been successfully saved !', [], CustomFrontMenu::DOMAIN_NAME), ); @@ -147,7 +160,7 @@ public function addMenu(Request $request, CustomFrontMenuService $customFrontMen $this->rememberMenu($itemId); - $this->getSession()->getFlashBag()->add( + $this->theliaSession()->getFlashBag()->add( 'success', Translator::getInstance()->trans('New menu added successfully', [], CustomFrontMenu::DOMAIN_NAME), ); @@ -173,7 +186,7 @@ public function deleteMenu(Request $request, CustomFrontMenuService $customFront $customFrontMenuService->deleteMenu((int) str_replace('menu-selected-', '', $rawMenuId)); - $this->getSession()->getFlashBag()->add( + $this->theliaSession()->getFlashBag()->add( 'success', Translator::getInstance()->trans('Current menu deleted successfully', [], CustomFrontMenu::DOMAIN_NAME), ); @@ -206,7 +219,7 @@ public function loadMenuItems( $menu = $customFrontMenuService->getMenu($menuId); if (!$menu || 1 !== $menu->getLevel()) { - $this->getSession()->getFlashBag()->add( + $this->theliaSession()->getFlashBag()->add( 'fail', Translator::getInstance()->trans('This menu does not exists', [], CustomFrontMenu::DOMAIN_NAME), ); @@ -236,7 +249,7 @@ public function loadMenuItems( */ private function screenData(array $menuNames, array $menuItems, int $menuId): array { - $locale = $this->getSession()->getAdminLang()->getLocale(); + $locale = $this->theliaSession()->getAdminLang()->getLocale(); return [ 'menuNames' => json_encode($menuNames), diff --git a/CustomFrontMenu.php b/CustomFrontMenu.php index 6038fdc..e9c6e4b 100644 --- a/CustomFrontMenu.php +++ b/CustomFrontMenu.php @@ -32,12 +32,12 @@ class CustomFrontMenu extends BaseModule */ public function preActivation(ConnectionInterface $con = null): bool { - if (!self::getConfigValue('is_initialized', false)) { + if (!self::getConfigValue('is_initialized')) { $database = new Database($con); $database->insertSql(null, [__DIR__.'/Config/TheliaMain.sql']); - self::setConfigValue('is_initialized', true); + self::setConfigValue('is_initialized', '1'); } return true; @@ -61,7 +61,6 @@ public function update($currentVersion, $newVersion, ConnectionInterface $con = $database = new Database($con); - /** @var \SplFileInfo $file */ foreach ($finder as $file) { if (version_compare($currentVersion, $file->getBasename('.sql'), '<')) { $database->insertSql(null, [$file->getPathname()]); diff --git a/Service/BackOffice/MenuTargetCatalog.php b/Service/BackOffice/MenuTargetCatalog.php index d19dddd..4066d78 100644 --- a/Service/BackOffice/MenuTargetCatalog.php +++ b/Service/BackOffice/MenuTargetCatalog.php @@ -50,6 +50,8 @@ public function targets(?string $locale = null): array } /** + * @param BrandQuery|CategoryQuery|ContentQuery|FolderQuery|ProductQuery $query + * * @return list> */ private function rows(ModelCriteria $query, string $locale, bool $withReference = false): array diff --git a/Service/CustomFrontMenuLoadService.php b/Service/CustomFrontMenuLoadService.php index f4e381b..45e2f1d 100644 --- a/Service/CustomFrontMenuLoadService.php +++ b/Service/CustomFrontMenuLoadService.php @@ -8,6 +8,7 @@ use CustomFrontMenu\Model\CustomFrontMenuItemI18nQuery; use Exception; use Symfony\Component\HttpFoundation\RequestStack; +use Propel\Runtime\Collection\ObjectCollection; use Propel\Runtime\Exception\PropelException; use Thelia\Core\HttpFoundation\Session\Session; use Thelia\Model\BrandQuery; @@ -85,7 +86,8 @@ public function loadTableBrowser(CustomFrontMenuItem $parent) : array $viewId = $descendant->getViewId(); - if($view && $viewId && Validator::viewIsValid($view)) { + // $view is never empty here: it defaults to 'url' just above. + if($viewId && Validator::viewIsValid($view)) { $formatedView = ucfirst($view); $class = 'Thelia\Model\\' . $formatedView . 'Query'; @@ -95,17 +97,20 @@ public function loadTableBrowser(CustomFrontMenuItem $parent) : array /** @var CategoryQuery|ProductQuery|FolderQuery|ContentQuery|BrandQuery $objectQuery */ $objectQuery = $class::create(); + /** @var ObjectCollection $query */ $query = $objectQuery ->filterById($viewId) ->joinWith($formatedView.'I18n') ->find(); - $queryI18n = $query->getColumnValues($formatedView.'I18ns')[0]; - + // Emptiness first: reading the translations of a missing row raised an + // index error before this check could report the real problem. if ($query->isEmpty()) { throw new Exception("No results found for the specified id $viewId."); } + $queryI18n = $query->getColumnValues($formatedView.'I18ns')[0]; + $title = null; foreach ($queryI18n as $item) { if ($item->getLocale() === $session->getAdminLang()->getLocale()) { diff --git a/Service/CustomFrontMenuService.php b/Service/CustomFrontMenuService.php index 14bb303..35c8d53 100644 --- a/Service/CustomFrontMenuService.php +++ b/Service/CustomFrontMenuService.php @@ -1,9 +1,12 @@ requestStack->getCurrentRequest()->getSession(); + $item = new CustomFrontMenuItem(); $item->insertAsLastChildOf($root); $item->save(); $content = new CustomFrontMenuItemI18n(); - $content->setTitle(Validator::completeValidation($menuName, $this->requestStack->getCurrentRequest()->getSession())); + $content->setTitle(Validator::completeValidation($menuName, $session)); $content->setId($item->getId()); $content->setLocale('en_US'); $content->save(); diff --git a/Service/Validator.php b/Service/Validator.php index c68f0a4..a8ec529 100644 --- a/Service/Validator.php +++ b/Service/Validator.php @@ -3,14 +3,14 @@ namespace CustomFrontMenu\Service; use Exception; -use Symfony\Component\HttpFoundation\Session\SessionInterface; +use Thelia\Core\HttpFoundation\Session\Session; class Validator { /** * Manage the problems with empty fields or back quotes presence */ - public static function stringValidation(string $string, SessionInterface $session) : string + public static function stringValidation(string $string, Session $session) : string { $string = trim($string); if (strlen($string) === 0) { @@ -23,7 +23,7 @@ public static function stringValidation(string $string, SessionInterface $sessio /** * Replace back quotes with simple quotes and add a warning flash message. */ - public static function backQuoteProhibited(string $string, SessionInterface $session) : string + public static function backQuoteProhibited(string $string, Session $session) : string { $string = trim($string); if (str_contains($string, '`')) { @@ -33,7 +33,7 @@ public static function backQuoteProhibited(string $string, SessionInterface $ses return $string; } - public static function htmlSafeValidation(string $string, SessionInterface $session, bool $canBeEmpty = true) : string + public static function htmlSafeValidation(string $string, Session $session, bool $canBeEmpty = true) : string { $string = trim($string); @@ -46,7 +46,7 @@ public static function htmlSafeValidation(string $string, SessionInterface $sess return $string; } - public static function sqlSafeValidation(string $string, SessionInterface $session, bool $canBeEmpty = true) : string + public static function sqlSafeValidation(string $string, Session $session, bool $canBeEmpty = true) : string { $string = trim($string); @@ -68,7 +68,7 @@ public static function filterValidation(string $string, int $filter): string /** * Check the empty space, back quote, html and sql constraints */ - public static function completeValidation(string $string, SessionInterface $session) : string + public static function completeValidation(string $string, Session $session) : string { $string = self::stringValidation($string, $session); $string = self::htmlSafeValidation($string, $session); From 9065d36cc2c8939aae1db4c5208a92b3ed4cd0ab Mon Sep 17 00:00:00 2001 From: Robin Morel Date: Thu, 10 Sep 2026 17:08:03 +0200 Subject: [PATCH 09/19] feat(back-office): rebuild the composition screen on the theme's tree component --- Controller/MenuController.php | 532 +++++-- Hook/ConfigHook.php | 53 +- I18n/backOffice/default-twig/en_US.php | 5 + I18n/backOffice/default-twig/fr_FR.php | 77 +- I18n/fr_FR.php | 24 +- Service/BackOffice/MenuComposer.php | 231 +++ Service/BackOffice/MenuTreePresenter.php | 171 +++ Service/CustomFrontMenuLoadService.php | 145 -- Service/CustomFrontMenuSaveService.php | 137 -- Service/CustomFrontMenuService.php | 69 - Service/FilterType.php | 9 - Service/Front/MenuTreeResolver.php | 23 +- Service/Validator.php | 109 -- .../default-twig/assets/css/styles.css | 302 ---- .../backOffice/default-twig/assets/js/main.js | 1249 ----------------- .../custom-front-menu/_target_field.html.twig | 34 + .../custom-front-menu/_tree_nodes.html.twig | 71 + .../custom-front-menu/entry.html.twig | 76 + .../custom-front-menu/tree.html.twig | 89 ++ .../default-twig/module-config.html.twig | 363 +---- 20 files changed, 1205 insertions(+), 2564 deletions(-) create mode 100644 Service/BackOffice/MenuComposer.php create mode 100644 Service/BackOffice/MenuTreePresenter.php delete mode 100644 Service/CustomFrontMenuLoadService.php delete mode 100644 Service/CustomFrontMenuSaveService.php delete mode 100644 Service/CustomFrontMenuService.php delete mode 100644 Service/FilterType.php delete mode 100644 Service/Validator.php delete mode 100644 templates/backOffice/default-twig/assets/css/styles.css delete mode 100644 templates/backOffice/default-twig/assets/js/main.js create mode 100644 templates/backOffice/default-twig/custom-front-menu/_target_field.html.twig create mode 100644 templates/backOffice/default-twig/custom-front-menu/_tree_nodes.html.twig create mode 100644 templates/backOffice/default-twig/custom-front-menu/entry.html.twig create mode 100644 templates/backOffice/default-twig/custom-front-menu/tree.html.twig diff --git a/Controller/MenuController.php b/Controller/MenuController.php index 5ef208a..06881b1 100644 --- a/Controller/MenuController.php +++ b/Controller/MenuController.php @@ -15,10 +15,10 @@ namespace CustomFrontMenu\Controller; use CustomFrontMenu\CustomFrontMenu; +use CustomFrontMenu\Model\CustomFrontMenuItem; +use CustomFrontMenu\Service\BackOffice\MenuComposer; use CustomFrontMenu\Service\BackOffice\MenuTargetCatalog; -use CustomFrontMenu\Service\CustomFrontMenuLoadService; -use CustomFrontMenu\Service\CustomFrontMenuSaveService; -use CustomFrontMenu\Service\CustomFrontMenuService; +use CustomFrontMenu\Service\BackOffice\MenuTreePresenter; use Propel\Runtime\Exception\PropelException; use Symfony\Component\HttpFoundation\RedirectResponse; use Symfony\Component\HttpFoundation\Response; @@ -31,232 +31,506 @@ use Thelia\Core\Translation\Translator; use Thelia\Tools\URL; +/** + * Composition of the front menus, in the default-twig back-office. + * + * One action per write, each persisted on its own: the 1.x screen kept the whole tree in + * the browser and saved it by dropping and recreating every row. + */ +#[Route('/admin/module/CustomFrontMenu', name: 'admin.customfrontmenu')] class MenuController extends BaseAdminController { - private const COOKIE_NAME = 'menuId'; - private const COOKIE_PATH = '/admin/module/CustomFrontMenu'; + private const DOMAIN = CustomFrontMenu::DOMAIN_NAME; + private const VIEWS = ['brand', 'category', 'content', 'folder', 'product']; public function __construct( - protected readonly MenuTargetCatalog $targetCatalog, + private readonly MenuComposer $composer, + private readonly MenuTreePresenter $presenter, + private readonly MenuTargetCatalog $targetCatalog, ) { } + // ---------------------------------------------------------------- menus + /** - * BaseController types getSession() as SessionInterface, but flashes and the admin - * language live on the Thelia session. + * The list of menus, rendered into the module configuration page by ConfigHook. + * + * @return array + * + * @throws PropelException */ - private function theliaSession(): Session + public function menuListData(): array { - /** @var Session $session */ - $session = $this->getSession(); + $locale = $this->locale(); + $menus = []; + + foreach ($this->composer->menus() as $menu) { + $menus[] = [ + 'id' => (int) $menu->getId(), + 'title' => $this->presenter->title($menu, $locale), + 'entryCount' => \count($menu->getDescendants()), + ]; + } - return $session; + return ['menus' => $menus]; } /** - * Composing a menu is an administration operation: it needs the module resource, - * and each POST carries the one-shot token. + * @throws PropelException */ - private function denyUnlessAllowed(Request $request): ?Response + #[Route('/menus', name: '.menus.create', methods: ['POST'])] + public function createMenu(Request $request): Response { - if (null !== $response = $this->checkAuth(AdminResources::MODULE, 'CustomFrontMenu', AccessManager::UPDATE)) { - return $response; + if (null !== $denied = $this->denyUnlessAllowed($request)) { + return $denied; } - $this->getTokenProvider()->checkToken((string) $request->request->get('_token', '')); + $title = trim((string) $request->request->get('title', '')); - return null; + if ('' === $title) { + return $this->failure('A menu name is required', $this->configurationUrl()); + } + + $menu = $this->composer->createMenu($title, $this->locale()); + + $this->success('New menu added successfully'); + + return new RedirectResponse($this->menuUrl((int) $menu->getId())); } - private function backToScreen(): RedirectResponse + /** + * @throws PropelException + */ + #[Route('/menus/{menuId}/delete', name: '.menus.delete', methods: ['POST'], requirements: ['menuId' => '\d+'])] + public function deleteMenu(Request $request, int $menuId): Response { - return new RedirectResponse(URL::getInstance()->absoluteUrl(self::COOKIE_PATH)); + if (null !== $denied = $this->denyUnlessAllowed($request)) { + return $denied; + } + + $menu = $this->composer->menu($menuId); + + if (null === $menu) { + return $this->failure('This menu does not exist', $this->configurationUrl()); + } + + $this->composer->delete($menu); + $this->success('Current menu deleted successfully'); + + return new RedirectResponse($this->configurationUrl()); } - private function rememberMenu(int $menuId): void + /** + * The tree of one menu. + * + * @throws PropelException + */ + #[Route('/menus/{menuId}', name: '.menus.show', methods: ['GET'], requirements: ['menuId' => '\d+'])] + public function showMenu(int $menuId): Response { - setcookie(self::COOKIE_NAME, (string) $menuId, [ - 'path' => self::COOKIE_PATH, - 'httponly' => true, - 'samesite' => 'Lax', + if (null !== $denied = $this->denyUnlessAllowed(null)) { + return $denied; + } + + $menu = $this->composer->menu($menuId); + + if (null === $menu) { + return new RedirectResponse($this->configurationUrl()); + } + + $locale = $this->locale(); + $tree = $this->presenter->tree($menu, $locale); + + return $this->render('custom-front-menu/tree', [ + 'menuId' => $menuId, + 'menuTitle' => $this->presenter->title($menu, $locale), + 'tree' => $tree, + // The "add an entry" form picks its parent from a flat list: a shared modal + // filled from the clicked row would need module JavaScript. + 'flatTree' => $this->flatten($tree), + 'preselectedParent' => (int) $this->getRequest()->query->get('parent', 0), ]); } + // --------------------------------------------------------------- entries + /** - * Load the menu selected by the user. + * @throws PropelException */ - #[Route('/admin/module/CustomFrontMenu/selectMenu', name: 'admin.customfrontmenu.select.menu', methods: ['POST'])] - public function selectOtherMenu(Request $request): Response + #[Route('/menus/{menuId}/entries', name: '.entries.create', methods: ['POST'], requirements: ['menuId' => '\d+'])] + public function createEntry(Request $request, int $menuId): Response { if (null !== $denied = $this->denyUnlessAllowed($request)) { return $denied; } - $this->rememberMenu((int) str_replace('menu-selected-', '', (string) $request->get('menuId'))); + $menu = $this->composer->menu($menuId); + + if (null === $menu) { + return $this->failure('This menu does not exist', $this->configurationUrl()); + } + + $parentId = (int) $request->request->get('parent_id', 0); + $parent = $menu; + + if ($parentId > 0) { + $candidate = $this->composer->entry($parentId); - return $this->backToScreen(); + if (null === $candidate) { + return $this->failure('This menu entry does not exist', $this->menuUrl($menuId)); + } + + $parent = $candidate; + } + + $title = trim((string) $request->request->get('title', '')); + + if ('' === $title) { + return $this->failure('An entry name is required', $this->menuUrl($menuId)); + } + + $entry = $this->composer->createEntry($parent, $title, $this->locale()); + + return new RedirectResponse($this->entryUrl((int) $entry->getId())); } /** - * Save the selected menu items in database. + * @throws PropelException + */ + #[Route('/entries/{itemId}', name: '.entries.edit', methods: ['GET'], requirements: ['itemId' => '\d+'])] + public function editEntry(int $itemId): Response + { + if (null !== $denied = $this->denyUnlessAllowed(null)) { + return $denied; + } + + $entry = $this->composer->entry($itemId); + + if (null === $entry) { + return new RedirectResponse($this->configurationUrl()); + } + + $view = strtolower((string) $entry->getView()); + $menuId = (int) $this->menuOf($entry)?->getId(); + + return $this->render('custom-front-menu/entry', [ + 'itemId' => $itemId, + 'menuId' => $menuId, + 'menuTitle' => $this->presenter->title($this->composer->menu($menuId), $this->locale()), + 'entryTitle' => $this->presenter->title($entry, $this->locale()), + 'translations' => $this->composer->translations($entry), + 'view' => \in_array($view, self::VIEWS, true) ? $view : ('' === $view ? 'none' : 'url'), + 'viewId' => (int) $entry->getViewId(), + 'targets' => $this->targetCatalog->targets($this->locale()), + ]); + } + + /** + * The target field alone, swapped in by HTMX when the kind of target changes. Keeps + * the dependent field server-rendered instead of shipping module JavaScript. * * @throws PropelException */ - #[Route('/admin/module/CustomFrontMenu/save', name: 'admin.customfrontmenu.save', methods: ['POST'])] - public function saveMenuItems( - Request $request, - CustomFrontMenuSaveService $customFrontMenuSave, - CustomFrontMenuService $customFrontMenuService, - ): Response { + #[Route('/entries/{itemId}/target-field', name: '.entries.target_field', methods: ['GET'], requirements: ['itemId' => '\d+'])] + public function entryTargetField(Request $request, int $itemId): Response + { + if (null !== $denied = $this->denyUnlessAllowed(null)) { + return $denied; + } + + $entry = $this->composer->entry($itemId); + + if (null === $entry) { + return new Response('', Response::HTTP_NO_CONTENT); + } + + $view = strtolower((string) $request->query->get('view', 'none')); + + return $this->render('custom-front-menu/_target_field', [ + 'view' => \in_array($view, [...self::VIEWS, 'url'], true) ? $view : 'none', + 'viewId' => (int) $entry->getViewId(), + 'translations' => $this->composer->translations($entry), + 'targets' => $this->targetCatalog->targets($this->locale()), + ]); + } + + /** + * @throws PropelException + */ + #[Route('/entries/{itemId}', name: '.entries.save', methods: ['POST'], requirements: ['itemId' => '\d+'])] + public function saveEntry(Request $request, int $itemId): Response + { if (null !== $denied = $this->denyUnlessAllowed($request)) { return $denied; } - $newMenu = json_decode((string) $request->get('menuData'), true); - $menuId = json_decode((string) $request->get('menuDataId')); + $entry = $this->composer->entry($itemId); + + if (null === $entry) { + return $this->failure('This menu entry does not exist', $this->configurationUrl()); + } + + $view = strtolower(trim((string) $request->request->get('view', 'none'))); + $titles = (array) $request->request->all('title'); + $urls = (array) $request->request->all('url'); + + if (\in_array($view, self::VIEWS, true)) { + $viewId = (int) $request->request->get('view_id', 0); - if (!\is_array($newMenu)) { - throw new \InvalidArgumentException('Save failed: the menu payload is not a list of items'); + if ($viewId <= 0) { + return $this->failure('Pick a target for this entry', $this->entryUrl($itemId)); + } + + $this->composer->setTarget($entry, ucfirst($view), $viewId); + } else { + $this->composer->setTarget($entry, null, null); } - if (!\is_int($menuId) || 0 === $menuId) { - throw new \InvalidArgumentException('Save failed: the menu id cannot be null or empty'); + foreach ($titles as $locale => $title) { + $this->composer->setTranslation( + $entry, + (string) $locale, + $this->cleanTitle((string) $title), + 'url' === $view ? $this->cleanUrl((string) ($urls[$locale] ?? '')) : null, + ); } - $menuToCheck = $customFrontMenuService->getMenu($menuId); + $this->success('This entry has been successfully saved'); + + return new RedirectResponse($this->menuUrl((int) $this->menuOf($entry)?->getId())); + } - if (!$menuToCheck || 1 !== $menuToCheck->getLevel()) { - throw new \InvalidArgumentException('Save failed: the menu id is invalid'); + /** + * @throws PropelException + */ + #[Route('/entries/{itemId}/delete', name: '.entries.delete', methods: ['POST'], requirements: ['itemId' => '\d+'])] + public function deleteEntry(Request $request, int $itemId): Response + { + if (null !== $denied = $this->denyUnlessAllowed($request)) { + return $denied; } - // Delete all the items currently in database for the menu to save - $menu = $customFrontMenuSave->deleteSpecificItems($menuId); + $entry = $this->composer->entry($itemId); - // Add all new items in database - $customFrontMenuSave->saveTableBrowser($newMenu, $menu); + if (null === $entry) { + return $this->failure('This menu entry does not exist', $this->configurationUrl()); + } - $this->theliaSession()->getFlashBag()->add( - 'success', - Translator::getInstance()->trans('This menu has been successfully saved !', [], CustomFrontMenu::DOMAIN_NAME), - ); + $menuId = (int) $this->menuOf($entry)?->getId(); + $this->composer->delete($entry); - return $this->backToScreen(); + $this->success('This entry has been deleted'); + + return new RedirectResponse($this->menuUrl($menuId)); } + // -------------------------------------------------------------- moving + /** - * Add a new menu with the name given by the user, and select it. + * Reparent an entry by drag and drop. + * + * The field names are those the back-office bo-category-tree Stimulus controller + * posts: reusing the theme's tree controller means accepting its contract, which is + * still cheaper than shipping a second drag and drop implementation. * * @throws PropelException */ - #[Route('/admin/module/CustomFrontMenu/add', name: 'admin.customfrontmenu.addmenu', methods: ['POST'])] - public function addMenu(Request $request, CustomFrontMenuService $customFrontMenuService): Response + #[Route('/entries/move', name: '.entries.move', methods: ['POST'])] + public function moveEntry(Request $request): Response { if (null !== $denied = $this->denyUnlessAllowed($request)) { return $denied; } - $root = $customFrontMenuService->getRoot(); - $itemId = $customFrontMenuService->addMenu($root, (string) $request->get('menuName')); + $entry = $this->composer->entry((int) $request->request->get('category_id', 0)); + $newParentId = (int) $request->request->get('new_parent_id', 0); - $this->rememberMenu($itemId); + if (null === $entry) { + return new Response('', Response::HTTP_NO_CONTENT); + } - $this->theliaSession()->getFlashBag()->add( - 'success', - Translator::getInstance()->trans('New menu added successfully', [], CustomFrontMenu::DOMAIN_NAME), - ); + $menu = $this->menuOf($entry); + $newParent = $newParentId > 0 ? $this->composer->entry($newParentId) : $menu; + + // A drop outside this menu, or onto the entry's own subtree, is a no-op. + if (null === $newParent || null === $menu || $this->menuOf($newParent)?->getId() !== $menu->getId()) { + return new Response('', Response::HTTP_NO_CONTENT); + } + + $this->composer->move($entry, $newParent); - return $this->backToScreen(); + return new Response('', Response::HTTP_NO_CONTENT); } /** - * Delete the current menu. + * @throws PropelException + */ + #[Route('/entries/{itemId}/up', name: '.entries.up', methods: ['POST'], requirements: ['itemId' => '\d+'])] + public function moveEntryUp(Request $request, int $itemId): Response + { + return $this->reorder($request, $itemId, up: true); + } + + /** + * @throws PropelException + */ + #[Route('/entries/{itemId}/down', name: '.entries.down', methods: ['POST'], requirements: ['itemId' => '\d+'])] + public function moveEntryDown(Request $request, int $itemId): Response + { + return $this->reorder($request, $itemId, up: false); + } + + /** + * @throws PropelException */ - #[Route('/admin/module/CustomFrontMenu/delete', name: 'admin.customfrontmenu.deletemenu', methods: ['POST'])] - public function deleteMenu(Request $request, CustomFrontMenuService $customFrontMenuService): Response + private function reorder(Request $request, int $itemId, bool $up): Response { if (null !== $denied = $this->denyUnlessAllowed($request)) { return $denied; } - $rawMenuId = (string) $request->get('menuId', ''); + $entry = $this->composer->entry($itemId); - if ('' === $rawMenuId || 'menu-selected-' === $rawMenuId) { - throw new \InvalidArgumentException('Delete failed: the menu id cannot be null or empty'); + if (null === $entry) { + return $this->failure('This menu entry does not exist', $this->configurationUrl()); } - $customFrontMenuService->deleteMenu((int) str_replace('menu-selected-', '', $rawMenuId)); + $up ? $this->composer->moveUp($entry) : $this->composer->moveDown($entry); - $this->theliaSession()->getFlashBag()->add( - 'success', - Translator::getInstance()->trans('Current menu deleted successfully', [], CustomFrontMenu::DOMAIN_NAME), - ); + return new RedirectResponse($this->menuUrl((int) $this->menuOf($entry)?->getId())); + } - $this->rememberMenu(-1); + // ------------------------------------------------------------- plumbing + + /** + * Composing a menu is an administration operation. A null request means a GET screen, + * which needs the permission but carries no token. + */ + private function denyUnlessAllowed(?Request $request): ?Response + { + if (null !== $response = $this->checkAuth(AdminResources::MODULE, 'CustomFrontMenu', AccessManager::UPDATE)) { + return $response; + } + + if ($request instanceof Request) { + $this->getTokenProvider()->checkToken((string) $request->request->get('_token', '')); + } - return $this->backToScreen(); + return null; } /** - * Everything the composition screen needs to render. - * - * @return array + * @param list> $nodes * + * @return list + */ + private function flatten(array $nodes): array + { + $flat = []; + + foreach ($nodes as $node) { + $flat[] = ['id' => $node['id'], 'title' => $node['title'], 'depth' => $node['depth']]; + $flat = [...$flat, ...$this->flatten($node['children'])]; + } + + return $flat; + } + + /** * @throws PropelException */ - public function loadMenuItems( - CustomFrontMenuLoadService $customFrontMenuLoadService, - CustomFrontMenuService $customFrontMenuService, - ?int $menuId = null, - ): array { - $menuNames = $customFrontMenuLoadService->loadSelectMenu($customFrontMenuService->getRoot()); - $data = []; - - if (!$menuId && \count($menuNames) > 0) { - $menuId = (int) str_replace('menu-selected-', '', $menuNames[0]['id']); - } - - if ($menuId) { - $menu = $customFrontMenuService->getMenu($menuId); - - if (!$menu || 1 !== $menu->getLevel()) { - $this->theliaSession()->getFlashBag()->add( - 'fail', - Translator::getInstance()->trans('This menu does not exists', [], CustomFrontMenu::DOMAIN_NAME), - ); - - if (0 === \count($menuNames)) { - return $this->screenData($menuNames, [], 0); - } - - $menuId = (int) str_replace('menu-selected-', '', $menuNames[0]['id']); - $this->rememberMenu($menuId); - $menu = $customFrontMenuService->getMenu($menuId); - } + private function menuOf(CustomFrontMenuItem $item): ?CustomFrontMenuItem + { + $current = $item; + + while ($current->getLevel() > 1) { + $parent = $current->getParent(); - if ($menu) { - $data = $customFrontMenuLoadService->loadTableBrowser($menu); + if (!$parent instanceof CustomFrontMenuItem) { + return null; } + + $current = $parent; } - return $this->screenData($menuNames, $data, (int) $menuId); + return 1 === $current->getLevel() ? $current : null; } /** - * @param array> $menuNames - * @param array $menuItems - * - * @return array + * A menu label is shown on every front page: no markup, and no back quote, which the + * 1.x screen used as its own delimiter. */ - private function screenData(array $menuNames, array $menuItems, int $menuId): array + private function cleanTitle(string $title): ?string + { + $title = trim(strip_tags(str_replace('`', "'", $title))); + + return '' === $title ? null : $title; + } + + /** + * Only http(s) and site-relative URLs: a menu link is rendered on every page, so a + * javascript: or data: URL entered here would be a stored cross-site scripting hole. + */ + private function cleanUrl(string $url): ?string + { + $url = trim(strip_tags($url)); + + if ('' === $url) { + return null; + } + + if (str_starts_with($url, '/')) { + return $url; + } + + $scheme = strtolower((string) parse_url($url, \PHP_URL_SCHEME)); + + return \in_array($scheme, ['http', 'https'], true) ? $url : null; + } + + private function locale(): string + { + return $this->theliaSession()->getAdminLang()->getLocale(); + } + + private function theliaSession(): Session + { + /** @var Session $session */ + $session = $this->getSession(); + + return $session; + } + + private function success(string $message): void + { + $this->theliaSession()->getFlashBag()->add( + 'success', + Translator::getInstance()->trans($message, [], self::DOMAIN), + ); + } + + private function failure(string $message, string $redirectTo): RedirectResponse + { + $this->theliaSession()->getFlashBag()->add( + 'error', + Translator::getInstance()->trans($message, [], self::DOMAIN), + ); + + return new RedirectResponse($redirectTo); + } + + private function configurationUrl(): string + { + return URL::getInstance()->absoluteUrl('/admin/module/CustomFrontMenu'); + } + + private function menuUrl(int $menuId): string + { + return URL::getInstance()->absoluteUrl('/admin/module/CustomFrontMenu/menus/'.$menuId); + } + + private function entryUrl(int $itemId): string { - $locale = $this->theliaSession()->getAdminLang()->getLocale(); - - return [ - 'menuNames' => json_encode($menuNames), - 'menuItems' => json_encode($menuItems), - 'currentMenuId' => $menuId, - 'locale' => $locale, - 'targets' => $this->targetCatalog->targets($locale), - ]; + return URL::getInstance()->absoluteUrl('/admin/module/CustomFrontMenu/entries/'.$itemId); } } diff --git a/Hook/ConfigHook.php b/Hook/ConfigHook.php index 7b31d24..f0b9b02 100644 --- a/Hook/ConfigHook.php +++ b/Hook/ConfigHook.php @@ -15,22 +15,23 @@ namespace CustomFrontMenu\Hook; use CustomFrontMenu\Controller\MenuController; -use CustomFrontMenu\Service\CustomFrontMenuLoadService; -use CustomFrontMenu\Service\CustomFrontMenuService; use Propel\Runtime\Exception\PropelException; use Symfony\Component\EventDispatcher\EventDispatcherInterface; -use Symfony\Component\HttpFoundation\RequestStack; use Thelia\Core\Event\Hook\HookRenderEvent; use Thelia\Core\Hook\BaseHook; use Thelia\Core\Template\Parser\ParserResolver; +/** + * Renders the list of menus into the module configuration page. + * + * Composing a menu happens on the module's own pages, which are full back-office pages + * extending the theme layout: this hook no longer injects any script or stylesheet, since + * the screen is built from the theme's own components. + */ class ConfigHook extends BaseHook { public function __construct( - private readonly CustomFrontMenuLoadService $customFrontMenuLoadService, - private readonly CustomFrontMenuService $customFrontMenuService, private readonly MenuController $menuController, - private readonly RequestStack $requestStack, ?EventDispatcherInterface $dispatcher = null, ?ParserResolver $parserResolver = null, ) { @@ -40,55 +41,17 @@ public function __construct( public static function getSubscribedHooks(): array { return [ - 'module.config-js' => [ - ['type' => 'back', 'method' => 'addMenuJs'], - ], - 'main.head-css' => [ - ['type' => 'back', 'method' => 'addMenuCss'], - ], 'module.configuration' => [ ['type' => 'back', 'method' => 'onModuleConfiguration'], ], ]; } - public function addMenuJs(HookRenderEvent $event): void - { - $event->add($this->addJS('assets/js/main.js')); - } - - public function addMenuCss(HookRenderEvent $event): void - { - $event->add($this->addCSS('assets/css/styles.css')); - } - /** * @throws PropelException */ public function onModuleConfiguration(HookRenderEvent $event): void { - $event->add($this->render('module-config.html.twig', $this->menuController->loadMenuItems( - $this->customFrontMenuLoadService, - $this->customFrontMenuService, - $this->selectedMenuId(), - ))); - } - - /** - * The screen remembers the menu being composed in a cookie, so it survives a redirect - * after save. The value is client-controlled: anything but a positive integer means - * "no selection" and lets the screen fall back to the first menu. - */ - private function selectedMenuId(): ?int - { - $raw = $this->requestStack->getCurrentRequest()?->cookies->get('menuId'); - - if (!\is_string($raw) || 1 !== preg_match('/^\d+$/', $raw)) { - return null; - } - - $menuId = (int) $raw; - - return $menuId > 0 ? $menuId : null; + $event->add($this->render('module-config.html.twig', $this->menuController->menuListData())); } } diff --git a/I18n/backOffice/default-twig/en_US.php b/I18n/backOffice/default-twig/en_US.php index 9a25907..9704d60 100644 --- a/I18n/backOffice/default-twig/en_US.php +++ b/I18n/backOffice/default-twig/en_US.php @@ -1,4 +1,9 @@ 'Brand', + 'category' => 'Category', + 'content' => 'Content', + 'folder' => 'Folder', + 'product' => 'Product', ); diff --git a/I18n/backOffice/default-twig/fr_FR.php b/I18n/backOffice/default-twig/fr_FR.php index f02dfe7..67eeca8 100644 --- a/I18n/backOffice/default-twig/fr_FR.php +++ b/I18n/backOffice/default-twig/fr_FR.php @@ -1,52 +1,49 @@ 'Une langue laissée vide reprend une autre langue côté boutique.', 'Add' => 'Ajouter', - 'Add a submenu' => 'Ajouter un sous menu ', - 'Add a menu' => 'Ajouter un menu', - 'Add a new item to menu' => 'Ajouter un nouvel élément au menu', 'Add a new menu' => 'Ajouter un menu', - 'Add a new menu item' => 'Ajouter un nouvel élément au menu', - 'Add a new parent' => 'Ajouter un nouveau parent', + 'Add a sub-entry' => 'Ajouter une entrée en dessous', + 'Add an entry' => 'Ajouter une entrée', + 'Address' => 'Adresse', + 'All menus' => 'Tous les menus', 'Cancel' => 'Annuler', - 'Cannot use back quote ( ` )' => 'Vous ne pouvez pas utiliser de back quote ( ` )', - 'Close' => 'Fermer', + 'Compose' => 'Composer', 'Create' => 'Créer', - 'Create a new menu' => 'Créer un nouveau menu', - 'Create this menu' => 'Créer ce menu', 'Delete' => 'Supprimer', - 'Delete link' => 'Supprimer le lien', - 'Delete menu' => 'Supprimer un menu', + 'Delete this entry and everything under it?' => 'Supprimer cette entrée et tout ce qu\'elle contient ?', 'Delete this menu' => 'Supprimer ce menu', - 'Discard changes' => 'Annuler les modifications', - 'Edit a menu item' => 'Modifier un élément du menu', - 'Edit menu' => 'Modifier le menu', - 'Hide all children' => 'Masquer les enfants', - 'Item name' => 'Nom de l\'élément', - 'Item title' => 'Titre de l\'élément', - 'Menu' => 'Menu', + 'Delete this whole menu and all its entries?' => 'Supprimer ce menu et toutes ses entrées ?', + 'Deleted target (#%id%)' => 'Cible supprimée (#%id%)', + 'Drag an entry onto another to nest it. Drag it onto the menu drop zone to bring it back to the first level. Every move is saved right away.' => 'Faites glisser une entrée sur une autre pour l\'imbriquer, ou sur la zone du menu pour la ramener au premier niveau. Chaque déplacement est enregistré immédiatement.', + 'Edit an entry' => 'Modifier une entrée', + 'Entries' => 'Entrées', + 'Entry name' => 'Nom de l\'entrée', + 'First level of the menu' => 'Premier niveau du menu', + 'Front-office call' => 'Appel côté boutique', + 'Kind of target' => 'Type de cible', + 'Label' => 'Libellé', 'Menu name' => 'Nom du menu', - 'Menu name cannot be empty' => 'Le nom d\'un menu ne peut pas être vide', - 'Menu title' => "Titre du menu", - 'No parent' => 'Aucun parent', - 'No target item' => 'Pas d\'élément cible', - 'Parent' => 'Parent', - 'Personal url' => 'Url personnelle', - 'Position' => 'Position', - 'Update' => 'Mise à jour', - 'Update item' => 'Mise à jour de l\'élément', - 'Preview menu' => 'Prévisualisation du menu', + 'Menus' => 'Menus', + 'Move down' => 'Descendre', + 'Move up' => 'Monter', + 'Name' => 'Nom', + 'No menu yet. Create one to get started.' => 'Aucun menu pour le moment. Créez-en un pour commencer.', + 'No target' => 'Aucune cible', + 'Only http, https and site-relative addresses are kept.' => 'Seules les adresses http, https et relatives au site sont conservées.', + 'Pick one' => 'Choisissez', + 'Place it under' => 'Placer sous', 'Save' => 'Enregistrer', - 'Save everything' => 'Tout enregistrer', - 'Select a category' => 'Choisissez une categorie', - 'Show all children' => 'Voir tous les enfants', - 'Submenu name' => 'Nom du sous-menu', - 'Target item' => 'Élément cible', - 'Unsaved changes' => 'Changements non sauvegardés', - 'Warning: You have unsaved changes!' => 'Attention : vous avez des modifications non enregistrées !', - 'Would you like to delete this menu item ?' => 'Voulez-vous supprimer cet élément du menu ?', - 'Would you like to delete this menu ?' => 'Voulez-vous supprimer ce menu ?', - 'Would you like to discard all changes ?' => 'Voulez-vous annuler les modifications ?', - 'You have unsaved changes. If you don\'t save them your changes will be lost' => 'Vous avez des changements non enregistrés. Si vous ne les enregistrez pas vos modifications seront perdues', - '-- language to translate into --' => '-- langue dans laquelle traduire --', + 'Target' => 'Cible', + 'This entry is a label with no link.' => 'Cette entrée est un libellé sans lien.', + 'This menu has no entry yet.' => 'Ce menu n\'a encore aucune entrée.', + 'Toggle children' => 'Afficher ou masquer les entrées filles', + 'Untitled' => 'Sans titre', + '%title% (offline)' => '%title% (hors ligne)', + 'brand' => 'Marque', + 'category' => 'Catégorie', + 'content' => 'Contenu', + 'folder' => 'Dossier', + 'product' => 'Produit', ); diff --git a/I18n/fr_FR.php b/I18n/fr_FR.php index 8e11684..3db83fd 100755 --- a/I18n/fr_FR.php +++ b/I18n/fr_FR.php @@ -1,23 +1,13 @@ 'Marque', - 'Category' => 'Catégorie', - 'Product' => 'Produit', - 'Content' => 'Contenu', - 'Folder' => 'Fichier', - 'Link to' => 'Lien à', - 'Menu name' => 'Nom du menu', - 'New link' => 'Nouveau lien', - 'No parent' => 'Aucun parent', - 'Page' => 'Page', - 'Parent' => 'Parent', - 'URL' => 'URL', - - 'This menu does not exists' => "Ce menu n'existe pas", - + 'A menu name is required' => 'Le nom du menu est obligatoire', + 'An entry name is required' => 'Le nom de l\'entrée est obligatoire', 'Current menu deleted successfully' => 'Le menu a été supprimé avec succès', 'New menu added successfully' => 'Nouveau menu ajouté avec succès', - 'This menu has been successfully saved !' => 'Ce menu a été sauvegardé avec succès !', - + 'Pick a target for this entry' => 'Choisissez une cible pour cette entrée', + 'This entry has been deleted' => 'L\'entrée a été supprimée', + 'This entry has been successfully saved' => 'L\'entrée a été enregistrée', + 'This menu does not exist' => 'Ce menu n\'existe pas', + 'This menu entry does not exist' => 'Cette entrée de menu n\'existe pas', ); diff --git a/Service/BackOffice/MenuComposer.php b/Service/BackOffice/MenuComposer.php new file mode 100644 index 0000000..333598f --- /dev/null +++ b/Service/BackOffice/MenuComposer.php @@ -0,0 +1,231 @@ +findRoot(); + + if (null === $root) { + $root = new CustomFrontMenuItem(); + $root->makeRoot(); + $root->save(); + } + + return $root; + } + + /** + * @return list + * + * @throws PropelException + */ + public function menus(): array + { + return iterator_to_array($this->root()->getChildren()); + } + + /** + * @throws PropelException + */ + public function menu(int $menuId): ?CustomFrontMenuItem + { + $menu = CustomFrontMenuItemQuery::create()->findOneById($menuId); + + // Level 1 is a menu; anything deeper is an entry inside one. + return $menu && 1 === $menu->getLevel() ? $menu : null; + } + + /** + * @throws PropelException + */ + public function entry(int $itemId): ?CustomFrontMenuItem + { + $item = CustomFrontMenuItemQuery::create()->findOneById($itemId); + + return $item && $item->getLevel() > 1 ? $item : null; + } + + /** + * @throws PropelException + */ + public function createMenu(string $title, string $locale): CustomFrontMenuItem + { + $menu = new CustomFrontMenuItem(); + $menu->insertAsLastChildOf($this->root()); + $menu->save(); + + $this->setTranslation($menu, $locale, $title, null); + + return $menu; + } + + /** + * @throws PropelException + */ + public function createEntry(CustomFrontMenuItem $parent, string $title, string $locale): CustomFrontMenuItem + { + $entry = new CustomFrontMenuItem(); + $entry->insertAsLastChildOf($parent); + $entry->save(); + + $this->setTranslation($entry, $locale, $title, null); + + return $entry; + } + + /** + * @throws PropelException + */ + public function delete(CustomFrontMenuItem $item): void + { + foreach ($item->getDescendants() as $descendant) { + $this->deleteTranslations((int) $descendant->getId()); + } + + $item->deleteDescendants(); + $this->deleteTranslations((int) $item->getId()); + $item->delete(); + } + + /** + * Reparent one entry. Passing the menu itself as the new parent moves the entry back + * to the first level of that menu. + * + * @throws PropelException + */ + public function move(CustomFrontMenuItem $item, CustomFrontMenuItem $newParent): void + { + // Moving a node inside its own subtree would corrupt the nested set. + if ($this->isSelfOrDescendant($item, $newParent)) { + return; + } + + $item->moveToLastChildOf($newParent); + } + + /** + * @throws PropelException + */ + public function moveUp(CustomFrontMenuItem $item): void + { + $sibling = $item->getPrevSibling(); + + if ($sibling instanceof CustomFrontMenuItem) { + $item->moveToPrevSiblingOf($sibling); + } + } + + /** + * @throws PropelException + */ + public function moveDown(CustomFrontMenuItem $item): void + { + $sibling = $item->getNextSibling(); + + if ($sibling instanceof CustomFrontMenuItem) { + $item->moveToNextSiblingOf($sibling); + } + } + + /** + * @throws PropelException + */ + public function setTarget(CustomFrontMenuItem $item, ?string $view, ?int $viewId): void + { + $item + ->setView($view) + ->setViewId($viewId) + ->save(); + } + + /** + * @throws PropelException + */ + public function setTranslation(CustomFrontMenuItem $item, string $locale, ?string $title, ?string $url): void + { + $translation = CustomFrontMenuItemI18nQuery::create() + ->filterById($item->getId()) + ->findOneByLocale($locale); + + if (null === $translation) { + $translation = new CustomFrontMenuItemI18n(); + $translation + ->setId($item->getId()) + ->setLocale($locale); + } + + $translation + ->setTitle($title) + ->setUrl($url) + ->save(); + } + + /** + * @return array + * + * @throws PropelException + */ + public function translations(CustomFrontMenuItem $item): array + { + $translations = []; + + foreach (CustomFrontMenuItemI18nQuery::create()->findById($item->getId()) as $translation) { + $translations[$translation->getLocale()] = [ + 'title' => $translation->getTitle(), + 'url' => $translation->getUrl(), + ]; + } + + return $translations; + } + + /** + * @throws PropelException + */ + private function isSelfOrDescendant(CustomFrontMenuItem $item, CustomFrontMenuItem $candidate): bool + { + return $candidate->getTreeLeft() >= $item->getTreeLeft() + && $candidate->getTreeRight() <= $item->getTreeRight(); + } + + /** + * @throws PropelException + */ + private function deleteTranslations(int $itemId): void + { + CustomFrontMenuItemI18nQuery::create()->filterById($itemId)->delete(); + } +} diff --git a/Service/BackOffice/MenuTreePresenter.php b/Service/BackOffice/MenuTreePresenter.php new file mode 100644 index 0000000..48d77c2 --- /dev/null +++ b/Service/BackOffice/MenuTreePresenter.php @@ -0,0 +1,171 @@ + BrandQuery::class, + 'category' => CategoryQuery::class, + 'content' => ContentQuery::class, + 'folder' => FolderQuery::class, + 'product' => ProductQuery::class, + ]; + + public function __construct( + private TranslatorInterface $translator, + ) { + } + + /** + * @return list> + * + * @throws PropelException + */ + public function tree(CustomFrontMenuItem $parent, string $locale, int $depth = 0): array + { + $nodes = []; + + foreach ($parent->getChildren() as $child) { + $nodes[] = [ + 'id' => (int) $child->getId(), + 'title' => $this->title($child, $locale), + 'depth' => $depth, + 'target' => $this->target($child, $locale), + 'children' => $child->hasChildren() ? $this->tree($child, $locale, $depth + 1) : [], + ]; + } + + return $nodes; + } + + /** + * @throws PropelException + */ + public function title(CustomFrontMenuItem $item, string $locale): string + { + $translations = CustomFrontMenuItemI18nQuery::create()->findById($item->getId()); + $fallback = ''; + + foreach ($translations as $translation) { + $title = (string) $translation->getTitle(); + + if ($translation->getLocale() === $locale && '' !== $title) { + return $title; + } + + if ('' === $fallback) { + $fallback = $title; + } + } + + return '' !== $fallback + ? $fallback + : $this->translator->trans('Untitled', [], 'customfrontmenu.bo.default-twig'); + } + + /** + * What the entry points at, and whether the front will render it. + * + * @return array{kind: string, label: string, ok: bool} + * + * @throws PropelException + */ + private function target(CustomFrontMenuItem $item, string $locale): array + { + $domain = 'customfrontmenu.bo.default-twig'; + $view = strtolower((string) $item->getView()); + $viewId = (int) $item->getViewId(); + + if (!isset(self::TARGET_QUERIES[$view]) || $viewId <= 0) { + $url = $this->url($item, $locale); + + if ('' !== $url) { + return ['kind' => 'url', 'label' => $url, 'ok' => true]; + } + + return [ + 'kind' => 'none', + 'label' => $this->translator->trans('No target', [], $domain), + 'ok' => true, + ]; + } + + $queryClass = self::TARGET_QUERIES[$view]; + $target = $queryClass::create()->findPk($viewId); + + if (null === $target) { + return [ + 'kind' => $view, + 'label' => $this->translator->trans('Deleted target (#%id%)', ['%id%' => $viewId], $domain), + 'ok' => false, + ]; + } + + $target->setLocale($locale); + $label = (string) $target->getTitle(); + + // Unpublished: the entry is dropped from the front, so say so here. + if (!$target->getVisible()) { + return [ + 'kind' => $view, + 'label' => $this->translator->trans('%title% (offline)', ['%title%' => $label], $domain), + 'ok' => false, + ]; + } + + return ['kind' => $view, 'label' => $label, 'ok' => true]; + } + + /** + * @throws PropelException + */ + private function url(CustomFrontMenuItem $item, string $locale): string + { + $translations = CustomFrontMenuItemI18nQuery::create()->findById($item->getId()); + $fallback = ''; + + foreach ($translations as $translation) { + $url = (string) $translation->getUrl(); + + if ($translation->getLocale() === $locale && '' !== $url) { + return $url; + } + + if ('' === $fallback) { + $fallback = $url; + } + } + + return $fallback; + } +} diff --git a/Service/CustomFrontMenuLoadService.php b/Service/CustomFrontMenuLoadService.php deleted file mode 100644 index 45e2f1d..0000000 --- a/Service/CustomFrontMenuLoadService.php +++ /dev/null @@ -1,145 +0,0 @@ -getChildren(); - $dataArray = []; - foreach ($descendants as $descendant) { - $newArray = []; - $newArray['id'] = 'menu-selected-' . $descendant->getId(); - $content = CustomFrontMenuItemI18nQuery::create() - ->filterById($descendant->getId()) - ->findOneByLocale('en_US'); - - $newArray['title'] = $content->getTitle() . ' (id: ' . $descendant->getId() . ')'; - $dataArray[] = $newArray; - } - return $dataArray; - } - - /** - * Load all elements from the database recursively to parse them in an array - * @param CustomFrontMenuItem $parent - * @return array All the descendants items of the menu root given in parameter - * @throws PropelException - * @throws Exception - */ - public function loadTableBrowser(CustomFrontMenuItem $parent) : array - { - $dataArray = []; - - /** @var Session $session */ - $session = $this->requestStack->getCurrentRequest()->getSession(); - - $descendants = $parent->getChildren(); - foreach ($descendants as $descendant) { - $newArray = []; - $I18nMenus = CustomFrontMenuItemI18nQuery::create() - ->findById($descendant->getId()); - - if (count($I18nMenus) <= 0){ - throw new PropelException('No content found for the given id:' . $descendant->getId()); - } - - $view = $descendant->getView(); - if (!$view){ - $view = 'url'; - } - $newArray['type'] = $view; - foreach ($I18nMenus as $I18nMenu) { - $newArray['title'][$I18nMenu->getLocale()] = $I18nMenu->getTitle(); - if($view === 'url') { - $newArray['url'][$I18nMenu->getLocale()] = $I18nMenu->getUrl(); - } - } - - - $viewId = $descendant->getViewId(); - - // $view is never empty here: it defaults to 'url' just above. - if($viewId && Validator::viewIsValid($view)) { - - $formatedView = ucfirst($view); - $class = 'Thelia\Model\\' . $formatedView . 'Query'; - if (!class_exists($class)) { - throw new Exception("Class $class does not exist."); - } - /** @var CategoryQuery|ProductQuery|FolderQuery|ContentQuery|BrandQuery $objectQuery */ - $objectQuery = $class::create(); - - /** @var ObjectCollection $query */ - $query = $objectQuery - ->filterById($viewId) - ->joinWith($formatedView.'I18n') - ->find(); - - // Emptiness first: reading the translations of a missing row raised an - // index error before this check could report the real problem. - if ($query->isEmpty()) { - throw new Exception("No results found for the specified id $viewId."); - } - - $queryI18n = $query->getColumnValues($formatedView.'I18ns')[0]; - - $title = null; - foreach ($queryI18n as $item) { - if ($item->getLocale() === $session->getAdminLang()->getLocale()) { - $title = $item->getTitle(); - break; - } - if ($item->getLocale() === 'en_US') { - $title = $item->getTitle(); - } - } - if (!$title) { - $title = $queryI18n[0]->getTitle(); - } - $newArray['typeId'] = $title.'-'.$viewId; - if (strtolower($view) === 'product') { - $newArray['typeId'] = $title.'-'.$query->getFirst()->getRef().'-'.$viewId; ; - } - } - - $newArray['depth'] = $descendant->getLevel() - 2; - $newArray['id'] = $this->COUNT_ID; - ++$this->COUNT_ID; - - if ($descendant->hasChildren()) { - $newArray['children'] = $this->loadTableBrowser($descendant); - } - $dataArray[] = $newArray; - } - return $dataArray; - } - -} diff --git a/Service/CustomFrontMenuSaveService.php b/Service/CustomFrontMenuSaveService.php deleted file mode 100644 index 091071c..0000000 --- a/Service/CustomFrontMenuSaveService.php +++ /dev/null @@ -1,137 +0,0 @@ -findOneById($menuId); - - $descendants = $menu->getDescendants(); - foreach ($descendants as $descendant) { - CustomFrontMenuItemI18nQuery::create()->findById($descendant->getId())->delete(); - } - $menu->deleteDescendants(); - - $menu->save(); - return $menu; - } - - - /** - * Save all elements from an array recursively to the database - * @throws PropelException - * @throws Exception - */ - public function saveTableBrowser(array $dataArray, CustomFrontMenuItem $parent) : void - { - /** @var Session $session */ - $session = $this->requestStack->getCurrentRequest()->getSession(); - $adminLocale = $session->getAdminLang()->getLocale(); - - foreach ($dataArray as $element) { - - $item = new CustomFrontMenuItem(); - $item->insertAsLastChildOf($parent) - ->save(); - - if(strtolower($element['type']) === 'url') { - foreach ($element['url'] as $locale => $url) { - $content = new CustomFrontMenuItemI18n(); - $content->setId($item->getId()) - ->setLocale($locale); - if ($url) { - $content->setUrl(Validator::filterValidation(Validator::htmlSafeValidation($url, $session), FilterType::URL)); - } - $content->save(); - if(!isset($element['title'][$locale])) { - if (isset($element['title'][$adminLocale])) { - $element['title'][$locale] = $element['title'][$adminLocale]; - } else { - $found = false; - foreach ($element['title'] as $value) { - if (!$found && !is_null($value)) { - $element['title'][$locale] = $value; - $found = true; - } - } - if (!$found) { - $element['title'][$locale] = 'Empty string'; - } - } - } - } - } elseif (strtolower($element['type']) !== 'empty') { - $viewIdExploded = explode('-', $element['typeId']); - $item->setView(ucfirst(Validator::viewIsValidOrEmpty($element['type']))) - ->setViewId(intval(end($viewIdExploded))) - ->save(); - } else { - $item->setView('Empty') - ->setViewId(null) - ->save(); - } - - foreach ($element['title'] as $locale => $title) { - $content = CustomFrontMenuItemI18nQuery::create() - ->filterById($item->getId()) - ->findOneByLocale($locale); - - if ($content === null) { - $content = new CustomFrontMenuItemI18n(); - $content->setId($item->getId()) - ->setLocale($locale); - } - - if(strtolower($element['type']) === 'url' && !isset($element['url'][$locale])) { - if (isset($element['url'][$adminLocale])) { - $content->setUrl(Validator::filterValidation(Validator::htmlSafeValidation($element['url'][$adminLocale], $session), FilterType::URL)); - } else { - $found = false; - foreach ($element['url'] as $value) { - if (!$found && !is_null($value)) { - $content->setUrl(Validator::filterValidation(Validator::htmlSafeValidation($value, $session), FilterType::URL)); - $found = true; - } - } - if (!$found) { - $item->setView('Empty') - ->setViewId(null) - ->save(); - } - } - } - - $content->setTitle(Validator::completeValidation($title, $session)) - ->save(); - } - - - - if (!empty($element['children'])) { - $this->saveTableBrowser($element['children'], $item); - } - - $parent->save(); - } - } - -} \ No newline at end of file diff --git a/Service/CustomFrontMenuService.php b/Service/CustomFrontMenuService.php deleted file mode 100644 index 35c8d53..0000000 --- a/Service/CustomFrontMenuService.php +++ /dev/null @@ -1,69 +0,0 @@ -findRoot() === null) { - $root = new CustomFrontMenuItem(); - $root->makeRoot(); - $root->save(); - } else { - $root = CustomFrontMenuItemQuery::create()->findRoot(); - } - return $root; - } - - /** - * @throws PropelException - */ - public function addMenu(CustomFrontMenuItem $root, string $menuName) : int - { - /** @var Session $session */ - $session = $this->requestStack->getCurrentRequest()->getSession(); - - $item = new CustomFrontMenuItem(); - $item->insertAsLastChildOf($root); - $item->save(); - - $content = new CustomFrontMenuItemI18n(); - $content->setTitle(Validator::completeValidation($menuName, $session)); - $content->setId($item->getId()); - $content->setLocale('en_US'); - $content->save(); - - return $item->getId(); - } - - public function deleteMenu(int $menuId) : void - { - CustomFrontMenuItemI18nQuery::create()->findById($menuId)->delete(); - CustomFrontMenuItemQuery::create()->findById($menuId)->delete(); - } - - public function getMenu(int $menuId) : ?CustomFrontMenuItem - { - return CustomFrontMenuItemQuery::create()->findOneById($menuId); - } -} \ No newline at end of file diff --git a/Service/FilterType.php b/Service/FilterType.php deleted file mode 100644 index d18f98c..0000000 --- a/Service/FilterType.php +++ /dev/null @@ -1,9 +0,0 @@ -findById($item->getId()); - $fallback = ''; + $english = ''; + $any = ''; foreach ($translations as $translation) { - $value = (string) ('title' === $column ? $translation->getTitle() : $translation->getUrl()); + $value = trim((string) ('title' === $column ? $translation->getTitle() : $translation->getUrl())); + + if ('' === $value) { + continue; + } if ($translation->getLocale() === $locale) { return $value; } - if ('' === $fallback || 'en_US' === $translation->getLocale()) { - $fallback = $value; + if ('en_US' === $translation->getLocale()) { + $english = $value; + } + + if ('' === $any) { + $any = $value; } } - return $fallback; + return '' !== $english ? $english : $any; } } diff --git a/Service/Validator.php b/Service/Validator.php deleted file mode 100644 index a8ec529..0000000 --- a/Service/Validator.php +++ /dev/null @@ -1,109 +0,0 @@ -getFlashBag()->add('warning', 'One or more empty fields were replaced by the tag "Empty field".'); - } - return self::backQuoteProhibited($string, $session); - } - - /** - * Replace back quotes with simple quotes and add a warning flash message. - */ - public static function backQuoteProhibited(string $string, Session $session) : string - { - $string = trim($string); - if (str_contains($string, '`')) { - $string = str_replace('`', "'", $string); - $session->getFlashBag()->add('warning', "One or more back quotes were replaced by simple quotes : ` -> ' ."); - } - return $string; - } - - public static function htmlSafeValidation(string $string, Session $session, bool $canBeEmpty = true) : string - { - $string = trim($string); - - $string = strip_tags($string); - - if (!$canBeEmpty) { - $string = self::stringValidation($string, $session); - } - - return $string; - } - - public static function sqlSafeValidation(string $string, Session $session, bool $canBeEmpty = true) : string - { - $string = trim($string); - - if (!$canBeEmpty) { - $string = self::stringValidation($string, $session); - } - - return addslashes($string); - } - - public static function filterValidation(string $string, int $filter): string - { - if (filter_var($string, $filter)) { - return $string; - } - return ''; - } - - /** - * Check the empty space, back quote, html and sql constraints - */ - public static function completeValidation(string $string, Session $session) : string - { - $string = self::stringValidation($string, $session); - $string = self::htmlSafeValidation($string, $session); - return self::sqlSafeValidation($string, $session, false); - } - - /** - * /** - * Check if the string is a valid view for the url generation. - * - * Valid strings : 'brand', 'category', 'content', 'folder', 'product'. - * (case-insensitive) - * @param ?string $string - * @return bool Return true if the view $string is valid - */ - public static function viewIsValid(?string $string) : bool - { - $type = strtolower($string); - $validTypes = ['brand', 'category', 'content', 'folder', 'product']; - if (!in_array($type, $validTypes)) { - return false; - } - return true; - } - - /** - * @throws Exception - */ - public static function viewIsValidOrEmpty(string $string) : string - { - $type = strtolower($string); - if (self::viewIsValid($type) || $type === 'empty') { - return $string; - } - throw new Exception('Invalid view type : '.$string); - } -} - diff --git a/templates/backOffice/default-twig/assets/css/styles.css b/templates/backOffice/default-twig/assets/css/styles.css deleted file mode 100644 index 476e140..0000000 --- a/templates/backOffice/default-twig/assets/css/styles.css +++ /dev/null @@ -1,302 +0,0 @@ -/* ------------------------------ Begin style of module config ------------------------------ */ - -.top { - margin-bottom: 3%; - justify-content: space-between; -} - -.top-btn:hover{ - background-color: #ccc; -} - -.top-btn{ - border-radius: 10px; - background-color: #f5f5f5; - border-color: #ccc; - transition: all 0.3s; -} - -.add-parent-btn{ - float: right; - border-radius: 10px; -} - -.menu{ - margin: 0 5% 0 5%; - padding-left: 0; - flex-direction: column; -} - -.bottom { - width: 100%; - text-align: right; - margin-top: 3%; -} - -.bottom button{ - border-radius: 10px; -} - -/* ------------------------------ End style of module config ------------------------------ */ - -/* ------------------------------ Begin style of menu item ------------------------------ */ - -.item { - display: flex; - flex-direction: row; - width: 100%; - padding: 5px 10px 5px 10px; - border-bottom: 1px solid #ccc; - align-items: center; -} - -li { - list-style: none; - align-items: center; -} - -ul.menu-item:last-child { - border-bottom: none; -} - -#menu-item-list{ - padding-left: 0; -} - -.btn-group { - margin: 0 30px 0 3%; -} - -.title-container{ - flex: 1; - cursor: pointer; -} - -.drag-and-drop-icon { - font-size: 150%; - margin-right: 3%; - cursor:move; -} - -.leftArrow { - float: left; - cursor: pointer; -} - -.rightArrow { - float: right; - cursor: pointer; -} - -.arrows{ - font-size: 120%; - width: 50px; -} - -.zero-depth { - background-color: #f2f2f2; -} - -.even-depth{ - background-color: #f9f9f9; -} - -.end-arrow { - color: #ccc; -} - -/* ------------------------------ End item ------------------------------ */ - -/* ------------------------------ Begin edit modal ------------------------------ */ - -.top-edit{ - display: flex; - flex-direction: row; - justify-content: space-between; - margin-bottom: 20px; -} - -.edit-modal-line label{ - margin-bottom: 0; -} - -.edit-modal-line label, .edit-modal-line input, .edit-modal-line button { - margin-right: 10px; -} - -.edit-modal-line input, .edit-modal-line button { - height: 32px; - box-sizing: border-box; -} - -.edit-modal-line:last-child{ - margin-bottom: 0; -} - -.dropdown-menu { - padding: 15px; - min-width: 50px; - right: 0; - left: auto; -} - -.dropdown-menu li:hover { - background-color: #ccc; -} - -.rounded{ - border-radius: 10px; -} - -.edit-modal-line select{ - margin-right: 10px; -} - -#selectedLanguageBtn{ - color: #646464; -} - -#selectedLanguageBtn:hover{ - color: black; -} - -.itemList option { - display: none; -} - -.edit-menu-flags{ - width: 30px; -} - -.item-name-by-language-maskable{ - margin: 5px 0 5px 0; -} - -.item-name-by-language-maskable input{ - margin-right: 5px; - width: calc(100% - 40px); -} - -/* ------------------------------ End edit modal ------------------------------ */ - -/* ------------------------------ Begin edit modal && add modal ------------------------------ */ - -.item-name-by-language { - display: flex; - align-items: center; - justify-content: center; - margin: 5px 0 5px 0; -} - -.item-name-by-language input { - width: 50%; - margin-right: 5px; -} - -.item-name-by-language img, .item-name-by-language-maskable img{ - height: calc(100% - 10px); -} - -.edit-modal-line { - margin: 15px 0 15px 0; -} - -#menuItemEdit, #menuItemAddChild{ - width: 100%; - margin-top: 5px; -} -/* ------------------------------ End edit modal && add modal ------------------------------ */ - -/* ------------------------------ Begin drop down ------------------------------ */ - -.drop-indicator { - position: absolute; - height: 4px; - background-color: black; - opacity: 50%; -} -/* ------------------------------ End drop down ------------------------------ */ - -/* ------------------------------ Begin preview ------------------------------ */ - -#preview-menu { - width: 100%; - margin: 3% 0; - border: rgba(200, 0, 0, 0.2) 1px solid; - - h3 { - margin: 1%; - } - - #menus { - display: flex; - flex-direction: row; - background-color: #f5f5f5; - padding: 0 2%; - } - - .parent { - display: none; - position: absolute; - background-color: #f5f5f5; - width: fit-content; - left: 0; - z-index: 1; - box-shadow: 5px 5px 5px grey; - } - - .deep { - display: none; - position: absolute; - background-color: #f5f5f5; - top: 0; - z-index: 1; - left: 100%; - } - - li { - position: relative; - } - - li:hover>.parent { - display: block; - } - - li:hover>.deep { - display: block; - } - - li:hover { - background-color: #f49a17; - } - - li>a{ - display: block; - padding: 10px 15px; - } - - li:hover>a { - color: #fff; - } - - a { - text-decoration: none; - color: #7a7a7a; - white-space: nowrap; - font-family: 'Open Sans',sans-serif; - } - - ul { - padding: 0; - } - /* ------------------------------ End preview ------------------------------ */ - - .list-style-type{ - display:none; - padding: 0; - } -} - -.error { - color: red; -} \ No newline at end of file diff --git a/templates/backOffice/default-twig/assets/js/main.js b/templates/backOffice/default-twig/assets/js/main.js deleted file mode 100644 index 78ff569..0000000 --- a/templates/backOffice/default-twig/assets/js/main.js +++ /dev/null @@ -1,1249 +0,0 @@ -// The screen hands its payload over in data- attributes on #cfm-screen: the catalogue -// of pickable targets, the menus, the current selection, the locale and the JS strings. -const CFM_SCREEN = document.getElementById('cfm-screen') - -var MENU_NAMES -var MENU_LIST -var CURRENT_SELECTED_MENU_ID = parseInt(CFM_SCREEN.dataset.cfmCurrentMenuId, 10) -var LOCALE = CFM_SCREEN.dataset.cfmLocale -var loopsDictionary = JSON.parse(CFM_SCREEN.dataset.cfmTargets) -var translations = JSON.parse(CFM_SCREEN.dataset.cfmTranslations) -var buttonState = 'hide' -let CURRENT_ID = null -let allowUnload = false -let selectedLanguage -const quotePattern = '&280"e&280&' -const percentPattern = '&280&percent&280&' - -// Get from json -function getFromJson(json) { - return JSON.parse(decodeURIComponent(replaceQuoteAndPercent(json))) -} - -// End get from json - -// Get value by locale -function getValueByLocaleOf(element, locale) { - if (!locale) { - locale = LOCALE - } - let found = false - let result - for (const [lang, title] of Object.entries(element)) { - if (lang === locale) { - result = title - found = true - break - } - if (lang === 'en_US') { - result = title - found = true - } - } - if (!found) { - result = element[Object.keys(element)[0]] - } - return result -} -// End get value by locale - -// Close closest modal -function closeClosestModal(element) { - let modal = element.closest('.modal'); - if (modal) { - bootstrap.Modal.getOrCreateInstance(modal).hide(); - } -} -// End close closest modal - -// Current id -function getCurrentId() { - if (CURRENT_ID === null) { - console.error("CURRENT_ID not set") - } - return CURRENT_ID -} - -function setCurrentId(id) { - CURRENT_ID = id -} -// End current id - -// Get next id -function getNextId() { - let nextId = 1 - let arrayOfIds = getAllIdOf(MENU_LIST) - arrayOfIds.sort((a, b) => a - b) - for (const id of arrayOfIds) { - if (id !== nextId) { - break - } - nextId++ - } - return nextId -} - -function getAllIdOf(list) { - let arrayOfIds = [] - for (const menuItem of list) { - arrayOfIds.push(menuItem.id) - if (menuItem.children && menuItem.children.length > 0) { - let children = menuItem.children - for (const child of children) { - if (!arrayOfIds.includes(child.id)) { - arrayOfIds.push(child.id) - } - if (!child.children || child.children.length <= 0) { - continue - } - const result = getAllIdOf(child.children) - - for (const id of result) { - if (!arrayOfIds.includes(id)) { - arrayOfIds.push(id) - } - } - } - } - } - return arrayOfIds -} -// End get next id - -// Replace annoying characters -function replaceQuoteAndPercent(string) { - while (string.includes("\\'") || string.includes("%")) { - string = string - .replace("\\'", quotePattern) - .replace("%", percentPattern); - } - return string -} - -function putQuoteAndPercent(string) { - while (string.includes(quotePattern) || string.includes(percentPattern)) { - string = string - .replace(quotePattern, "'") - .replace(percentPattern, "%"); - } - return string -} - -function replaceAllQuotesAndPercent(MenuList) { - for (const val of MenuList) { - replaceAllQuotesAndPercentRec(val) - } -} - -function replaceAllQuotesAndPercentRec(MenuList) { - for (const [lang, title] of Object.entries(MenuList.title)) { - MenuList.title[lang] = putQuoteAndPercent(title) - } - - if (!MenuList.children || MenuList.children.length <= 0) { - return - } - for (let child of MenuList.children) { - replaceAllQuotesAndPercentRec(child) - } -} -// End replace annoying characters - -// Add menu -function addMenu() { - const menuName = document.getElementById('menuName').value; - const errorMessageEmpty = document.getElementById('error-message-empty'); - const errorMessageBackQuote = document.getElementById('error-message-back-quote'); - - if (menuName.trim().length === 0) { - errorMessageEmpty.style.display = 'block'; - errorMessageBackQuote.style.display = 'none'; - } else if (menuName.includes("`")) { - errorMessageEmpty.style.display = 'none'; - errorMessageBackQuote.style.display = 'block'; - } else { - bootstrap.Modal.getOrCreateInstance(document.getElementById('ConfirmAddMenu')).hide(); - errorMessageEmpty.style.display = 'none'; - errorMessageBackQuote.style.display = 'none'; - document.getElementById('addMenuForm').submit(); - } -} - -function addInList(id, item, list) { - list = list.map(function (element) { - if (element.id === id) { - if (!Array.isArray(element.children)) { - element.children = [] - } - element.children.push(item) - } - if (element.children && element.children.length > 0) { - element.children = addInList(id, item, element.children) - } - return element; - }) - return list -} - -function addCustomMenuItem(element, id = "0") { - const form = element.form - if (!isValid(form)) { - return - } - - let [menuItemName, menuItemType, menuItemUrl] = getFormItems(form) - let menu = findMenuInList(id, MENU_LIST) - let depthToAdd = 0 - if (menu !== null) { - depthToAdd = menu.depth + 1 - } - let newItem = { - id: getNextId(), - title: menuItemName, - type: menuItemType, - depth: depthToAdd, - children: [] - } - - if (menuItemType.toLowerCase() !== "url"){ - newItem.typeId = menuItemUrl - } - else if (menuItemType.toLowerCase() !== "empty"){ - newItem.url = menuItemUrl - } - - let newMenu = generateMenuRecursive(newItem) - if (menu === null) { - document.getElementById('menu-item-list').innerHTML += newMenu - MENU_LIST.push(newItem) - } else { - let childNodes = document.getElementById(id).parentNode.childNodes - let ulElement = null - for (let i = 0; i < childNodes.length; i++) { - if (childNodes[i].nodeType === Node.ELEMENT_NODE && childNodes[i].classList.contains('menu-item')) { - ulElement = childNodes[i]; - break; - } - } - if (ulElement) { - ulElement.innerHTML += newMenu; - MENU_LIST = addInList(id, newItem, MENU_LIST); - - // Add sub-menu icon if not already present - let parentElement = document.getElementById(id).parentNode; - let titleContainer = parentElement.querySelector('.title-container'); - if (titleContainer && !titleContainer.querySelector('.tree-icon')) { - let titleSpan = titleContainer.querySelector('[data-id="titleSpan"]'); - if (titleSpan) { - titleSpan.insertAdjacentHTML('afterend', ' '); - } - } - - // Open the parent menu - const treeIcon = parentElement.querySelector('.tree-icon'); - const childrenUl = parentElement.querySelector('ul'); - if (treeIcon === null) { - return - } - if (childrenUl) { - childrenUl.style.display = 'block' - treeIcon.classList.remove('fa-caret-up'); - treeIcon.classList.add('fa-caret-down'); - } - } - } - deleteEditField(form.id); - generatePreviewMenus(); - updateArrowStyles(); - - closeClosestModal(form); -} -// End add menu - -// Find menu -function findMenuInList(id, list) { - for (const menuItem of list) { - if (menuItem.id === id) { - return menuItem - } - if (menuItem.children && menuItem.children.length > 0) { - let children = menuItem.children - for (const child of children) { - let result = findMenuInList(id, children) - if (result) { - return result - } - } - } - } - return null -} -// End find menu - -// Edit menu -function changeParameters(id) { - const form = document.getElementById('editMenuItemForm') - if (!isValid(form)) { - return - } - - const [title, type, url] = getFormItems(form) - const menuItem = document.getElementById(id).parentElement - if (menuItem === null) { - console.error("The id given in changeParameters parameter doesn't exist") - return - } - - saveTitleTypeAndUrl(id, title, type, url) - - const titleSpan = menuItem.querySelector('[data-id="titleSpan"]') - titleSpan.textContent = getValueByLocaleOf(findMenuInList(id, MENU_LIST).title) - - deleteEditField('editMenuItemForm') - generatePreviewMenus() - closeClosestModal(form) -} - -function getFormItems(form) { - let listOfNames = {} - let listOfUrls = {} - let found = false - let englishOrLocaleName = "" - let englishOrLocaleUrl = "" - - const menuItemNameInputs = form.getElementsByClassName("item-name-by-language") - for (child of menuItemNameInputs){ - const input = child.querySelector("input") - const locale = input.getAttribute("data-locale") - const nameOfMenu = input.value.trim() - listOfNames[input.getAttribute("data-locale")] = input.value.trim() - if (!found && locale === LOCALE && nameOfMenu !== ""){ - englishOrLocaleName = nameOfMenu - found = true - } - else if(!found && locale === "en_US"){ - englishOrLocaleName = nameOfMenu - } - } - - if (englishOrLocaleName !== ""){ - for (let [local, name] of Object.entries(listOfNames)){ - if (name === ""){ - listOfNames[local] = englishOrLocaleName - } - } - } - - let menuItemType = form.elements['menuType'].value.trim() - if (menuItemType === null || menuItemType === '') { - menuItemType = 'empty' - } - - if (menuItemType === 'url') { - const menuItemUrlInputs = form.getElementsByClassName("menu-item-url") - found = false - for (input of menuItemUrlInputs){ - const locale = input.getAttribute("data-locale") - const urlOfMenu = input.value.trim() - listOfUrls[input.getAttribute("data-locale")] = input.value.trim() - if (!found && locale === LOCALE && urlOfMenu !== ""){ - englishOrLocaleUrl = urlOfMenu - found = true - } - else if(!found && locale === "en_US"){ - englishOrLocaleUrl = urlOfMenu - } - } - - if (englishOrLocaleUrl !== ""){ - for (let [local, name] of Object.entries(listOfUrls)){ - if (name === ""){ - listOfUrls[local] = englishOrLocaleUrl - } - } - } - } - else{ - listOfUrls = form.elements['menuItemProduct'].value.trim() - } - return [listOfNames, menuItemType, listOfUrls] -} -// End edit menu - -// Delete menu -function deleteMenuItem(id) { - let elementToRemove = document.getElementById(id).parentElement; - - let parentInMenuList = findParentOf(id, MENU_LIST) - if (parentInMenuList[1].children && parentInMenuList[1].children.length === 1) { - const parentInHtml = elementToRemove.parentElement.parentElement; - const treeIcon = parentInHtml.querySelector('.tree-icon') - treeIcon.classList.remove('fa-caret-up') - treeIcon.classList.remove('fa-caret-down') - } - - if (!elementToRemove) { - console.error("The id doesn't exist") - return - } - - if (elementToRemove.remove) { - elementToRemove.remove() - } else { - elementToRemove.parentNode.removeChild(elementToRemove) - } - MENU_LIST = deleteFromList(id, MENU_LIST) - generatePreviewMenus() -} - -function deleteFromList(id, list) { - list = list.filter(function (element) { - if (element.children && element.children.length > 0) { - element.children = deleteFromList(id, element.children) - } - return element.id !== id; - }) - return list -} - -function deleteMenu() { - document.getElementById('deleteForm').submit(); -} -// End delete menu - -// Validation -function isValid(form) { - const errorMessageTitle = form.querySelector('#error-message-title') - const errorMessageUrl = form.querySelector('#error-message-url') - errorMessageTitle.style.display = 'none'; - errorMessageUrl.style.display = 'none'; - - const menuItemNames = form.getElementsByClassName("item-name-by-language") - let found = false - let englishOrLocaleName - - for (nameInput of menuItemNames){ - input = nameInput.querySelector("input") - - const locale = input.getAttribute("data-locale") - const nameOfMenu = input.value.trim() - if (nameOfMenu.includes("`")){ - errorMessageTitle.style.display = 'block'; - return false - } - - if (!found && locale === LOCALE && nameOfMenu !== ""){ - englishOrLocaleName = nameOfMenu - found = true - } - else if(!found && locale === "en_US"){ - englishOrLocaleName = nameOfMenu - } - } - - const menuItemType = form.elements['menuType'].value.trim() - const errorType = form.getElementsByClassName("error")[0] - errorType.innerText = "" - if (englishOrLocaleName === ""){ - errorType.innerText = "English value or local value must be entered for the title" - return false - } - - if (menuItemType === ""){ - errorType.innerText = "Choose a category" - return false - } - if (!(menuItemType in loopsDictionary) && menuItemType !== "url" && menuItemType !== "empty"){ - errorType.innerText = "Invalid selection" - return false - } - - if (menuItemType !== "url" && menuItemType !== "empty"){ - let found = false - const menuItemUrl = form.elements['menuItemProduct'].value - for (const [key, value] of Object.entries(loopsDictionary[menuItemType])){ - if (value.title + "-" + value.id === menuItemUrl || (value.reference && value.title + "-" + value.reference + "-" + value.id === menuItemUrl)){ - found = true - break - } - } - if (!found){ - errorType.innerText = "Invalid " + menuItemType - return false - } - } - else if (menuItemType === "url"){ - const menuItemUrls = form.getElementsByClassName("menu-item-url") - let found = false - let englishOrLocaleUrl - - for (const urlInput of menuItemUrls){ - - const locale = urlInput.getAttribute("data-locale") - const urlOfMenu = urlInput.value.trim() - if (urlOfMenu.includes("`")){ - errorMessageTitle.style.display = 'block'; - return false - } - - if (!found && locale === LOCALE && urlOfMenu !== ""){ - englishOrLocaleUrl = urlOfMenu - found = true - } - else if(!found && locale === "en_US"){ - englishOrLocaleUrl = urlOfMenu - } - } - - if (englishOrLocaleUrl === ""){ - errorType.innerText = "English value or local value must be entered for the url" - return false - } - } - - return true -} -// End validation - -// Save data -function saveData() { - allowUnload = true - document.getElementById('menuData').value = JSON.stringify(MENU_LIST) - document.getElementById('menuDataId').value = JSON.stringify(CURRENT_SELECTED_MENU_ID) - document.getElementById('savedData').submit() -} - -function saveMenuItemName() { - const editForm = document.getElementById('editMenuItemForm') - if (!isValid(editForm)) { - return - } - - const modifiedLocal = selectedLanguage ? selectedLanguage : LOCALE; - menuToModify = findMenuInList(CURRENT_ID, MENU_LIST) - - if (menuToModify === null) { - console.error("The id given in saveMenuItemName doesn't exist") - return - } - - menuToModify.title[modifiedLocal] = editForm["menuItemName"].value; - - const titleSpan = document.getElementById(getCurrentId()).parentElement.querySelector('[data-id="titleSpan"]') - titleSpan.textContent = getValueByLocaleOf(findMenuInList(getCurrentId(), MENU_LIST).title) - - generatePreviewMenus() -} - -function saveMenuItemUrl() { - const editForm = document.getElementById('editMenuItemForm') - if (!isValid(editForm)) { - return - } - - const menuToModify = findMenuInList(CURRENT_ID, MENU_LIST) - - if (menuToModify === null) { - console.error("The id given in saveMenuItemUrl doesn't exist") - return - } - - const itemType = editForm["menuType"].value - menuToModify.type = itemType - - if (itemType.toLowerCase() === "url") { - const modifiedLocal = selectedLanguage ? selectedLanguage : LOCALE - menuToModify.url[modifiedLocal] = editForm["menuItem"].value - } else { - menuToModify.typeId = editForm["menuItem"].value - } -} - -function saveTitleTypeAndUrl(id, title, type, url) { - const menuToModify = findMenuInList(id, MENU_LIST) - - if (menuToModify === null) { - console.error("The id given in saveTitleTypeAndUrl doesn't exist") - return - } - - menuToModify.title = title - menuToModify.type = type - if (type.toLowerCase() !== "url"){ - menuToModify.typeId = url - } - else{ - menuToModify.url = url - } -} -// End save data - -// Form edit field -function setEditFields(id) { - CURRENT_ID = id - const element = findMenuInList(id, MENU_LIST) - if (element === null) { - console.error("The id given in setEditField doesn't exist") - return - } - const form = document.getElementById('editMenuItemForm') - form.elements['menuType'].value = element.type.toLowerCase() - - const menuTitles = element.title - for (const inputToFill of form.elements['menuItemName']){ - const title = menuTitles[inputToFill.getAttribute("data-locale")] - if (title){ - inputToFill.value = title - } - } - - if (element.type.toLowerCase() !== 'url' && element.type.toLowerCase() !== "empty") { - form.elements['menuItemProduct'].value = element.typeId - } - else if (element.type.toLowerCase() === 'url'){ - const menuItemUrls = form.getElementsByClassName("menu-item-url") - for (const urlInput of menuItemUrls){ - urlInput.parentNode.style.display = "block" - const url = element.url[urlInput.getAttribute("data-locale")] - if (url){ - urlInput.value = url - } - } - } - else{ - for (const urlInput of form.getElementsByClassName("menu-item-url")){ - urlInput.parentNode.style.display = "none" - } - form.elements['menuItemProduct'].style.display = "none" - } - - const select = document.getElementById('select-edit-type') - updateInputOrDatalist(select) -} - -function deleteEditField(formId) { - const form = document.getElementById(formId) - for (const inputToClear of form.querySelectorAll("input")){ - inputToClear.value = "" - } -} -// End form edit field - -// Generate menu -function generateSelect(list) { - let menu = document.getElementById('selectMenuName') - menu.innerHTML = "" - for (const menuName of list) { - let option = document.createElement('option'); - option.text = menuName.title; - option.id = menuName.id; - if (option.id === "menu-selected-" + CURRENT_SELECTED_MENU_ID) { - option.selected = true; - } - menu.appendChild(option); - } -} - -function generateMenu(list) { - let menu = document.getElementById('menu-item-list') - menu.innerHTML = "" - for (const menuItem of list) { - menu.innerHTML += generateMenuRecursive(menuItem) - } - updateArrowStyles(); -} - -function generateMenuRecursive(menuItem) { - let depth = "zero-depth" - if (menuItem.depth !== 0) { - depth = "" - if (menuItem.depth % 2 === 0) { - depth = "even-depth" - } - } - - let children = "" - if (menuItem.children && menuItem.children.length > 0) { - for (const child of menuItem.children) { - children += generateMenuRecursive(child) - } - } - - let arrowSpan = "" - if (children !== "") { - arrowSpan = ` `; - } - - let newMenu = ` -
    • - -
        - ` + children + ` -
      -
      • ` - - updateArrowStyles(); - return newMenu; -} -// End generate menu - -// Move menu -function moveMenuUp(id) { - menuToMove = document.getElementById(id).parentNode - if (menuToMove.previousElementSibling) { - menuToMove.parentElement.insertBefore(menuToMove, menuToMove.previousElementSibling) - } - - MENU_LIST = moveMenuUpInList(id, MENU_LIST) - generatePreviewMenus() - updateArrowStyles(); -} - - -function moveMenuDown(id) { - menuToMove = document.getElementById(id).parentElement - if (menuToMove.nextElementSibling) { - menuToMove.parentElement.insertBefore(menuToMove.nextElementSibling, menuToMove) - } - - MENU_LIST = moveMenuDownInList(id, MENU_LIST) - generatePreviewMenus() - updateArrowStyles(); -} - -function moveMenuUpInList(id, list) { // recursive - for (let i = 0; i < list.length; i++) { - if (list[i].id === id) { - if (i > 0) { - let temp = list[i] - list[i] = list[i - 1] - list[i - 1] = temp - } - return list - } - if (list[i].children && list[i].children.length > 0) { - list[i].children = moveMenuUpInList(id, list[i].children) - } - } - return list -} - -function moveMenuDownInList(id, list) { - for (let i = 0; i < list.length; i++) { - if (list[i].id === id) { - if (i < list.length - 1) { - let temp = list[i] - list[i] = list[i + 1] - list[i + 1] = temp - } - return list - } - if (list[i].children && list[i].children.length > 0) { - list[i].children = moveMenuDownInList(id, list[i].children) - } - } - return list -} - -function updateArrowStyles() { - const ulItems = document.querySelectorAll('.menu-item'); - - ulItems.forEach((ul) => { - const liItems = ul.querySelectorAll(':scope > li'); - liItems.forEach((li, index) => { - const upArrow = li.querySelector('.leftArrow i'); - const downArrow = li.querySelector('.rightArrow i'); - - if (upArrow) { - upArrow.classList.remove('end-arrow'); - } - if (downArrow) { - downArrow.classList.remove('end-arrow'); - } - - if (index === 0 && upArrow) { - upArrow.classList.add('end-arrow'); - } - if (index === liItems.length - 1 && downArrow) { - downArrow.classList.add('end-arrow'); - } - }); - }); -} -// End move menu - -// Drop down -function toggleTopLevelVisibility() { - const button = document.getElementById('toggle-all-children'); - const isVisible = (buttonState === 'hide'); - - MENU_LIST.forEach(item => { - if (item.depth === 0) { - const itemId = item.id.toString(); - const listItem = document.getElementById(itemId); - if (listItem) { - const childrenUl = listItem.parentElement.querySelector('ul'); - if (childrenUl && childrenUl.tagName === 'UL') { - childrenUl.style.display = isVisible ? 'none' : 'block'; - const treeIcon = listItem.querySelector('.tree-icon'); - if (treeIcon) { - treeIcon.classList.toggle('fa-caret-down', !isVisible); - treeIcon.classList.toggle('fa-caret-up', isVisible); - } - } - } - } - }); - buttonState = isVisible ? 'show' : 'hide'; - button.textContent = isVisible ? translations.showAllChildren : translations.hideAllChildren; -} - -function toggleChildren(span, event) { - - if (event.target.closest('.priority-over-drop-and-down')) { - return; - } - - const listItem = span.closest('.item').parentElement; - const treeIcon = listItem.querySelector('.tree-icon'); - const childrenUl = listItem.querySelector('ul'); - - if (treeIcon === null) { - return - } - - if (childrenUl) { - childrenUl.style.display = childrenUl.style.display === 'none' ? 'block' : 'none'; - treeIcon.classList.remove('fa-caret-up'); - treeIcon.classList.add('fa-caret-down'); - if (childrenUl.style.display === 'none') { - treeIcon.classList.remove('fa-caret-down'); - treeIcon.classList.add('fa-caret-up'); - } - } -} - -// End drop down - -// Drag and drop -function drag(ev) { - ev.dataTransfer.setData("text/plain", ev.target.children[0].id); -} - -function drop(ev) { - ev.stopPropagation(); - ev.preventDefault(); - - document.querySelector('.drop-indicator').style.display = 'none' - - var data = ev.dataTransfer.getData("text/plain"); - var draggedItemId = parseInt(data); - - var draggedItem = findMenuInList(draggedItemId, MENU_LIST); - - if (draggedItem) { - var targetItemId = parseInt(ev.target.closest(".item").id) - - var rect = ev.target.closest("div.item").getBoundingClientRect() - var mouseY = ev.clientY - rect.top; - var mouseX = ev.clientX - rect.left; - - const insertionBefore = mouseY < rect.height / 2 - const insertAsChild = !insertionBefore && mouseX > rect.width / 6 - - // inserts the moved element before or after the target element, depending on the drop position - const problems = insertMenuItem(draggedItemId, targetItemId, insertionBefore, insertAsChild) - - if (problems === 0) { - console.log("success") - } else if (problems === 1) { - console.log("OSKOUR: element not found in list") - } else if (problems === 2) { - console.log("is parent") - } else if (problems === 3) { - console.log("same element") - } - - generateMenu(MENU_LIST) - - generatePreviewMenus(); - - const button = document.getElementById('toggle-all-children'); - const isVisible = false; - buttonState = isVisible ? 'show' : 'hide'; - button.textContent = isVisible ? translations.showAllChildren : translations.hideAllChildren; - - } else { - console.error("L'élément avec l'ID", draggedItemId, "n'a pas été trouvé dans MENU_LIST."); - } -} - -function insertMenuItem(draggedItemId, positionToInsert, insertionBefore, insertAsChild) { - if (draggedItemId === positionToInsert) { - return 3 - } - - if (draggedItemId >= 0) { - if (isParentOf(draggedItemId, positionToInsert)) { - let [root, parentOfDragged] = findParentOf(draggedItemId, MENU_LIST) - if (root === 0) { - parentOfDragged = MENU_LIST - } - if (!parentOfDragged) { - return 1 - } - - let draggedItem = findMenuInList(draggedItemId, MENU_LIST) - while (draggedItem.children.length > 0) { - let popedChild = draggedItem.children.pop() - if (root === 0) { - MENU_LIST.splice(MENU_LIST.indexOf(draggedItem) + 1, 0, popedChild) - } else { - parentOfDragged.children.splice(parentOfDragged.children.indexOf(draggedItem) + 1, 0, popedChild) - } - popedChild.depth = (root === 0) ? 0 : parentOfDragged.depth + 1 - updateDepth(popedChild, popedChild.depth) - } - } - if (insertAsChild) { - let newParent = findMenuInList(positionToInsert, MENU_LIST) - if (newParent === null) { - return 1 - } - - const draggedItem = popFromMenuList(draggedItemId, MENU_LIST) - - if (newParent.children == null) { - newParent.children = [draggedItem] - } else { - newParent.children.push(draggedItem) - } - draggedItem.depth = newParent.depth + 1 - updateDepth(draggedItem, draggedItem.depth) - return 0 - } - - let [root, parent] = findParentOf(positionToInsert, MENU_LIST) - - let menuToMove = popFromMenuList(draggedItemId, MENU_LIST) - if (menuToMove == null) { - return 1 - } - if (root === 0) { - insertionBefore ? MENU_LIST.splice(MENU_LIST.indexOf(parent), 0, menuToMove) : MENU_LIST.splice(MENU_LIST.indexOf(parent) + 1, 0, menuToMove) - menuToMove.depth = 0 - } else { - insertionBefore ? parent.children.splice(parent.children.indexOf(findMenuInList(positionToInsert, MENU_LIST)), 0, menuToMove) : parent.children.splice(parent.children.indexOf(findMenuInList(positionToInsert, MENU_LIST)) + 1, 0, menuToMove) - menuToMove.depth = parent.depth + 1 - } - - updateDepth(menuToMove, menuToMove.depth) - return 0 - } - return null -} - -function isParentOf(parent, child) { - let parentElement = findMenuInList(parent, MENU_LIST) - if (parentElement.children && parentElement.children.length > 0) { - for (const childElement of parentElement.children) { - if (childElement.id === child || isParentOf(childElement.id, child)) { - return true - } - } - } - return false -} - -function updateDepth(menuItem, depth) { - if (menuItem.children && menuItem.children.length > 0) { - for (const child of menuItem.children) { - child.depth = depth + 1 - updateDepth(child, child.depth) - } - } -} - -function findParentOf(id, list) { - for (const menuItem of list) { - if (menuItem.id === id) { - return [0, menuItem] - } - if (menuItem.children && menuItem.children.length > 0) { - let children = menuItem.children - for (const _ of children) { - let result = findParentOf(id, children) - if (result) { - if (result[0] === 0) { - return [1, menuItem] - } - return result - } - } - } - } - return null -} - -function popFromMenuList(id, list) { - for (const menuItem of list) { - if (menuItem.id === id) { - if (menuItem.depth < 1) { - return list.splice(list.indexOf(menuItem), 1)[0] - } - return menuItem - } - if (menuItem.children && menuItem.children.length > 0) { - let children = menuItem.children - for (const child of children) { - let result = popFromMenuList(id, children) - if (result) { - if (children.indexOf(result) !== -1) { - return children.splice(children.indexOf(result), 1)[0] - } - return result - } - } - } - } - return null -} - -function findMenuItemById(itemId) { - return MENU_LIST.find(item => item.id === itemId); -} - -function allowDrop(ev) { - ev.preventDefault(); - const dropIndicator = document.querySelector('.drop-indicator'); - - try { - // retrieve mouse position relative to the target element - const rect = ev.target.closest("div.item").getBoundingClientRect(); - const mouseY = ev.clientY - rect.top; - const mouseX = ev.clientX - rect.left; - - const targetItem = ev.target.closest(".item").parentElement; - // display bar above or below the target element - - dropIndicator.style.left = targetItem.offsetLeft + 'px'; // positions the bar to the left of the target element - dropIndicator.style.width = targetItem.offsetWidth + 'px'; // adjust bar width to that of the target elem - - if (mouseY < rect.height / 2) { // if the mouse is over the target element - dropIndicator.style.top = targetItem.offsetTop + 'px'; // position the bar above the target element - } else { // if the mouse is below the target element => positions bar below - dropIndicator.style.top = (targetItem.offsetTop + targetItem.offsetHeight) + 'px'; - if (mouseX > rect.width / 6) { // if the mouse is to the right of the target element - dropIndicator.style.left = (targetItem.offsetLeft + targetItem.offsetWidth * 0.04) + 'px'; - dropIndicator.style.width = (targetItem.offsetWidth * 0.96) + 'px'; - } - } - dropIndicator.style.display = 'block'; - } catch { - dropIndicator.style.display = 'none'; - } -} -// End drag and drop - -// Preview -function generatePreviewMenus() { - const previewUl = document.getElementById('menus') - previewUl.innerHTML = "" - for (const menuItem of MENU_LIST) { - previewUl.innerHTML += generatePreviewMenuRecursive(menuItem, 1) - } -} - -function generatePreviewMenuRecursive(menuItem) { - let children = "" - if (menuItem.children && menuItem.children.length > 0) { - for (const child of menuItem.children) { - children += generatePreviewMenuRecursive(child) - } - } - let classes = (menuItem.depth >= 1) ? "parent deep" : "parent" - return ` -
    • - ` + getValueByLocaleOf(menuItem.title) + ` -
        - ` + children + ` -
      -
      • - `; -} -// End Preview - -// Search product -function searchProducts(query, formId) { - const matchingProducts = document.querySelector(`#${formId} ~ ul`); - matchingProducts.innerHTML = ''; - - if (query.trim() === '') return; - - const filteredProducts = products.filter(product => - product.title.toLowerCase().includes(query.toLowerCase()) - ); - - filteredProducts.forEach(product => { - const li = document.createElement('li'); - li.textContent = `${product.title} (${product.ref})`; - li.addEventListener('click', () => { - document.querySelector(`#${formId} input[name="menuItem"]`).value = product.url; - }); - matchingProducts.appendChild(li); - }); -} - -function addOptionsOfSelectedCategory() { - const menuTypeSelect = document.getElementsByClassName('menuType'); - for (const category of menuTypeSelect) { - for (const key in loopsDictionary) { - const option = document.createElement('option'); - option.value = key; - option.textContent = key; - category.appendChild(option); - } - } -} - -function updateDataList(selectedKey, parentDiv) { - const dataList = parentDiv.querySelector('.itemList'); - dataList.innerHTML = ""; - - if (loopsDictionary[selectedKey]) { - loopsDictionary[selectedKey].forEach(item => { - const option = document.createElement('option'); - option.value = `${item.title}-${item.id}`; - if (item.reference) { - option.value = `${item.title}-${item.reference}-${item.id}`; - } - dataList.appendChild(option); - }); - } -} - -function updateInputOrDatalist(selectElement) { - const selectedKey = selectElement.value; - const form = selectElement.form; - const parentDiv = selectElement.closest('.edit-modal-line'); - const languageDivs = form.getElementsByClassName('item-name-by-language-maskable'); - const datalistElement = form.getElementsByClassName("itemList")[0] - const defaultInputElement = form['menuItemProduct']; - - if (selectedKey === "" || selectedKey === "empty") { - defaultInputElement.style.display = "none"; - defaultInputElement.value = ""; - datalistElement.style.display = "none"; - for (const div of languageDivs){ - div.style.display = "none"; - }; - } else if (selectedKey === "url") { - defaultInputElement.style.display = "none"; - datalistElement.style.display = "none"; - datalistElement.innerHTML = ""; - for (const div of languageDivs){ - div.style.display = "block"; - }; - } else { - defaultInputElement.style.display = "block"; - datalistElement.style.display = "block"; - updateDataList(selectedKey, parentDiv); - for (const div of languageDivs){ - div.style.display = "none"; - }; - } -} - -function resetSelect(modalId) { - const form = document.getElementById(modalId).getElementsByTagName("form")[0] - form.reset() - const selectElement = form['menuType'] - const options = selectElement.getElementsByTagName('option') - - for (const option of options) { - if (option.value === "") { - selectElement.insertBefore(option, options[0]); - option.disabled = true; - break; - } - } - - const languageDivs = form.getElementsByClassName('item-name-by-language-maskable'); - for (const div of languageDivs){ - div.style.display = "none"; - }; - - const menuItemProduct = form["menuItemProduct"]; - menuItemProduct.style.display = "none"; -} - -function resetTargetField(select) { - select.form["menuItemProduct"].value = "" -} -// End search product - -// Event Listener -window.addEventListener('beforeunload', function(event) { - if (!allowUnload) { - event.preventDefault(); - } -}, { capture: true }); - -document.getElementById('selectMenuName').addEventListener('change', function() { - const selectedOption = this.options[this.selectedIndex]; - - document.getElementById('menuId').value = selectedOption.id; - document.getElementById('askedMenu').submit(); -}); -// End Event Listener - -// Initialization -window.onload = function() { - - // Get data - MENU_NAMES = getFromJson(CFM_SCREEN.dataset.cfmMenuNames) - MENU_LIST = getFromJson(CFM_SCREEN.dataset.cfmMenuItems) - replaceAllQuotesAndPercent(MENU_LIST) - for (let menu of MENU_NAMES){ - menu.title = putQuoteAndPercent(menu.title) - } - - // Generate elements - generateSelect(MENU_NAMES) - generateMenu(MENU_LIST) - generatePreviewMenus() - document.getElementById('deleteForm').elements['menuNameToDelete'].value = CURRENT_SELECTED_MENU_ID - - // Disable buttons if there aren't any menu - if (CURRENT_SELECTED_MENU_ID === 'undefined' || CURRENT_SELECTED_MENU_ID === -1 || isNaN(CURRENT_SELECTED_MENU_ID)) { - let listToDelete = Array.from(document.getElementsByClassName('delete-if-no-menu')) - listToDelete.forEach(function (elementToDelete) { - elementToDelete.disabled = true - }) - } - - addOptionsOfSelectedCategory(); -} -// End Initialization \ No newline at end of file diff --git a/templates/backOffice/default-twig/custom-front-menu/_target_field.html.twig b/templates/backOffice/default-twig/custom-front-menu/_target_field.html.twig new file mode 100644 index 0000000..afe0f55 --- /dev/null +++ b/templates/backOffice/default-twig/custom-front-menu/_target_field.html.twig @@ -0,0 +1,34 @@ +{# + The target field, which depends on the chosen kind. Swapped in by HTMX when the kind + changes, so no module JavaScript is needed. +#} +{% set domain = 'customfrontmenu.bo.default-twig' %} + +
      + {% if view == 'url' %} + {% for lang in bo_languages() %} +
      + + {{ lang.title }} + + +
      + {% endfor %} +
      {{ 'Only http, https and site-relative addresses are kept.'|trans({}, domain) }}
      + + {% elseif view in ['brand', 'category', 'content', 'folder', 'product'] %} + + + {% else %} +
      {{ 'This entry is a label with no link.'|trans({}, domain) }}
      + {% endif %} +
      diff --git a/templates/backOffice/default-twig/custom-front-menu/_tree_nodes.html.twig b/templates/backOffice/default-twig/custom-front-menu/_tree_nodes.html.twig new file mode 100644 index 0000000..5ba2485 --- /dev/null +++ b/templates/backOffice/default-twig/custom-front-menu/_tree_nodes.html.twig @@ -0,0 +1,71 @@ +{% set domain = 'customfrontmenu.bo.default-twig' %} +{% for item in items %} +
    • +
      + + + + + + {{ item.title }} + + + {% if item.target.kind == 'none' %} + {{ item.target.label }} + {% elseif item.target.kind == 'url' %} + + {{ item.target.label|u.truncate(40, '…') }} + + {% else %} + + {{ item.target.kind|trans({}, domain) }} · {{ item.target.label }} + + {% endif %} + +
      +
      + + +
      +
      + + +
      +
      + + {# A link rather than a modal: filling a shared modal would need module + JavaScript, and the theme registers no controller for us. #} + + + + +
      + + +
      +
      + + {% if item.children|length > 0 %} +
        + {% include '@CustomFrontMenuModule/backOffice/default-twig/custom-front-menu/_tree_nodes.html.twig' with { items: item.children, menuId: menuId } only %} +
      + {% endif %} +
      • +{% endfor %} diff --git a/templates/backOffice/default-twig/custom-front-menu/entry.html.twig b/templates/backOffice/default-twig/custom-front-menu/entry.html.twig new file mode 100644 index 0000000..54cc149 --- /dev/null +++ b/templates/backOffice/default-twig/custom-front-menu/entry.html.twig @@ -0,0 +1,76 @@ +{% extends '@BackOfficeDefaultTwig/base.html.twig' %} + +{% set domain = 'customfrontmenu.bo.default-twig' %} + +{% block title %}{{ entryTitle }}{% endblock %} +{% block body_testid %}custom-front-menu-entry{% endblock %} + +{% block breadcrumb %} + +{% endblock %} + +{% block content %} +
      +

      {{ 'Edit an entry'|trans({}, domain) }}

      + +
      + + +
      +
      {{ 'Label'|trans({}, domain) }}
      +
      + {% for lang in bo_languages() %} +
      + + {{ lang.title }} + + +
      + {% endfor %} +
      {{ 'A language left empty falls back to another one on the front.'|trans({}, domain) }}
      +
      +
      + +
      +
      {{ 'Target'|trans({}, domain) }}
      +
      +
      + + +
      + + {% include '@CustomFrontMenuModule/backOffice/default-twig/custom-front-menu/_target_field.html.twig' %} +
      +
      + +
      + + + {{ 'Cancel'|trans({}, domain) }} + +
      +
      +
      +{% endblock %} diff --git a/templates/backOffice/default-twig/custom-front-menu/tree.html.twig b/templates/backOffice/default-twig/custom-front-menu/tree.html.twig new file mode 100644 index 0000000..08eb9af --- /dev/null +++ b/templates/backOffice/default-twig/custom-front-menu/tree.html.twig @@ -0,0 +1,89 @@ +{% extends '@BackOfficeDefaultTwig/base.html.twig' %} + +{% set domain = 'customfrontmenu.bo.default-twig' %} + +{% block title %}{{ menuTitle }}{% endblock %} +{% block body_testid %}custom-front-menu-tree{% endblock %} + +{% block breadcrumb %} + +{% endblock %} + +{% block content %} +
      +
      +

      {{ menuTitle }}

      + + {{ 'All menus'|trans({}, domain) }} + +
      + +

      + {{ 'Drag an entry onto another to nest it. Drag it onto the menu drop zone to bring it back to the first level. Every move is saved right away.'|trans({}, domain) }} +

      + +
      +
      +
        + {% if tree is empty %} +
      • + {{ 'This menu has no entry yet.'|trans({}, domain) }} +
        • + {% else %} + {% include '@CustomFrontMenuModule/backOffice/default-twig/custom-front-menu/_tree_nodes.html.twig' with { items: tree, menuId: menuId } only %} + {% endif %} +
      +
      +
      + +
      +
      {{ 'Add an entry'|trans({}, domain) }}
      +
      +
      +
      + + +
      +
      + + +
      +
      + + +
      +
      +
      +
      + +
      +
      + + +
      +
      +
      +{% endblock %} diff --git a/templates/backOffice/default-twig/module-config.html.twig b/templates/backOffice/default-twig/module-config.html.twig index e4cf8c3..227e48d 100644 --- a/templates/backOffice/default-twig/module-config.html.twig +++ b/templates/backOffice/default-twig/module-config.html.twig @@ -1,325 +1,72 @@ {# - Menu composition screen, rendered by ConfigHook on the module.configuration hook. - - The catalogue of pickable targets travels in one data- attribute rather than the five - {loop} blocks of the Smarty screen, which emitted one