OXDEV-8947 Segregate the ModuleSettingsInterface into more concrete settings

Signed-off-by: Anton Fedurtsya <anton@fedurtsya.com>

Author: Sieg

services.yaml

@@ -6,7 +6,6 @@ imports:
   - { resource: src/Greeting/services.yaml }
   - { resource: src/Logging/services.yaml }
   - { resource: src/ProductVote/services.yaml }
-  - { resource: src/Settings/services.yaml }
   - { resource: src/Tracker/services.yaml }
 
 services:

src/Extension/Controller/StartController.php

@@ -11,7 +11,7 @@
 
 use OxidEsales\Eshop\Application\Model\User as EshopModelUser;
 use OxidEsales\ExamplesModule\Greeting\Service\GreetingMessageServiceInterface;
-use OxidEsales\ExamplesModule\Settings\Service\ModuleSettingsServiceInterface;
+use OxidEsales\ExamplesModule\Greeting\Settings\GreetingSettingsInterface;
 
 /**
  * @eshopExtension
@@ -55,9 +55,9 @@ public function getOeemGreeting(): string
 
     public function canUpdateOeemGreeting(): bool
     {
-        $moduleSettings = $this->getService(ModuleSettingsServiceInterface::class);
+        $greetingSettings = $this->getService(GreetingSettingsInterface::class);
 
         /** @phpstan-ignore-next-line */
-        return is_a($this->getUser(), EshopModelUser::class) && $moduleSettings->isPersonalGreetingMode();
+        return is_a($this->getUser(), EshopModelUser::class) && $greetingSettings->isPersonalGreetingMode();
     }
 }

src/Greeting/Controller/GreetingController.php

@@ -15,7 +15,7 @@
 use OxidEsales\ExamplesModule\Extension\Model\User as ExamplesModelUser;
 use OxidEsales\ExamplesModule\Extension\Model\UserInterface;
 use OxidEsales\ExamplesModule\Greeting\Service\GreetingMessageServiceInterface;
-use OxidEsales\ExamplesModule\Settings\Service\ModuleSettingsServiceInterface;
+use OxidEsales\ExamplesModule\Greeting\Settings\GreetingSettingsInterface;
 use OxidEsales\ExamplesModule\Tracker\Infrastructure\Repository\TrackerRepositoryInterface;
 
 use function PHPUnit\Framework\isInstanceOf;
