PES-2886: Move configuration submission handling to ConfigurationFormService for improved modularity

Author: Karpec

packetery/libs/Module/ConfigurationFormService.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace Packetery\Module;
+
+use Packetery;
+use Packetery\Exceptions\ApiClientException;
+use Packetery\Exceptions\DatabaseException;
+use Tools;
+use Packetery\Tools\UserPermissionHelper;
+use Packetery\Tools\ConfigHelper;
+use Packetery\Payment\PaymentRepository;
+
+class ConfigurationFormService
+{
+    /** @var Packetery */
+    private $module;
+
+    /**
+     * @param Packetery $module
+     */
+    public function __construct($module)
+    {
+        $this->module = $module;
+    }
+
+    /**
+     * @param UserPermissionHelper $userPermissionHelper
+     * @return array<string, bool|string>
+     * @throws ApiClientException
+     * @throws \ReflectionException|DatabaseException
+     */
+    public function handleConfigurationSubmit(UserPermissionHelper $userPermissionHelper)
+    {
+        $output = '';
+        $error = false;
+
+        if (!$userPermissionHelper->hasPermission(UserPermissionHelper::SECTION_CONFIG, UserPermissionHelper::PERMISSION_EDIT)) {
+            return [
+                'output' => $this->module->displayError('You do not have permission to save configuration.'),
+                'error' => true
+            ];
+        }
+
+        $confOptions = $this->module->getConfigurationOptions();
+        $packeteryOptions = $this->module->diContainer->get(Options::class);
+        
+        foreach ($confOptions as $option => $optionConf) {
+            $value = (string)Tools::getValue($option);
+            $configValue = $packeteryOptions->formatOption($option, $value);
+            $errorMessage = $packeteryOptions->validate($option, $configValue);
+            if ($errorMessage !== false) {
+                $output .= $this->module->displayError($errorMessage);
+                $error = true;
+            } else {
+                ConfigHelper::update($option, $configValue);
+            }
+        }
+
+        $this->handlePaymentMethodsSubmit();
+
+        return [
+            'output' => $output,
+            'error' => $error
+        ];
+    }
+
+    /**
+     * @throws \ReflectionException
+     * @throws DatabaseException
+     */
+    private function handlePaymentMethodsSubmit()
+    {
+        $paymentRepository = $this->module->diContainer->get(PaymentRepository::class);
+        $paymentList = $paymentRepository->getListPayments();
+        
+        if ($paymentList) {
+            foreach ($paymentList as $payment) {
+                if (Tools::getIsset('payment_cod_' . $payment['module_name'])) {
+                    $paymentRepository->setOrInsert(1, $payment['module_name']);
+                } else {
+                    $paymentRepository->setOrInsert(0, $payment['module_name']);
+                }
+            }
+        }
+    }
+}

packetery/packetery.php

@@ -245,6 +245,7 @@ public function getCarriersContent()
      * @throws PrestaShopException
      * @throws ReflectionException
      * @throws \Packetery\Exceptions\DatabaseException
+     * @throws \Packetery\Exceptions\ApiClientException
      */
     public function getContent()
     {
@@ -299,36 +300,13 @@ public function getContent()
         }
 
         if (Tools::isSubmit('submit' . $this->name)) {
-            if (!$userPermissionHelper->hasPermission(\Packetery\Tools\UserPermissionHelper::SECTION_CONFIG, \Packetery\Tools\UserPermissionHelper::PERMISSION_EDIT)) {
-                $output .= $this->displayError('You do not have permission to save configuration.');
+            $isSubmit = true;
+            /** @var \Packetery\Module\ConfigurationFormService $configurationFormService */
+            $configurationFormService = $this->diContainer->get(\Packetery\Module\ConfigurationFormService::class);
+            $result = $configurationFormService->handleConfigurationSubmit($userPermissionHelper);
+            $output .= $result['output'];
+            if ($result['error']) {
                 $error = true;
-            } else {
-                $isSubmit = true;
-                $confOptions = $this->getConfigurationOptions();
-                /** @var \Packetery\Module\Options $packeteryOptions */
-                $packeteryOptions = $this->diContainer->get(\Packetery\Module\Options::class);
-                foreach ($confOptions as $option => $optionConf) {
-                    $value = (string)Tools::getValue($option);
-                    $configValue = $packeteryOptions->formatOption($option, $value);
-                    $errorMessage = $packeteryOptions->validate($option, $configValue);
-                    if ($errorMessage !== false) {
-                        $output .= $this->displayError($errorMessage);
-                        $error = true;
-                    } else {
-                        \Packetery\Tools\ConfigHelper::update($option, $configValue);
-                    }
-                }
-                $paymentRepository = $this->diContainer->get(\Packetery\Payment\PaymentRepository::class);
-                $paymentList = $paymentRepository->getListPayments();
-                if ($paymentList) {
-                    foreach ($paymentList as $payment) {
-                        if (Tools::getIsset('payment_cod_' . $payment['module_name'])) {
-                            $paymentRepository->setOrInsert(1, $payment['module_name']);
-                        } else {
-                            $paymentRepository->setOrInsert(0, $payment['module_name']);
-                        }
-                    }
-                }
             }
         }
 
@@ -507,7 +485,7 @@ private function generateCronInfoBlock()
         return $this->context->smarty->fetch($this->local_path . 'views/templates/admin/generateCronInfoBlock.tpl');
     }
 
-    private function getConfigurationOptions()
+    public function getConfigurationOptions()
     {
         return [
             'PACKETERY_APIPASS' => [