OXDEV-8462 Change oxNew factory example

README.md

@@ -229,7 +229,7 @@ If you need to extend the shop class chain by overwriting, try to stick to the p
 * event subscriber (`OxidEsales\ModuleTemplate\Subscriber\BeforeModelUpdate`)
 * model with a database (`OxidEsales\ModuleTemplate\Model\GreetingTracker`)
 * DI service examples
-* ``oxNew`` object factory example (`OxidEsales\ModuleTemplate\Greeting\Infrastructure\CoreRequestFactory`)
+* ``oxNew`` object factory example (`OxidEsales\ModuleTemplate\Infrastructure\UserModelFactory`)
 
 #### Whatever you do, ensure it is covered with tests
 * unit/integration test

services.yaml

@@ -9,6 +9,8 @@ services:
   _defaults:
     public: false
     autowire: true
+    bind:
+      OxidEsales\Eshop\Core\Request: '@=service("OxidEsales\\ModuleTemplate\\Core\\Registry").getRequest()'
 
   OxidEsales\ModuleTemplate\Core\Registry:
     class: OxidEsales\Eshop\Core\Registry
@@ -44,5 +46,9 @@ services:
     class: OxidEsales\ModuleTemplate\Subscriber\BeforeModelUpdate
     tags: [ 'kernel.event_subscriber' ]
 
-  OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactoryInterface:
-    class:   OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactory
+  OxidEsales\ModuleTemplate\Infrastructure\UserModelFactoryInterface:
+    class: OxidEsales\ModuleTemplate\Infrastructure\UserModelFactory
+
+  OxidEsales\ModuleTemplate\Service\UserServiceInterface:
+    class: OxidEsales\ModuleTemplate\Service\UserService
+    public: true

src/Controller/Admin/GreetingAdminController.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright © MB Arbatos Klubas. All rights reserved.
+ * Copyright © OXID eSales AG. All rights reserved.
  * See LICENSE file for license details.
  */
 
@@ -10,17 +10,23 @@
 namespace OxidEsales\ModuleTemplate\Controller\Admin;
 
 use OxidEsales\ModuleTemplate\Core\Module as ModuleCore;
-use OxidEsales\ModuleTemplate\Model\User;
 use OxidEsales\Eshop\Application\Controller\Admin\AdminController;
