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

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\SalesChannelRequest;
  8. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  9. use Shopware\Storefront\Theme\SalesChannelThemeLoader;
  10. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  11. use Symfony\Component\HttpFoundation\Request;
  12. use Symfony\Component\HttpKernel\Event\RequestEvent;
  13. use Symfony\Component\HttpKernel\KernelEvents;
  14. use Symfony\Contracts\Service\ResetInterface;
  16. /**
  17.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  18.  */
  19. class ThemeNamespaceHierarchyBuilder implements TemplateNamespaceHierarchyBuilderInterface, EventSubscriberInterface, ResetInterface
  20. {
  21.     /**
  22.      * @var array<int|string, bool>
  23.      */
  24.     private array $themes = [];
  26.     private ThemeInheritanceBuilderInterface $themeInheritanceBuilder;
  28.     private SalesChannelThemeLoader $salesChannelThemeLoader;
  30.     /**
  31.      * @internal
  32.      */
  33.     public function __construct(
  34.         ThemeInheritanceBuilderInterface $themeInheritanceBuilder,
  35.         SalesChannelThemeLoader $salesChannelThemeLoader
  36.     ) {
  37.         $this->themeInheritanceBuilder = $themeInheritanceBuilder;
  38.         $this->salesChannelThemeLoader = $salesChannelThemeLoader;
  39.     }
  41.     /**
  42.      * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
  43.      */
  44.     public static function getSubscribedEvents()
  45.     {
  46.         return [
  47.             KernelEvents::REQUEST => 'requestEvent',
  48.             KernelEvents::EXCEPTION => 'requestEvent',
  49.             DocumentTemplateRendererParameterEvent::class => 'onDocumentRendering',
  50.         ];
  51.     }
  53.     public function requestEvent(RequestEvent $event): void
  54.     {
  55.         $request = $event->getRequest();
  57.         $this->themes = $this->detectedThemes($request);
  58.     }
  60.     public function onDocumentRendering(DocumentTemplateRendererParameterEvent $event): void
  61.     {
  62.         $parameters = $event->getParameters();
  64.         if (!\array_key_exists('context', $parameters)) {
  65.             return;
  66.         }
  68.         /** @var SalesChannelContext $context */
  69.         $context = $parameters['context'];
  71.         $themes = [];
  73.         $theme = $this->salesChannelThemeLoader->load($context->getSalesChannelId());
  75.         if (empty($theme['themeName'])) {
  76.             return;
  77.         }
  79.         $themes[$theme['themeName']] = true;
  80.         $themes['Storefront'] = true;
  82.         $this->themes = $themes;
  83.     }
  85.     public function buildNamespaceHierarchy(array $namespaceHierarchy): array
  86.     {
  87.         if (empty($this->themes)) {
  88.             return $namespaceHierarchy;
  89.         }
  91.         return $this->themeInheritanceBuilder->build($namespaceHierarchy, $this->themes);
  92.     }
  94.     public function reset(): void
  95.     {
  96.         $this->themes = [];
  97.     }
  99.     /**
  100.      * @return array<int|string, bool>
  101.      */
  102.     private function detectedThemes(Request $request): array
  103.     {
  104.         // get name if theme is not inherited
  105.         $theme = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_THEME_NAME);
  107.         if (!$theme) {
  108.             // get theme name from base theme because for inherited themes the name is always null
  109.             $theme = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_THEME_BASE_NAME);
  110.         }
  112.         if (!$theme) {
  113.             return [];
  114.         }
  116.         $themes[$theme] = true;
  117.         $themes['Storefront'] = true;
  119.         return $themes;
  120.     }
  121. }