vendor/shopware/core/Content/Cms/SalesChannel/SalesChannelCmsPageLoader.php line 43

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Cms\SalesChannel;
  5. use Shopware\Core\Content\Cms\Aggregate\CmsBlock\CmsBlockEntity;
  6. use Shopware\Core\Content\Cms\Aggregate\CmsSection\CmsSectionCollection;
  7. use Shopware\Core\Content\Cms\Aggregate\CmsSection\CmsSectionEntity;
  8. use Shopware\Core\Content\Cms\Aggregate\CmsSlot\CmsSlotEntity;
  9. use Shopware\Core\Content\Cms\CmsPageCollection;
  10. use Shopware\Core\Content\Cms\CmsPageEntity;
  11. use Shopware\Core\Content\Cms\DataResolver\CmsSlotsDataResolver;
  12. use Shopware\Core\Content\Cms\DataResolver\ResolverContext\ResolverContext;
  13. use Shopware\Core\Content\Cms\Events\CmsPageLoadedEvent;
  14. use Shopware\Core\Content\Cms\Events\CmsPageLoaderCriteriaEvent;
  15. use Shopware\Core\Content\Cms\SalesChannel\Struct\ProductBoxStruct;
  16. use Shopware\Core\Content\Cms\SalesChannel\Struct\ProductSliderStruct;
  17. use Shopware\Core\Framework\Adapter\Cache\Event\AddCacheTagEvent;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Cache\EntityCacheKeyGenerator;
  19. use Shopware\Core\Framework\DataAbstractionLayer\EntityCollection;
  20. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  21. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  22. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
  23. use Shopware\Core\Framework\Log\Package;
  24. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  25. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  26. use Symfony\Component\HttpFoundation\Request;
  28. #[Package('buyers-experience')]
  29. class SalesChannelCmsPageLoader implements SalesChannelCmsPageLoaderInterface
  30. {
  31.     /**
  32.      * @internal
  33.      *
  34.      * @param EntityRepository<CmsPageCollection> $cmsPageRepository
  35.      */
  36.     public function __construct(
  37.         private readonly EntityRepository $cmsPageRepository,
  38.         private readonly CmsSlotsDataResolver $slotDataResolver,
  39.         private readonly EventDispatcherInterface $dispatcher
  40.     ) {
  41.     }
  43.     public function load(
  44.         Request $request,
  45.         Criteria $criteria,
  46.         SalesChannelContext $context,
  47.         ?array $config = null,
  48.         ?ResolverContext $resolverContext = null
  49.     ): EntitySearchResult {
  50.         $this->dispatcher->dispatch(new CmsPageLoaderCriteriaEvent($request, $criteria, $context));
  51.         $config ??= [];
  53.         // ensure sections, blocks and slots are loaded, slots and blocks can be restricted by caller
  54.         $criteria->addAssociation('sections.backgroundMedia');
  55.         $criteria->addAssociation('sections.blocks.backgroundMedia');
  56.         $criteria->addAssociation('sections.blocks.slots');
  58.         // step 1, load cms pages with blocks and slots
  59.         $result = $this->cmsPageRepository->search($criteria, $context->getContext());
  60.         $pages = $result->getEntities();
  62.         foreach ($pages as $page) {
  63.             $sections = $page->getSections();
  65.             if ($sections === null) {
  66.                 continue;
  67.             }
  69.             $sections->sort(fn (CmsSectionEntity $a, CmsSectionEntity $b) => $a->getPosition() <=> $b->getPosition());
  71.             if (!$resolverContext) {
  72.                 $resolverContext = new ResolverContext($context, $request);
  73.             }
  75.             // step 2, sort blocks into sectionPositions
  76.             foreach ($sections as $section) {
  77.                 $blocks = $section->getBlocks();
  78.                 if ($blocks === null) {
  79.                     continue;
  80.                 }
  81.                 $blocks->sort(fn (CmsBlockEntity $a, CmsBlockEntity $b) => $a->getPosition() <=> $b->getPosition());
  83.                 foreach ($blocks as $block) {
  84.                     $slots = $block->getSlots();
  85.                     if ($slots === null) {
  86.                         continue;
  87.                     }
  88.                     $slots->sort(fn (CmsSlotEntity $a, CmsSlotEntity $b) => $a->getSlot() <=> $b->getSlot());
  89.                 }
  90.             }
  92.             // step 3, find config overwrite
  93.             $overwrite = $config[$page->getId()] ?? $config;
  95.             // step 4, overwrite slot config
  96.             $this->overwriteSlotConfig($sections, $overwrite);
  98.             // step 5, resolve slot data
  99.             $this->loadSlotData($sections, $resolverContext);
  100.         }
  102.         $this->dispatcher->dispatch(new CmsPageLoadedEvent($request, $pages, $context));
  104.         $this->dispatcher->dispatch(new AddCacheTagEvent(...$this->extractProductIds($pages)));
  106.         return $result;
  107.     }
  109.     private function loadSlotData(CmsSectionCollection $sections, ResolverContext $resolverContext): void
  110.     {
  111.         $blocks = $sections->getBlocks();
  112.         $slots = $this->slotDataResolver->resolve($blocks->getSlots(), $resolverContext);
  114.         $blocks->setSlots($slots);
  115.     }
  117.     /**
  118.      * @param array<string, mixed> $config
  119.      */
  120.     private function overwriteSlotConfig(CmsSectionCollection $sections, array $config): void
  121.     {
  122.         foreach ($sections->getBlocks()->getSlots() as $slot) {
  123.             if ($slot->getConfig() === null && $slot->getTranslation('config') !== null) {
  124.                 $slot->setConfig($slot->getTranslation('config'));
  125.             }
  127.             if (empty($config)) {
  128.                 continue;
  129.             }
  131.             if (!isset($config[$slot->getId()])) {
  132.                 continue;
  133.             }
  135.             $defaultConfig = $slot->getConfig() ?? [];
  136.             $merged = array_replace_recursive(
  137.                 $defaultConfig,
  138.                 $config[$slot->getId()]
  139.             );
  141.             $slot->setConfig($merged);
  142.             $slot->addTranslated('config', $merged);
  143.         }
  144.     }
  146.     /**
  147.      * @param EntityCollection<CmsPageEntity> $pages
  148.      *
  149.      * @return array<string>
  150.      */
  151.     private function extractProductIds(EntityCollection $pages): array
  152.     {
  153.         $ids = [];
  154.         $streamIds = [];
  156.         /** @var CmsPageEntity $page */
  157.         foreach ($pages as $page) {
  158.             $slots = $page->getElementsOfType('product-slider');
  160.             /** @var CmsSlotEntity $slot */
  161.             foreach ($slots as $slot) {
  162.                 $slider = $slot->getData();
  164.                 if (!$slider instanceof ProductSliderStruct) {
  165.                     continue;
  166.                 }
  168.                 if ($slider->getStreamId() !== null) {
  169.                     $streamIds[] = $slider->getStreamId();
  170.                 }
  172.                 if ($slider->getProducts() === null) {
  173.                     continue;
  174.                 }
  175.                 foreach ($slider->getProducts() as $product) {
  176.                     $ids[] = $product->getId();
  177.                     $ids[] = $product->getParentId();
  178.                 }
  179.             }
  181.             $slots = $page->getElementsOfType('product-box');
  182.             /** @var CmsSlotEntity $slot */
  183.             foreach ($slots as $slot) {
  184.                 $box = $slot->getData();
  186.                 if (!$box instanceof ProductBoxStruct) {
  187.                     continue;
  188.                 }
  189.                 if ($box->getProduct() === null) {
  190.                     continue;
  191.                 }
  193.                 $ids[] = $box->getProduct()->getId();
  194.                 $ids[] = $box->getProduct()->getParentId();
  195.             }
  197.             $ids = array_values(array_unique(array_filter($ids)));
  198.         }
  200.         return [
  201.             ...array_map(EntityCacheKeyGenerator::buildProductTag(...), $ids),
  202.             ...array_map(EntityCacheKeyGenerator::buildStreamTag(...), $streamIds),
  203.             ...array_map(EntityCacheKeyGenerator::buildCmsTag(...), $pages->getIds()),
  204.         ];
  205.     }
  206. }