Merge branch 'b-7.3.x-controller-as-service-example-OXDEV-9497' into b-7.3.x

Author: Sieg

README.md

@@ -60,8 +60,8 @@ The repository contains examples of following cases and more:
   * extending a shop model (`OxidEsales\ExamplesModule\Extension\Model\User`) / (`OxidEsales\ExamplesModule\Extension\Model\Basket`)
   * extending a shop controller (`OxidEsales\ExamplesModule\Extension\Controller\StartController`)
 
-* [New controllers](https://github.com/OXID-eSales/examples-module/blob/b-7.3.x/metadata.php#L30)
-  * own module controller (`oeemgreeting` with own template and own translations)
+* [Controllers as service](https://github.com/OXID-eSales/examples-module/blob/b-7.3.x/src/Greeting/services.yaml#L28)
+  * own module controller (`oeem_greeting` with own template and own translations)
   * own module admin controller (`oeem_admin_greeting` with own template and own translations)
 
 * [Using Symfony DI](https://github.com/OXID-eSales/examples-module/blob/b-7.3.x/services.yaml)

metadata.php

@@ -29,10 +29,6 @@
         \OxidEsales\Eshop\Application\Model\Basket::class => \OxidEsales\ExamplesModule\Extension\Model\Basket::class,
         \OxidEsales\Eshop\Application\Model\User::class => \OxidEsales\ExamplesModule\Extension\Model\User::class,
     ],
-    'controllers' => [
-        'oeem_greeting' => \OxidEsales\ExamplesModule\Greeting\Controller\GreetingController::class,
-        'oeem_admin_greeting' => \OxidEsales\ExamplesModule\Greeting\Controller\Admin\GreetingAdminController::class,
-    ],
     'events' => [
         'onActivate' => '\OxidEsales\ExamplesModule\Core\ModuleEvents::onActivate',
         'onDeactivate' => '\OxidEsales\ExamplesModule\Core\ModuleEvents::onDeactivate'

src/Extension/Model/User.php

@@ -25,7 +25,7 @@
  *
  * @mixin BaseModel
  */
-class User extends User_parent implements PersonalGreetingUserInterface
+class User extends User_parent implements UserInterface
 {
     use PersonalGreetingUser;
 }

src/Extension/Model/UserInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+namespace OxidEsales\ExamplesModule\Extension\Model;
+
+use OxidEsales\ExamplesModule\Greeting\Model\PersonalGreetingUserInterface;
+
+interface UserInterface extends PersonalGreetingUserInterface
+{
+}

src/Greeting/Controller/Admin/GreetingAdminController.php

@@ -13,18 +13,25 @@
 use OxidEsales\Eshop\Application\Controller\Admin\AdminController;
 use OxidEsales\ExamplesModule\Extension\Model\User as ExamplesModelUser;
 use OxidEsales\ExamplesModule\Greeting\Service\UserServiceInterface;
+use OxidEsales\ExamplesModule\Greeting\Transput\AdminGreetingRequestInterface;
 
 class GreetingAdminController extends AdminController
 {
     protected $_sThisTemplate = '@oe_examples_module/admin/user_greetings';
 
+    public function __construct(
+        private readonly UserServiceInterface $userService,
+        private readonly AdminGreetingRequestInterface $request,
+    ) {
+        parent::__construct();
+    }
+
     public function render()
     {
-        $userService = $this->getService(UserServiceInterface::class);
-        if ($this->getEditObjectId()) {
-            /** @var ExamplesModelUser $oUser */
-            $oUser = $userService->getUserById($this->getEditObjectId());
-            $this->addTplParam(ModuleCore::OEEM_ADMIN_GREETING_TEMPLATE_VARNAME, $oUser->getPersonalGreeting());
+        if ($this->request->getEditObjectId()) {
+            /** @var ExamplesModelUser $user */
+            $user = $this->userService->getUserById($this->request->getEditObjectId());
+            $this->addTplParam(ModuleCore::OEEM_ADMIN_GREETING_TEMPLATE_VARNAME, $user->getPersonalGreeting());
         }
 
         return parent::render();

src/Greeting/Controller/GreetingController.php

@@ -33,6 +33,14 @@ class GreetingController extends FrontendController
      */
     protected $_sThisTemplate = '@oe_examples_module/templates/greetingtemplate';
 
+    public function __construct(
+        private readonly ModuleSettingsServiceInterface $moduleSettings,
+        private readonly TrackerRepositoryInterface $trackerRepository,
+        private readonly GreetingMessageServiceInterface $greetingService,
+    ) {
+        parent::__construct();
+    }
+
     /**
      * Rendering method.
      *
@@ -41,16 +49,14 @@ class GreetingController extends FrontendController
     public function render()
     {
         $template = parent::render();
-        $moduleSettings = $this->getService(ModuleSettingsServiceInterface::class);
-        $repository = $this->getService(TrackerRepositoryInterface::class);
 
         /** @var ExamplesModelUser $user */
         $user = $this->getUser();
 
         /** @phpstan-ignore-next-line */
-        if (is_a($user, EshopModelUser::class) && $moduleSettings->isPersonalGreetingMode()) {
+        if (is_a($user, EshopModelUser::class) && $this->moduleSettings->isPersonalGreetingMode()) {
             $greeting = $user->getPersonalGreeting();
-            $tracker = $repository->getTrackerByUserId($user->getId());
+            $tracker = $this->trackerRepository->getTrackerByUserId($user->getId());
             $counter = $tracker->getCount();
         }
 
@@ -68,15 +74,12 @@ public function render()
      */
     public function updateGreeting(): void
     {
-        $moduleSettings = $this->getService(ModuleSettingsServiceInterface::class);
-
         /** @var EshopModelUser $user */
         $user = $this->getUser();
 
         /** @phpstan-ignore-next-line */
-        if (is_a($user, EshopModelUser::class) && $moduleSettings->isPersonalGreetingMode()) {
-            $greetingService = $this->getService(GreetingMessageServiceInterface::class);
-            $greetingService->saveGreeting($user);
+        if (is_a($user, EshopModelUser::class) && $this->moduleSettings->isPersonalGreetingMode()) {
+            $this->greetingService->saveGreeting($user);
         }
     }
 }

src/Greeting/Infrastructure/UserModelFactory.php

@@ -13,8 +13,12 @@
 
 class UserModelFactory implements UserModelFactoryInterface
 {
+    /**
+     * @return \OxidEsales\ExamplesModule\Extension\Model\User
+     */
     public function create(): User
     {
+        /** @phpstan-ignore return.type */
         return oxNew(User::class);
     }
 }

src/Greeting/Infrastructure/UserModelFactoryInterface.php

@@ -11,5 +11,8 @@
 
 interface UserModelFactoryInterface
 {
+    /**
+     * @return \OxidEsales\ExamplesModule\Extension\Model\User
+     */
     public function create(): User;
 }

src/Greeting/Service/UserService.php

@@ -9,11 +9,13 @@
 
 namespace OxidEsales\ExamplesModule\Greeting\Service;
 
-use OxidEsales\Eshop\Application\Model\User as EshopModelUser;
 use OxidEsales\ExamplesModule\Greeting\Infrastructure\UserModelFactoryInterface;
+use OxidEsales\ExamplesModule\Greeting\Model\PersonalGreetingUserInterface;
 
 /**
  * @extendable-class
+ *
+ * @todo: getting the user should go through the user repository
  */
 readonly class UserService implements UserServiceInterface
 {
@@ -22,7 +24,7 @@ public function __construct(
     ) {
     }
 
-    public function getUserById(string $userId): EshopModelUser
+    public function getUserById(string $userId): PersonalGreetingUserInterface
     {
         $userModel = $this->userModelFactory->create();
         $userModel->load($userId);

src/Greeting/Service/UserServiceInterface.php

@@ -9,9 +9,9 @@
 
 namespace OxidEsales\ExamplesModule\Greeting\Service;
 
-use OxidEsales\Eshop\Application\Model\User as EshopModelUser;
+use OxidEsales\ExamplesModule\Greeting\Model\PersonalGreetingUserInterface;
 
 interface UserServiceInterface
 {
-    public function getUserById(string $userId): EshopModelUser;
+    public function getUserById(string $userId): PersonalGreetingUserInterface;
 }