+use OxidEsales\ModuleTemplate\Model\User as TemplateModelUser;
+use OxidEsales\ModuleTemplate\Service\UserServiceInterface;
+use OxidEsales\ModuleTemplate\Traits\ServiceContainer;
 
 class GreetingAdminController extends AdminController
 {
+    use ServiceContainer;
+
     protected $_sThisTemplate = '@oe_moduletemplate/admin/user_greetings';
 
     public function render()
     {
-        $oUser = oxNew(User::class);
-        if ($oUser->load($this->getEditObjectId())) {
+        $userService = $this->getServiceFromContainer(UserServiceInterface::class);
+        if ($this->getEditObjectId()) {
+            /** @var TemplateModelUser $oUser */
+            $oUser = $userService->getUserById($this->getEditObjectId());
             $this->addTplParam(ModuleCore::OEMT_ADMIN_GREETING_TEMPLATE_VARNAME, $oUser->getPersonalGreeting());
         }
 

src/Infrastructure/CoreRequestFactory.php → src/Infrastructure/UserModelFactory.php

@@ -9,15 +9,15 @@
 
 namespace OxidEsales\ModuleTemplate\Infrastructure;
 
-use OxidEsales\Eshop\Core\Request;
+use OxidEsales\Eshop\Application\Model\User;
 
-class CoreRequestFactory implements CoreRequestFactoryInterface
+class UserModelFactory implements UserModelFactoryInterface
 {
     /**
      * @inheritDoc
      */
-    public function create(): Request
+    public function create(): User
     {
-        return oxNew(Request::class);
+        return oxNew(User::class);
     }
 }

src/Infrastructure/CoreRequestFactoryInterface.php → src/Infrastructure/UserModelFactoryInterface.php

@@ -7,12 +7,12 @@
 
 namespace OxidEsales\ModuleTemplate\Infrastructure;
 
-use OxidEsales\Eshop\Core\Request;
+use OxidEsales\Eshop\Application\Model\User;
 
-interface CoreRequestFactoryInterface
+interface UserModelFactoryInterface
 {
     /**
-     * @return Request
+     * @return User
      */
-    public function create(): Request;
+    public function create(): User;
 }

src/Service/GreetingMessage.php

@@ -10,8 +10,8 @@
 namespace OxidEsales\ModuleTemplate\Service;
 
 use OxidEsales\Eshop\Application\Model\User as EshopModelUser;
+use OxidEsales\Eshop\Core\Request as EshopRequest;
 use OxidEsales\ModuleTemplate\Core\Module as ModuleCore;
-use OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactoryInterface;
 use OxidEsales\ModuleTemplate\Model\User as TemplateModelUser;
 use OxidEsales\ModuleTemplate\Service\ModuleSettings as ModuleSettingsService;
 
@@ -26,16 +26,16 @@ class GreetingMessage
     private $settings;
 
     /**
-     * @var CoreRequestFactoryInterface
+     * @var EshopRequest
      */
-    private $coreRequestFactory;
+    private $request;
 
     public function __construct(
         ModuleSettingsService $settings,
-        CoreRequestFactoryInterface $coreRequestFactory
+        EshopRequest $request
     ) {
         $this->settings = $settings;
-        $this->coreRequestFactory = $coreRequestFactory;
+        $this->request = $request;
     }
 
     public function getGreeting(?EshopModelUser $user = null): string
@@ -59,8 +59,7 @@ public function saveGreeting(EshopModelUser $user): bool
 
     private function getRequestOemtGreeting(): string
     {
-        $coreRequestService = $this->coreRequestFactory->create();
-        $input = (string)$coreRequestService->getRequestParameter(ModuleCore::OEMT_GREETING_TEMPLATE_VARNAME);
+        $input = (string)$this->request->getRequestParameter(ModuleCore::OEMT_GREETING_TEMPLATE_VARNAME);
 
         //in real life add some input validation
         return (string)substr($input, 0, 253);

src/Service/UserService.php

@@ -0,0 +1,38 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\ModuleTemplate\Service;
+
+use OxidEsales\Eshop\Application\Model\User as EshopModelUser;
+use OxidEsales\ModuleTemplate\Infrastructure\UserModelFactoryInterface;
+
+/**
+ * @extendable-class
+ */
+class UserService implements UserServiceInterface
+{
+    /**
+     * @var UserModelFactoryInterface
+     */
+    private $userModelFactory;
+
+    public function __construct(
+        UserModelFactoryInterface $userModelFactory
+    ) {
+        $this->userModelFactory = $userModelFactory;
+    }
+
+    public function getUserById(string $userId): EshopModelUser
+    {
+        $userModel = $this->userModelFactory->create();
+        $userModel->load($userId);
+
+        return $userModel;
+    }
+}

src/Service/UserServiceInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\ModuleTemplate\Service;
+
+use OxidEsales\Eshop\Application\Model\User as EshopModelUser;
+
+interface UserServiceInterface
+{
+    public function getUserById(string $userId): EshopModelUser;
+}

tests/Integration/Service/GreetingMessageTest.php

@@ -10,8 +10,8 @@
 namespace OxidEsales\ModuleTemplate\Tests\Integration\Service;
 
 use OxidEsales\Eshop\Application\Model\User as EshopModelUser;
+use OxidEsales\Eshop\Core\Request as CoreRequest;
 use OxidEsales\ModuleTemplate\Core\Module as ModuleCore;
-use OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactoryInterface;
 use OxidEsales\ModuleTemplate\Service\GreetingMessage;
 use OxidEsales\ModuleTemplate\Service\ModuleSettings;
 use OxidEsales\ModuleTemplate\Tests\Integration\IntegrationTestCase;
@@ -22,7 +22,7 @@ public function testModuleGenericGreetingModeEmptyUser(): void
     {
         $service = new GreetingMessage(
             $this->getSettingsMock(ModuleSettings::GREETING_MODE_GENERIC),
-            $this->createMock(CoreRequestFactoryInterface::class)
+            $this->createStub(CoreRequest::class)
         );
         $user    = oxNew(EshopModelUser::class);
 
@@ -33,7 +33,7 @@ public function testModulePersonalGreetingModeEmptyUser(): void
     {
         $service = new GreetingMessage(
             $this->getSettingsMock(),
-            $this->createMock(CoreRequestFactoryInterface::class)
+            $this->createStub(CoreRequest::class)
         );
         $user    = oxNew(EshopModelUser::class);
 
@@ -44,7 +44,7 @@ public function testModuleGenericGreeting(): void
     {
         $service = new GreetingMessage(
             $this->getSettingsMock(ModuleSettings::GREETING_MODE_GENERIC),
-            $this->createMock(CoreRequestFactoryInterface::class)
+            $this->createStub(CoreRequest::class)
         );
         $user    = oxNew(EshopModelUser::class);
         $user->setPersonalGreeting('Hi sweetie!');
@@ -56,7 +56,7 @@ public function testModulePersonalGreeting(): void
     {
         $service = new GreetingMessage(
             $this->getSettingsMock(),
-            $this->createMock(CoreRequestFactoryInterface::class)
+            $this->createStub(CoreRequest::class)
         );
         $user    = oxNew(EshopModelUser::class);
         $user->setPersonalGreeting('Hi sweetie!');

tests/Unit/Infrastructure/CoreRequestFactoryTest.php → tests/Unit/Infrastructure/UserModelFactoryTest.php

@@ -9,21 +9,21 @@
 
 namespace OxidEsales\ModuleTemplate\Tests\Unit\Infrastructure;
 
-use OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactory;
+use OxidEsales\Eshop\Application\Model\User;
+use OxidEsales\ModuleTemplate\Infrastructure\UserModelFactory;
 use PHPUnit\Framework\TestCase;
-use OxidEsales\Eshop\Core\Request;
 
 /**
- * @covers \OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactory
+ * @covers \OxidEsales\ModuleTemplate\Infrastructure\UserModelFactory
  */
-class CoreRequestFactoryTest extends TestCase
+class UserModelFactoryTest extends TestCase
 {
     public function testCreateProducesCorrectTypeOfObjects(): void
     {
-        $coreRequestFactoryMock = $this->getMockBuilder(CoreRequestFactory::class)
+        $coreRequestFactoryMock = $this->getMockBuilder(UserModelFactory::class)
             ->onlyMethods(['create'])
             ->getMock();
 
-        $this->assertInstanceOf(Request::class, $coreRequestFactoryMock->create());
+        $this->assertInstanceOf(User::class, $coreRequestFactoryMock->create());
     }
 }

tests/Unit/Service/GreetingMessageTest.php

@@ -9,8 +9,8 @@
 
 namespace OxidEsales\ModuleTemplate\Tests\Unit\Service;
 
+use OxidEsales\Eshop\Core\Request as CoreRequest;
 use OxidEsales\ModuleTemplate\Core\Module as ModuleCore;
-use OxidEsales\ModuleTemplate\Infrastructure\CoreRequestFactoryInterface;
 use OxidEsales\ModuleTemplate\Service\GreetingMessage;
 use OxidEsales\ModuleTemplate\Service\ModuleSettings;
 use PHPUnit\Framework\TestCase;
@@ -24,7 +24,7 @@ public function testGenericGreetingNoUser(string $mode, string $expected): void
     {
         $service = new GreetingMessage(
             $this->createConfiguredMock(ModuleSettings::class, ['getGreetingMode' => $mode]),
-            $this->createMock(CoreRequestFactoryInterface::class)
+            $this->createStub(CoreRequest::class)
         );
 
         $this->assertSame($expected, $service->getGreeting());