OXDEV-9553 Handle template module extensions of other modules

Author: AshrafOxid

CHANGELOG-2.x.md

@@ -5,6 +5,9 @@
 ### Added
 - Improved template rendering performance
 
+### Fixed
+- Extended the module template using an extension from another module
+
 ## v2.6.0 - 2025-04-09
 
 ### Added

services.yaml

@@ -279,6 +279,11 @@ services:
     arguments:
       Symfony\Component\Filesystem\Filesystem: '@oxid_esales.symfony.file_system'
 
+
+  OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ChainPrepender:
+    arguments:
+      Symfony\Component\Filesystem\Filesystem: '@oxid_esales.symfony.file_system'
+
   OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ShopTemplateHandler:
 
   OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ModuleTemplateHandler:
@@ -295,6 +300,10 @@ services:
 
   OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ModuleExtensions\ModuleTemplateHandler:
 
+  OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ModuleExtensions\ParentModuleTemplateHandler:
+    arguments:
+      - '@OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ChainPrepender'
+
   OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ModuleExtensions\ModuleExtensionTemplateHandler:
 
   oxid_esales.twig.resolver.template_chain.shop_template_chain_builder:
@@ -313,6 +322,7 @@ services:
         - '@OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ModuleExtensions\ShopExtensionTemplateHandler'
         - '@OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ModuleTemplateHandler'
         - '@OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ModuleExtensions\ModuleTemplateHandler'
+        - '@OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ModuleExtensions\ParentModuleTemplateHandler'
         - '@OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ModuleExtensions\ModuleExtensionTemplateHandler'
 
   OxidEsales\Twig\Resolver\TemplateChain\TemplateChainBuilderInterface:

src/Resolver/TemplateChain/DataObject/TemplateChain.php

@@ -31,6 +31,11 @@ public function append(TemplateTypeInterface $templateType): void
         $this->chain[$templateType->getFullyQualifiedName()] = $templateType;
     }
 
+    public function prepend(TemplateTypeInterface $templateType): void
+    {
+        $this->chain = array_merge([$templateType->getFullyQualifiedName() => $templateType], $this->chain);
+    }
+
     public function remove(TemplateTypeInterface $templateType): void
     {
         unset($this->chain[$templateType->getFullyQualifiedName()]);

src/Resolver/TemplateChain/TemplateHandler/ChainAppender.php

@@ -30,6 +30,7 @@ public function addToChain(
         if ($this->directoryContainsTemplateFile($directory, $templateType)) {
             $templateChain->append($templateType);
         }
+
         return $templateChain;
     }
 

src/Resolver/TemplateChain/TemplateHandler/ChainPrepender.php

@@ -0,0 +1,45 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler;
+
+use OxidEsales\Twig\Resolver\DataObject\NamespacedDirectory;
+use OxidEsales\Twig\Resolver\TemplateChain\DataObject\TemplateChain;
+use OxidEsales\Twig\Resolver\TemplateChain\TemplateType\DataObject\TemplateTypeInterface;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Filesystem\Path;
+
+class ChainPrepender implements ChainAppenderInterface
+{
+    public function __construct(
+        private Filesystem $filesystem,
+    ) {
+    }
+
+    public function addToChain(
+        TemplateChain $templateChain,
+        TemplateTypeInterface $templateType,
+        NamespacedDirectory $directory
+    ): TemplateChain {
+        if ($this->directoryContainsTemplateFile($directory, $templateType)) {
+            $templateChain->prepend($templateType);
+        }
+
+        return $templateChain;
+    }
+
+    private function directoryContainsTemplateFile(
+        NamespacedDirectory $directory,
+        TemplateTypeInterface $template
+    ): bool {
+        return $this->filesystem->exists(
+            Path::join($directory->getDirectory(), $template->getRelativeFilePath())
+        );
+    }
+}

src/Resolver/TemplateChain/TemplateHandler/ModuleExtensions/ModuleTemplateHandler.php

@@ -32,6 +32,7 @@ public function addToChain(
             return $templateChain;
         }
         $extension = $this->getExtension($templateType, $directory);
+
         return $this->chainAppender->addToChain($templateChain, $extension, $directory);
     }
 

src/Resolver/TemplateChain/TemplateHandler/ModuleExtensions/ParentModuleTemplateHandler.php

@@ -0,0 +1,60 @@
+<?php
+
+/**
+ * Copyright © OXID eSales AG. All rights reserved.
+ * See LICENSE file for license details.
+ */
+
+declare(strict_types=1);
+
+namespace OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ModuleExtensions;
+
+use OxidEsales\Twig\Resolver\DataObject\NamespacedDirectory;
+use OxidEsales\Twig\Resolver\TemplateChain\DataObject\TemplateChain;
+use OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\ChainAppenderInterface;
+use OxidEsales\Twig\Resolver\TemplateChain\TemplateHandler\TemplateTypeCheckerInterface;
+use OxidEsales\Twig\Resolver\TemplateChain\TemplateType\DataObject\ModuleExtensionTemplateType;
+use OxidEsales\Twig\Resolver\TemplateChain\TemplateType\DataObject\TemplateTypeInterface;
+
+class ParentModuleTemplateHandler implements ChainAppenderInterface, TemplateTypeCheckerInterface
+{
+    public function __construct(
+        private ChainAppenderInterface $chainAppender,
+    ) {
+    }
+
+    public function addToChain(
+        TemplateChain $templateChain,
+        TemplateTypeInterface $templateType,
+        NamespacedDirectory $directory
+    ): TemplateChain {
+        $extension = $this->getExtension($templateType, $directory);
+        if (!$this->canHandle($templateType) && !$this->isChildModule($templateChain, $extension)) {
+            return $templateChain;
+        }
+
+        return $this->chainAppender->addToChain($templateChain, $extension, $directory);
+    }
+
+    public function canHandle(TemplateTypeInterface $templateType): bool
+    {
+        return $templateType->isModuleTemplate();
+    }
+
+    private function isChildModule(TemplateChain $templateChain, ModuleExtensionTemplateType $extension): bool
+    {
+        return $templateChain->hasModuleId($extension->getParentNamespace())
+            && $extension->getParentNamespace() === $extension->getNamespace();
+    }
+
+    private function getExtension(
+        TemplateTypeInterface $templateType,
+        NamespacedDirectory $directory
+    ): ModuleExtensionTemplateType {
+        return new ModuleExtensionTemplateType(
+            $templateType->getName(),
+            $directory->getNamespace(),
+            $templateType->getNamespace()
+        );
+    }
+}