fix(module): move settings to dedicated page

controllers/MyParcelNLAdminSettingsController.php

@@ -0,0 +1,8 @@
+<?php
+/** @noinspection PhpUnused */
+
+declare(strict_types=1);
+
+use MyParcelNL\PrestaShop\Controller\SettingsController;
+
+final class MyParcelNLAdminSettingsController extends SettingsController { }

myparcelnl.php

@@ -6,6 +6,7 @@
 use MyParcelNL\Pdk\Base\Pdk as PdkInstance;
 use MyParcelNL\Pdk\Facade\Installer;
 use MyParcelNL\Pdk\Facade\Pdk;
+use MyParcelNL\PrestaShop\Hooks\HasPdkCheckoutDeliveryOptionsHooks;
 use MyParcelNL\PrestaShop\Hooks\HasPdkCheckoutHooks;
 use MyParcelNL\PrestaShop\Hooks\HasPdkOrderHooks;
 use MyParcelNL\PrestaShop\Hooks\HasPdkProductHooks;
@@ -25,6 +26,7 @@
  */
 class MyParcelNL extends CarrierModule
 {
+    use HasPdkCheckoutDeliveryOptionsHooks;
     use HasPdkCheckoutHooks;
     use HasPdkOrderHooks;
     use HasPdkProductHooks;
@@ -106,6 +108,21 @@ public static function getModule(): self
         return $module;
     }
 
+    /**
+     * Redirects the "configure" button in the module list to the settings page.
+     *
+     * @return string
+     * @see \MyParcelNL\PrestaShop\Controller\SettingsController
+     */
+    public function getContent(): string
+    {
+        $link = $this->context->link->getAdminLink(Pdk::get('legacyControllerSettings'));
+
+        Tools::redirectAdmin($link);
+
+        return '';
+    }
+
     /**
      * @param  \Cart $params
      * @param  \int  $shipping_cost

src/Controller/AbstractAdminController.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MyParcelNL\PrestaShop\Controller;
+
+use MyParcelNL;
+use PrestaShopBundle\Controller\Admin\FrameworkBundleAdminController;
+
+/**
+ * @property \MyParcelNL $module
+ */
+abstract class AbstractAdminController extends FrameworkBundleAdminController
+{
+    public function __construct()
+    {
+        parent::__construct();
+
+        // Trigger PDK setup
+        new MyParcelNL();
+    }
+}

src/Controller/SettingsController.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MyParcelNL\PrestaShop\Controller;
+
+use MyParcelNL\Pdk\Facade\Frontend;
+use Symfony\Component\HttpFoundation\Response;
+
+/**
+ * @property \MyParcelNL $module
+ */
+class SettingsController extends AbstractAdminController
+{
+    /**
+     * @return Response
+     */
+    public function index(): Response
+    {
+        return $this->render('@Modules/myparcelnl/views/templates/admin/page.twig', [
+            'content' => Frontend::renderPluginSettings(),
+        ]);
+    }
+}

src/Hooks/HasPdkRenderHooks.php

@@ -12,16 +12,6 @@
 
 trait HasPdkRenderHooks
 {
-    /**
-     * Renders the module configuration page.
-     *
-     * @return string
-     */
-    public function getContent(): string
-    {
-        return Frontend::renderPluginSettings();
-    }
-
     /**
      * Add columns to the order grid to render the order boxes in.
      *

src/Pdk/Base/PsPdkBootstrapper.php

@@ -61,19 +61,35 @@ protected function getConfig(string $version, string $name): array
                 'MyParcel-PrestaShop' => $version,
             ]),
 
-            'moduleTabName' => value('shipping_logistics'),
-
             'prestaShopVersionMin' => value('1.7.6'),
             'prestaShopVersionMax' => value('8.2.0'),
 
+            /**
+             * Tab in the modules list we want to show the module under.
+             */
+
+            'moduleTabName' => value('shipping_logistics'),
+
+            /**
+             * The name of the tab we want to show the settings page under.
+             */
+
+            'sidebarParentClass' => value('AdminParentShipping'),
+
             'logDirectory' => value(sprintf('%s/var/logs/%s', _PS_ROOT_DIR_, $name)),
 
             /**
-             * The symfony routes that are used by the pdk.
+             * The symfony routes that are used by the pdk. Must match the routes in config/routes.yml.
+             *
+             * @see config/routes.yml
              */
 
-            'routeNamePdk'      => value('myparcelnl_pdk'),
             'routeNameFrontend' => value('myparcelnl_frontend'),
+            'routeNamePdk'      => value('myparcelnl_pdk'),
+            'routeNameSettings' => value('myparcelnl_settings'),
+            'routeNameWebhook'  => value('myparcelnl_webhook'),
+
+            'legacyControllerSettings' => value('MyParcelNLAdminSettings'),
 
             'moduleInstance' => factory(static function (): Module {
                 $name = Pdk::getAppInfo()->name;

src/Pdk/Frontend/Service/PsViewService.php

@@ -4,6 +4,7 @@
 
 namespace MyParcelNL\PrestaShop\Pdk\Frontend\Service;
 
+use MyParcelNL\Pdk\Facade\Pdk;
 use MyParcelNL\Pdk\Frontend\Service\AbstractViewService;
 use PrestaShop\PrestaShop\Adapter\Entity\Dispatcher;
 use RuntimeException;
@@ -47,7 +48,7 @@ public function isOrderPage(): bool
      */
     public function isPluginSettingsPage(): bool
     {
-        return 'AdminModules' === $this->getPage();
+        return Pdk::get('legacyControllerSettings') === $this->getPage();
     }
 
     /**

src/Pdk/Installer/Service/PsInstallerService.php

@@ -140,17 +140,16 @@ private function installDatabase(): void
      */
     private function installTabs(): void
     {
-        $languages = array_fill_keys(array_column(Language::getLanguages(), 'id_lang'), Pdk::getAppInfo()->title);
-
         /** @var \PrestaShopBundle\Entity\Repository\TabRepository $tabRepository */
         $tabRepository = Pdk::get('ps.tabRepository');
 
         $tab = new Tab();
 
         $tab->active     = 1;
-        $tab->class_name = 'AdminMyParcelNL';
-        $tab->name       = $languages;
-        $tab->id_parent  = $tabRepository->findOneIdByClassName('AdminParentShipping');
+        $tab->class_name = Pdk::get('legacyControllerSettings');
+        $tab->route_name = Pdk::get('routeNameSettings');
+        $tab->name       = array_fill_keys(array_column(Language::getLanguages(), 'id_lang'), Pdk::getAppInfo()->title);
+        $tab->id_parent  = $tabRepository->findOneIdByClassName(Pdk::get('sidebarParentClass'));
         $tab->module     = $this->module->name;
 
         if (! $tab->add()) {

views/templates/admin/page.twig

@@ -0,0 +1,5 @@
+{% extends '@PrestaShop/Admin/layout.html.twig' %}
+
+{% block content %}
+  {{ content | raw }}
+{% endblock %}