src/Storefront/Theme/Twig/ThemeNamespaceHierarchyBuilder.php line 54

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Theme\Twig;
  5. use Shopware\Core\Checkout\Document\Event\DocumentTemplateRendererParameterEvent;
  6. use Shopware\Core\Framework\Adapter\Twig\NamespaceHierarchy\TemplateNamespaceHierarchyBuilderInterface;
  7. use Shopware\Core\Framework\Log\Package;
  8. use Shopware\Core\SalesChannelRequest;
  9. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  10. use Shopware\Storefront\Theme\SalesChannelThemeLoader;
  11. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  12. use Symfony\Component\HttpFoundation\Request;
  13. use Symfony\Component\HttpKernel\Event\RequestEvent;
  14. use Symfony\Component\HttpKernel\KernelEvents;
  15. use Symfony\Contracts\Service\ResetInterface;
  17. /**
  18.  * @internal
  19.  */
  20. #[Package('storefront')]
  21. class ThemeNamespaceHierarchyBuilder implements TemplateNamespaceHierarchyBuilderInterface, EventSubscriberInterface, ResetInterface
  22. {
  23.     /**
  24.      * @var array<int|string, bool>
  25.      */
  26.     private array $themes = [];
  28.     /**
  29.      * @internal
  30.      */
  31.     public function __construct(private readonly ThemeInheritanceBuilderInterface $themeInheritanceBuilder, private readonly SalesChannelThemeLoader $salesChannelThemeLoader)
  32.     {
  33.     }
  35.     /**
  36.      * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
  37.      */
  38.     public static function getSubscribedEvents(): array
  39.     {
  40.         return [
  41.             KernelEvents::REQUEST => 'requestEvent',
  42.             KernelEvents::EXCEPTION => 'requestEvent',
  43.             DocumentTemplateRendererParameterEvent::class => 'onDocumentRendering',
  44.         ];
  45.     }
  47.     public function requestEvent(RequestEvent $event): void
  48.     {
  49.         $request = $event->getRequest();
  51.         $this->themes = $this->detectedThemes($request);
  52.     }
  54.     public function onDocumentRendering(DocumentTemplateRendererParameterEvent $event): void
  55.     {
  56.         $parameters = $event->getParameters();
  58.         if (!\array_key_exists('context', $parameters)) {
  59.             return;
  60.         }
  62.         /** @var SalesChannelContext $context */
  63.         $context = $parameters['context'];
  65.         $themes = [];
  67.         $theme = $this->salesChannelThemeLoader->load($context->getSalesChannelId());
  69.         if (empty($theme['themeName'])) {
  70.             return;
  71.         }
  73.         $themes[$theme['themeName']] = true;
  74.         $themes['Storefront'] = true;
  76.         $this->themes = $themes;
  77.     }
  79.     public function buildNamespaceHierarchy(array $namespaceHierarchy): array
  80.     {
  81.         if (empty($this->themes)) {
  82.             return $namespaceHierarchy;
  83.         }
  85.         return $this->themeInheritanceBuilder->build($namespaceHierarchy, $this->themes);
  86.     }
  88.     public function reset(): void
  89.     {
  90.         $this->themes = [];
  91.     }
  93.     /**
  94.      * @return array<int|string, bool>
  95.      */
  96.     private function detectedThemes(Request $request): array
  97.     {
  98.         $themes = [];
  99.         // get name if theme is not inherited
  100.         $theme = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_THEME_NAME);
  102.         if (!$theme) {
  103.             // get theme name from base theme because for inherited themes the name is always null
  104.             $theme = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_THEME_BASE_NAME);
  105.         }
  107.         if (!$theme) {
  108.             return [];
  109.         }
  111.         $themes[$theme] = true;
  112.         $themes['Storefront'] = true;
  114.         return $themes;
  115.     }
  116. }