vendor/shopware/storefront/Theme/Twig/ThemeNamespaceHierarchyBuilder.php line 56

  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(
  32.         private readonly ThemeInheritanceBuilderInterface $themeInheritanceBuilder,
  33.         private readonly SalesChannelThemeLoader $salesChannelThemeLoader
  34.     ) {
  35.     }
  37.     /**
  38.      * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
  39.      */
  40.     public static function getSubscribedEvents(): array
  41.     {
  42.         return [
  43.             KernelEvents::REQUEST => 'requestEvent',
  44.             KernelEvents::EXCEPTION => 'requestEvent',
  45.             DocumentTemplateRendererParameterEvent::class => 'onDocumentRendering',
  46.         ];
  47.     }
  49.     public function requestEvent(RequestEvent $event): void
  50.     {
  51.         $request = $event->getRequest();
  53.         $this->themes = $this->detectedThemes($request);
  54.     }
  56.     public function onDocumentRendering(DocumentTemplateRendererParameterEvent $event): void
  57.     {
  58.         $parameters = $event->getParameters();
  60.         if (!\array_key_exists('context', $parameters)) {
  61.             return;
  62.         }
  64.         /** @var SalesChannelContext $context */
  65.         $context = $parameters['context'];
  67.         $themes = [];
  69.         $theme = $this->salesChannelThemeLoader->load($context->getSalesChannelId());
  71.         if (empty($theme['themeName'])) {
  72.             return;
  73.         }
  75.         $themes[$theme['themeName']] = true;
  76.         $themes['Storefront'] = true;
  78.         $this->themes = $themes;
  79.     }
  81.     public function buildNamespaceHierarchy(array $namespaceHierarchy): array
  82.     {
  83.         if (empty($this->themes)) {
  84.             return $namespaceHierarchy;
  85.         }
  87.         return $this->themeInheritanceBuilder->build($namespaceHierarchy, $this->themes);
  88.     }
  90.     public function reset(): void
  91.     {
  92.         $this->themes = [];
  93.     }
  95.     /**
  96.      * @return array<int|string, bool>
  97.      */
  98.     private function detectedThemes(Request $request): array
  99.     {
  100.         $themes = [];
  101.         // get name if theme is not inherited
  102.         $theme = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_THEME_NAME);
  104.         if (!$theme) {
  105.             // get theme name from base theme because for inherited themes the name is always null
  106.             $theme = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_THEME_BASE_NAME);
  107.         }
  109.         if (!$theme) {
  110.             return [];
  111.         }
  113.         $themes[$theme] = true;
  114.         $themes['Storefront'] = true;
  116.         return $themes;
  117.     }
  118. }