@@ -37,7 +37,7 @@ class GreetingController extends FrontendController
     protected $_sThisTemplate = '@oe_examples_module/templates/greetingtemplate';
 
     public function __construct(
-        private readonly ModuleSettingsServiceInterface $moduleSettings,
+        private readonly GreetingSettingsInterface $greetingSettings,
         private readonly TrackerRepositoryInterface $trackerRepository,
         private readonly GreetingMessageServiceInterface $greetingService,
     ) {
@@ -58,7 +58,7 @@ public function render()
         if (
             $user instanceof UserInterface
             && !empty($user->getId())
-            && $this->moduleSettings->isPersonalGreetingMode()
+            && $this->greetingSettings->isPersonalGreetingMode()
         ) {
             $greeting = $user->getPersonalGreeting();
             $tracker = $this->trackerRepository->getTrackerByUserId($user->getId());
@@ -83,7 +83,7 @@ public function updateGreeting(): void
         $user = $this->getUser();
 
         /** @phpstan-ignore-next-line */
-        if (is_a($user, EshopModelUser::class) && $this->moduleSettings->isPersonalGreetingMode()) {
+        if (is_a($user, EshopModelUser::class) && $this->greetingSettings->isPersonalGreetingMode()) {
             $this->greetingService->saveGreeting($user);
         }
     }

src/Greeting/Service/GreetingMessageService.php

@@ -14,12 +14,12 @@
 use OxidEsales\Eshop\Core\Request as EshopRequest;
 use OxidEsales\ExamplesModule\Core\Module as ModuleCore;
 use OxidEsales\ExamplesModule\Extension\Model\User as ExamplesModelUser;
-use OxidEsales\ExamplesModule\Settings\Service\ModuleSettingsServiceInterface;
+use OxidEsales\ExamplesModule\Greeting\Settings\GreetingSettingsInterface;
 
 readonly class GreetingMessageService implements GreetingMessageServiceInterface
 {
     public function __construct(
-        private ModuleSettingsServiceInterface $moduleSettings,
+        private GreetingSettingsInterface $greetingSettings,
         private EshopRequest $shopRequest,
         private EshopLanguage $shopLanguage,
         private ?string $shopName,
@@ -35,7 +35,7 @@ public function getGreeting(?EshopModelUser $user = null): string
     {
         $result = ModuleCore::DEFAULT_PERSONAL_GREETING_LANGUAGE_CONST;
 
-        if (ModuleSettingsServiceInterface::GREETING_MODE_PERSONAL == $this->moduleSettings->getGreetingMode()) {
+        if (GreetingSettingsInterface::GREETING_MODE_PERSONAL == $this->greetingSettings->getGreetingMode()) {
             $result = $this->getUserGreeting($user);
         }
 

…ttings/Service/ModuleSettingsService.php …c/Greeting/Settings/GreetingSettings.phpsrc/Settings/Service/ModuleSettingsService.php renamed to src/Greeting/Settings/GreetingSettings.php src/Settings/Service/ModuleSettingsService.php renamed to src/Greeting/Settings/GreetingSettings.php

@@ -7,15 +7,15 @@
 
 declare(strict_types=1);
 
-namespace OxidEsales\ExamplesModule\Settings\Service;
+namespace OxidEsales\ExamplesModule\Greeting\Settings;
 
 use OxidEsales\EshopCommunity\Internal\Framework\Module\Facade\ModuleSettingServiceInterface;
 use OxidEsales\ExamplesModule\Core\Module;
 
 /**
  * @extendable-class
  */
-readonly class ModuleSettingsService implements ModuleSettingsServiceInterface
+readonly class GreetingSettings implements GreetingSettingsInterface
 {
     public const GREETING_MODE_VALUES = [
         self::GREETING_MODE_GENERIC,
@@ -43,9 +43,4 @@ public function saveGreetingMode(string $value): void
     {
         $this->moduleSettingService->saveString(self::GREETING_MODE, $value, Module::MODULE_ID);
     }
-
-    public function isLoggingEnabled(): bool
-    {
-        return $this->moduleSettingService->getBoolean(self::LOGGER_STATUS, Module::MODULE_ID);
-    }
 }

…rvice/ModuleSettingsServiceInterface.php …g/Settings/GreetingSettingsInterface.phpsrc/Settings/Service/ModuleSettingsServiceInterface.php renamed to src/Greeting/Settings/GreetingSettingsInterface.php src/Settings/Service/ModuleSettingsServiceInterface.php renamed to src/Greeting/Settings/GreetingSettingsInterface.php

@@ -7,23 +7,19 @@
 
 declare(strict_types=1);
 
-namespace OxidEsales\ExamplesModule\Settings\Service;
+namespace OxidEsales\ExamplesModule\Greeting\Settings;
 
-interface ModuleSettingsServiceInterface
+interface GreetingSettingsInterface
 {
     public const GREETING_MODE = 'oeexamplesmodule_GreetingMode';
 
     public const GREETING_MODE_GENERIC = 'generic';
 
     public const GREETING_MODE_PERSONAL = 'personal';
 
-    public const LOGGER_STATUS = 'oeexamplesmodule_LoggerEnabled';
-
     public function isPersonalGreetingMode(): bool;
 
     public function getGreetingMode(): string;
 
     public function saveGreetingMode(string $value): void;
-
-    public function isLoggingEnabled(): bool;
 }

src/Greeting/services.yaml

@@ -9,6 +9,10 @@ services:
       OxidEsales\Eshop\Core\Request: '@=service("OxidEsales\\ExamplesModule\\Core\\Registry").getRequest()'
       OxidEsales\Eshop\Core\Language: '@=service("OxidEsales\\ExamplesModule\\Core\\Registry").getLang()'
 
+  OxidEsales\ExamplesModule\Greeting\Settings\GreetingSettingsInterface:
+    class: OxidEsales\ExamplesModule\Greeting\Settings\GreetingSettings
+    public: true
+
   OxidEsales\ExamplesModule\Greeting\Service\GreetingMessageServiceInterface:
     class: OxidEsales\ExamplesModule\Greeting\Service\GreetingMessageService
     arguments:

src/Logging/Service/BasketProductLoggerService.php

@@ -9,7 +9,7 @@
 
 namespace OxidEsales\ExamplesModule\Logging\Service;
 
-use OxidEsales\ExamplesModule\Settings\Service\ModuleSettingsServiceInterface;
+use OxidEsales\ExamplesModule\Logging\Settings\LoggingSettingsInterface;
 use Psr\Log\LoggerInterface as PsrLoggerInterface;
 
 /**
@@ -21,13 +21,13 @@
 
     public function __construct(
         private PsrLoggerInterface $logger,
-        private ModuleSettingsServiceInterface $moduleSettingService,
+        private LoggingSettingsInterface $loggingSettings,
     ) {
     }
 
     public function log(string $productID): void
     {
-        if ($this->moduleSettingService->isLoggingEnabled()) {
+        if ($this->loggingSettings->isLoggingEnabled()) {
             $message = sprintf(self::MESSAGE, $productID);
             $this->logger->info($message);
         }

src/Logging/Settings/LoggingSettings.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * Copyright © . All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\ExamplesModule\Logging\Settings;
+
+use OxidEsales\EshopCommunity\Internal\Framework\Module\Facade\ModuleSettingServiceInterface;
+use OxidEsales\ExamplesModule\Core\Module;
+
+/**
+ * @extendable-class
+ */
+readonly class LoggingSettings implements LoggingSettingsInterface
+{
+    public function __construct(
+        private ModuleSettingServiceInterface $moduleSettingService,
+    ) {
+    }
+
+    public function isLoggingEnabled(): bool
+    {
+        return $this->moduleSettingService->getBoolean(self::LOGGER_STATUS, Module::MODULE_ID);
+    }
+}

src/Logging/Settings/LoggingSettingsInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * Copyright © . All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\ExamplesModule\Logging\Settings;
+
+interface LoggingSettingsInterface
+{
+    public const LOGGER_STATUS = 'oeexamplesmodule_LoggerEnabled';
+
+    public function isLoggingEnabled(): bool;
+}