Merge branch 'refs/heads/b-7.3.x-env-variables-example-OXDEV-9496' into b-7.3.x

MarcelOxid · MarcelOxid · commit 633006ba0274 · 2025-05-22T11:51:31.000+02:00
diff --git a/.env b/.env
@@ -0,0 +1,3 @@
+# Move this file to the root directory of your project or merge it with the existing one
+SHOW_GENERAL_GREETING=true
+OEEM_SHOP_NAME='OXID eShop'
diff --git a/README.md b/README.md
@@ -94,6 +94,12 @@ The repository contains examples of following cases and more:
   * [Composer aliases for easy running of tests and quality tools](https://github.com/OXID-eSales/examples-module/blob/b-7.3.x/composer.json#L48)
   * [Using the github actions as CI tool with all recommended tools preconfigured for you.](https://github.com/OXID-eSales/examples-module/tree/b-7.3.x/.github)
 
+* [Using variables from .env file](https://github.com/OXID-eSales/examples-module/tree/b-7.3.x/.env)
+  * [Access via `getenv()` function](https://github.com/OXID-eSales/examples-module/tree/b-7.3.x/src/Extension/Controller/StartController.php)
+    * Note: Changes to environment variables take effect immediately — no cache clearing is required.
+  * [Access via DI container](https://github.com/OXID-eSales/examples-module/tree/b-7.3.x/src/Greeting/services.yaml)
+    * Note: After updating environment variables, you must clear the cache for changes to take effect.
+
 **HINTS**:
 * Only extend the shop core if there is no other way like listen and handle shop events,
   decorate/replace some DI service.
diff --git a/src/Core/Module.php b/src/Core/Module.php
@@ -17,6 +17,8 @@ final class Module
 
     public const OEEM_COUNTER_TEMPLATE_VARNAME = 'oeem_greeting_counter';
 
+    public const GENERAL_GREETING_LANGUAGE_CONST = 'OEEXAMPLESMODULE_GREETING';
+
     public const DEFAULT_PERSONAL_GREETING_LANGUAGE_CONST = 'OEEXAMPLESMODULE_GREETING_GENERIC';
 
     public const OEEM_ADMIN_GREETING_TEMPLATE_VARNAME = 'greeting_message';
diff --git a/src/Extension/Controller/StartController.php b/src/Extension/Controller/StartController.php
@@ -33,6 +33,17 @@ class StartController extends StartController_parent
      * NOTE: only leaf classes can be extended this way. The FrontendController class which
      *      many Controllers inherit from cannot be extended this way.
      */
+    public function getOeemGeneralGreeting(): string
+    {
+        $service = $this->getService(GreetingMessageServiceInterface::class);
+        return $service->getGeneralGreeting();
+    }
+
+    public function showOeemGeneralGreeting(): bool
+    {
+        return strtolower((string)getenv('SHOW_GENERAL_GREETING')) == 'true';
+    }
+
     public function getOeemGreeting(): string
     {
         $service = $this->getService(GreetingMessageServiceInterface::class);
diff --git a/src/Greeting/Service/GreetingMessageService.php b/src/Greeting/Service/GreetingMessageService.php
@@ -22,9 +22,15 @@ public function __construct(
         private ModuleSettingsServiceInterface $moduleSettings,
         private EshopRequest $shopRequest,
         private EshopLanguage $shopLanguage,
+        private ?string $shopName,
     ) {
     }
 
+    public function getGeneralGreeting(): string
+    {
+        return sprintf($this->translate(ModuleCore::GENERAL_GREETING_LANGUAGE_CONST), $this->shopName);
+    }
+
     public function getGreeting(?EshopModelUser $user = null): string
     {
         $result = ModuleCore::DEFAULT_PERSONAL_GREETING_LANGUAGE_CONST;
diff --git a/src/Greeting/Service/GreetingMessageServiceInterface.php b/src/Greeting/Service/GreetingMessageServiceInterface.php
@@ -13,6 +13,8 @@
 
 interface GreetingMessageServiceInterface
 {
+    public function getGeneralGreeting(): string;
+
     public function getGreeting(?EshopModelUser $user = null): string;
 
     public function saveGreeting(EshopModelUser $user): bool;
diff --git a/src/Greeting/services.yaml b/src/Greeting/services.yaml
@@ -12,6 +12,8 @@ services:
 
   OxidEsales\ExamplesModule\Greeting\Service\GreetingMessageServiceInterface:
     class: OxidEsales\ExamplesModule\Greeting\Service\GreetingMessageService
+    arguments:
+      $shopName: '%env(OEEM_SHOP_NAME)%'
     public: true
 
   OxidEsales\ExamplesModule\Greeting\Infrastructure\UserModelFactoryInterface:
diff --git a/tests/Codeception/Acceptance/GreetingCest.php b/tests/Codeception/Acceptance/GreetingCest.php
@@ -37,7 +37,7 @@ public function testGreetingModeGeneric(AcceptanceTester $I): void
 
         $I->openShop();
 
-        $I->waitForText(Translator::translate('OEEXAMPLESMODULE_GREETING'));
+        $I->waitForText(sprintf(Translator::translate('OEEXAMPLESMODULE_GREETING'), getenv('OEEM_SHOP_NAME')));
         $I->see(Translator::translate('OEEXAMPLESMODULE_GREETING_GENERIC'));
         $I->dontSeeElement('#oeem_update_greeting');
     }
@@ -51,7 +51,7 @@ public function testGreetingModeGenericWithUser(AcceptanceTester $I): void
         $I->openShop()
             ->loginUser($I->getDemoUserName(), $I->getDemoUserPassword());
 
-        $I->waitForText(Translator::translate('OEEXAMPLESMODULE_GREETING'));
+        $I->waitForText(sprintf(Translator::translate('OEEXAMPLESMODULE_GREETING'), getenv('OEEM_SHOP_NAME')));
         $I->see(Translator::translate('OEEXAMPLESMODULE_GREETING_GENERIC'));
         $I->dontSee('Hi there sweetie'); //no personal greeting even if user has one set
         $I->dontSeeElement('#oeem_update_greeting');
@@ -64,7 +64,7 @@ public function testGreetingModePersonalWithoutUser(AcceptanceTester $I): void
         $I->setGreetingModePersonal();
         $I->openShop();
 
-        $I->waitForText(Translator::translate('OEEXAMPLESMODULE_GREETING'));
+        $I->waitForText(sprintf(Translator::translate('OEEXAMPLESMODULE_GREETING'), getenv('OEEM_SHOP_NAME')));
         $I->dontSee(Translator::translate('OEEXAMPLESMODULE_GREETING_GENERIC'));
         $I->dontSeeElement('#oeem_update_greeting');
     }
@@ -79,7 +79,7 @@ public function testGreetingModePersonalUser(AcceptanceTester $I): void
         $I->openShop()
             ->loginUser($I->getDemoUserName(), $I->getDemoUserPassword());
 
-        $I->waitForText(Translator::translate('OEEXAMPLESMODULE_GREETING'));
+        $I->waitForText(sprintf(Translator::translate('OEEXAMPLESMODULE_GREETING'), getenv('OEEM_SHOP_NAME')));
         $I->dontSee(Translator::translate('OEEXAMPLESMODULE_GREETING_GENERIC'));
         $I->see('Hi there sweetie');
         $I->seeElement('#oeem_update_greeting');
diff --git a/tests/Codeception/Acceptance/ModuleCest.php b/tests/Codeception/Acceptance/ModuleCest.php
@@ -24,12 +24,12 @@ public function testCanDeactivateModule(AcceptanceTester $I): void
         $I->wantToTest('that deactivating the module does not destroy the shop');
 
         $I->openShop();
-        $I->waitForText(Translator::translate('OEEXAMPLESMODULE_GREETING'));
+        $I->waitForText(sprintf(Translator::translate('OEEXAMPLESMODULE_GREETING'), getenv('OEEM_SHOP_NAME')));
 
         $I->deactivateModule(Module::MODULE_ID);
         $I->reloadPage();
 
         $I->waitForPageLoad();
-        $I->dontSee(Translator::translate('OEEXAMPLESMODULE_GREETING'));
+        $I->dontSee(sprintf(Translator::translate('OEEXAMPLESMODULE_GREETING'), getenv('OEEM_SHOP_NAME')));
     }
 }
diff --git a/tests/Codeception/Acceptance/UpdateGreetingCest.php b/tests/Codeception/Acceptance/UpdateGreetingCest.php
@@ -43,7 +43,7 @@ public function testSetGreetingMode(AcceptanceTester $I): void
         $I->openShop()
             ->loginUser($I->getDemoUserName(), $I->getDemoUserPassword());
 
-        $I->waitForText(Translator::translate('OEEXAMPLESMODULE_GREETING'));
+        $I->waitForText(sprintf(Translator::translate('OEEXAMPLESMODULE_GREETING'), getenv('OEEM_SHOP_NAME')));
         $I->dontSee(Translator::translate('OEEXAMPLESMODULE_GREETING_GENERIC'));
         $I->see('Hi there sweetie');
 
diff --git a/tests/Integration/Extension/Controller/StartControllerTest.php b/tests/Integration/Extension/Controller/StartControllerTest.php
@@ -13,6 +13,7 @@
 use OxidEsales\Eshop\Application\Model\User as EshopModelUser;
 use OxidEsales\Eshop\Core\Registry;
 use OxidEsales\Eshop\Core\Registry as EshopRegistry;
+use OxidEsales\ExamplesModule\Core\Module;
 use OxidEsales\ExamplesModule\Extension\Controller\StartController;
 use OxidEsales\ExamplesModule\Settings\Service\ModuleSettingsServiceInterface;
 use OxidEsales\ExamplesModule\Tests\Integration\IntegrationTestCase;
@@ -46,6 +47,22 @@ public function tearDown(): void
         parent::tearDown();
     }
 
+    public function testGetGeneralGreeting(): void
+    {
+        $controller = oxNew(EshopStartController::class);
+
+        $greetingPattern = EshopRegistry::getLang()->translateString(Module::GENERAL_GREETING_LANGUAGE_CONST);
+        $expectedGreeting = sprintf($greetingPattern, getenv('OEEM_SHOP_NAME'));
+
+        $this->assertSame($expectedGreeting, $controller->getOeemGeneralGreeting());
+    }
+
+    public function testShowGeneralGreeting(): void
+    {
+        $controller = oxNew(EshopStartController::class);
+        $this->assertTrue($controller->showOeemGeneralGreeting());
+    }
+
     /**
      * @dataProvider providerCanUpdateOeemGreeting
      */
diff --git a/tests/Integration/Greeting/Service/GreetingMessageServiceTest.php b/tests/Integration/Greeting/Service/GreetingMessageServiceTest.php
@@ -26,7 +26,7 @@ final class GreetingMessageServiceTest extends TestCase
 {
     public function testGenericGreetingWithUserForPersonalMode(): void
     {
-        $sut = new GreetingMessageService(
+        $sut = $this->getSut(
             moduleSettings: $moduleSettingsStub = $this->createMock(ModuleSettingsServiceInterface::class),
             shopRequest: $this->createStub(CoreRequest::class),
             shopLanguage: $langStub = $this->createStub(CoreLanguage::class),
@@ -51,11 +51,13 @@ public function testGenericGreetingWithUserForPersonalMode(): void
     private function getSut(
         ModuleSettingsServiceInterface $moduleSettings = null,
         CoreRequest $shopRequest = null,
+        CoreLanguage $shopLanguage = null,
     ): GreetingMessageService {
         return new GreetingMessageService(
             moduleSettings: $moduleSettings ?? $this->createStub(ModuleSettingsServiceInterface::class),
-            shopRequest: $this->createStub(CoreRequest::class),
+            shopRequest: $shopRequest ?? $this->createStub(CoreRequest::class),
             shopLanguage: $shopLanguage ?? $this->createStub(CoreLanguage::class),
+            shopName: 'Test Shop',
         );
     }
 }
diff --git a/tests/Unit/Greeting/Service/GreetingMessageServiceTest.php b/tests/Unit/Greeting/Service/GreetingMessageServiceTest.php
@@ -20,11 +20,26 @@
 #[CoversClass(GreetingMessageService::class)]
 final class GreetingMessageServiceTest extends TestCase
 {
+    public function testGeneralGreeting(): void
+    {
+        $shopName = uniqid();
+        $service = $this->getSut(
+            shopLanguage: $langStub = $this->createStub(CoreLanguage::class),
+            shopName: $shopName,
+        );
+
+        $translatedString = uniqid() . ' %s';
+        $langStub->method('translateString')
+            ->with(ModuleCore::GENERAL_GREETING_LANGUAGE_CONST)
+            ->willReturn($translatedString);
+
+        $this->assertSame(sprintf($translatedString, $shopName), $service->getGeneralGreeting());
+    }
+
     public function testGenericGreetingNoUserForGenericMode(): void
     {
-        $service = new GreetingMessageService(
+        $service = $this->getSut(
             moduleSettings: $moduleSettingsStub = $this->createMock(ModuleSettingsServiceInterface::class),
-            shopRequest: $this->createStub(CoreRequest::class),
             shopLanguage: $langStub = $this->createStub(CoreLanguage::class),
         );
 
@@ -41,9 +56,8 @@ public function testGenericGreetingNoUserForGenericMode(): void
 
     public function testGenericGreetingWithUserForGenericMode(): void
     {
-        $service = new GreetingMessageService(
+        $service = $this->getSut(
             moduleSettings: $moduleSettingsStub = $this->createMock(ModuleSettingsServiceInterface::class),
-            shopRequest: $this->createStub(CoreRequest::class),
             shopLanguage: $langStub = $this->createStub(CoreLanguage::class),
         );
 
@@ -60,15 +74,27 @@ public function testGenericGreetingWithUserForGenericMode(): void
 
     public function testGenericGreetingNoUserForPersonalMode(): void
     {
-        $service = new GreetingMessageService(
+        $service = $this->getSut(
             moduleSettings: $moduleSettingsStub = $this->createMock(ModuleSettingsServiceInterface::class),
-            shopRequest: $this->createStub(CoreRequest::class),
-            shopLanguage: $this->createStub(CoreLanguage::class),
         );
 
         $moduleSettingsStub->method('getGreetingMode')
             ->willReturn(ModuleSettingsServiceInterface::GREETING_MODE_PERSONAL);
 
         $this->assertSame('', $service->getGreeting(null));
     }
+
+    private function getSut(
+        ?ModuleSettingsServiceInterface $moduleSettings = null,
+        ?CoreRequest $shopRequest = null,
+        ?CoreLanguage $shopLanguage = null,
+        ?string $shopName = null,
+    ): GreetingMessageService {
+        return new GreetingMessageService(
+            moduleSettings: $moduleSettings ?? $this->createStub(ModuleSettingsServiceInterface::class),
+            shopRequest: $shopRequest ?? $this->createStub(CoreRequest::class),
+            shopLanguage: $shopLanguage ?? $this->createStub(CoreLanguage::class),
+            shopName: $shopName ?? uniqid(),
+        );
+    }
 }
diff --git a/translations/de/module_de_lang.php b/translations/de/module_de_lang.php
@@ -9,7 +9,7 @@
 
 $aLang = [
     'charset'                           => 'UTF-8',
-    'OEEXAMPLESMODULE_GREETING'         => 'Willkommen im besten Shop aller Zeiten!',
+    'OEEXAMPLESMODULE_GREETING'         => 'Willkommen im besten Shop aller Zeiten: %s!',
     'OEEXAMPLESMODULE_GREETING_GENERIC' => 'Frohes Shoppen :)',
     'OEEXAMPLESMODULE_GREETING_UPDATE'  => 'Begrüßung wählen',
     'OEEXAMPLESMODULE_GREETING_UPDATE_TITLE'  => 'Begrüßung bitte hier wählen',
diff --git a/translations/en/module_en_lang.php b/translations/en/module_en_lang.php
@@ -9,7 +9,7 @@
 
 $aLang = [
     'charset'                   => 'UTF-8',
-    'OEEXAMPLESMODULE_GREETING' => 'Welcome to the best shop ever!',
+    'OEEXAMPLESMODULE_GREETING' => 'Welcome to the best shop ever: %s!',
     'OEEXAMPLESMODULE_GREETING_GENERIC' => 'Have fun :)',
     'OEEXAMPLESMODULE_GREETING_UPDATE'  => 'Update greeting',
     'OEEXAMPLESMODULE_GREETING_UPDATE_TITLE'  => 'Please update greeting',
diff --git a/views/twig/extensions/themes/default/page/shop/start.html.twig b/views/twig/extensions/themes/default/page/shop/start.html.twig
@@ -2,7 +2,9 @@
 {% block start_newest_articles %}
     <p>
         <!-- If the module is active, the template block will be extended and this line is shown -->
-        {{ translate({ ident: "OEEXAMPLESMODULE_GREETING" }) }}
+        {% if oView.showOeemGeneralGreeting %}
+            {{ oView.getOeemGeneralGreeting() }}
+        {% endif %}
         <!-- And in case we have the module setting and a logged in user, we might see some additional text-->
         {{ oView.getOeemGreeting() }}
         <!-- Allow logged in user to change his greeting text -->

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Move this file to the root directory of your project or merge it with the existing one`
	`2`	`+SHOW_GENERAL_GREETING=true`
	`3`	`+OEEM_SHOP_NAME='OXID eShop'`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@`
`13`	`13`
`14`	`14`	`interface GreetingMessageServiceInterface`
`15`	`15`	`{`
	`16`	`+ public function getGeneralGreeting(): string;`
	`17`	`+`
`16`	`18`	`public function getGreeting(?EshopModelUser $user = null): string;`
`17`	`19`
`18`	`20`	`public function saveGreeting(EshopModelUser $user): bool;`
Original file line number	Diff line number	Diff line change
`@@ -24,12 +24,12 @@ public function testCanDeactivateModule(AcceptanceTester $I): void`
`24`	`24`	`$I->wantToTest('that deactivating the module does not destroy the shop');`
`25`	`25`
`26`	`26`	`$I->openShop();`
`27`		`- $I->waitForText(Translator::translate('OEEXAMPLESMODULE_GREETING'));`
	`27`	`+ $I->waitForText(sprintf(Translator::translate('OEEXAMPLESMODULE_GREETING'), getenv('OEEM_SHOP_NAME')));`
`28`	`28`
`29`	`29`	`$I->deactivateModule(Module::MODULE_ID);`
`30`	`30`	`$I->reloadPage();`
`31`	`31`
`32`	`32`	`$I->waitForPageLoad();`
`33`		`- $I->dontSee(Translator::translate('OEEXAMPLESMODULE_GREETING'));`
	`33`	`+ $I->dontSee(sprintf(Translator::translate('OEEXAMPLESMODULE_GREETING'), getenv('OEEM_SHOP_NAME')));`
`34`	`34`	`}`
`35`	`35`	`}`