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

Open in your IDE?
  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.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  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.     private ThemeInheritanceBuilderInterface $themeInheritanceBuilder;
  30.     private SalesChannelThemeLoader $salesChannelThemeLoader;
  32.     /**
  33.      * @internal
  34.      */
  35.     public function __construct(
  36.         ThemeInheritanceBuilderInterface $themeInheritanceBuilder,
  37.         SalesChannelThemeLoader $salesChannelThemeLoader
  38.     ) {
  39.         $this->themeInheritanceBuilder = $themeInheritanceBuilder;
  40.         $this->salesChannelThemeLoader = $salesChannelThemeLoader;
  41.     }
  43.     /**
  44.      * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
  45.      */
  46.     public static function getSubscribedEvents()
  47.     {
  48.         return [
  49.             KernelEvents::REQUEST => 'requestEvent',
  50.             KernelEvents::EXCEPTION => 'requestEvent',
  51.             DocumentTemplateRendererParameterEvent::class => 'onDocumentRendering',
  52.         ];
  53.     }
  55.     public function requestEvent(RequestEvent $event): void
  56.     {
  57.         $request = $event->getRequest();
  59.         $this->themes = $this->detectedThemes($request);
  60.     }
  62.     public function onDocumentRendering(DocumentTemplateRendererParameterEvent $event): void
  63.     {
  64.         $parameters = $event->getParameters();
  66.         if (!\array_key_exists('context', $parameters)) {
  67.             return;
  68.         }
  70.         /** @var SalesChannelContext $context */
  71.         $context = $parameters['context'];
  73.         $themes = [];
  75.         $theme = $this->salesChannelThemeLoader->load($context->getSalesChannelId());
  77.         if (empty($theme['themeName'])) {
  78.             return;
  79.         }
  81.         $themes[$theme['themeName']] = true;
  82.         $themes['Storefront'] = true;
  84.         $this->themes = $themes;
  85.     }
  87.     public function buildNamespaceHierarchy(array $namespaceHierarchy): array
  88.     {
  89.         if (empty($this->themes)) {
  90.             return $namespaceHierarchy;
  91.         }
  93.         return $this->themeInheritanceBuilder->build($namespaceHierarchy, $this->themes);
  94.     }
  96.     public function reset(): void
  97.     {
  98.         $this->themes = [];
  99.     }
  101.     /**
  102.      * @return array<int|string, bool>
  103.      */
  104.     private function detectedThemes(Request $request): array
  105.     {
  106.         // get name if theme is not inherited
  107.         $theme = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_THEME_NAME);
  109.         if (!$theme) {
  110.             // get theme name from base theme because for inherited themes the name is always null
  111.             $theme = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_THEME_BASE_NAME);
  112.         }
  114.         if (!$theme) {
  115.             return [];
  116.         }
  118.         $themes[$theme] = true;
  119.         $themes['Storefront'] = true;
  121.         return $themes;
  122.     }
  123. }