src/Core/Content/Cms/SalesChannel/SalesChannelCmsPageLoader.php line 76

  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\CmsSectionEntity;
  7. use Shopware\Core\Content\Cms\Aggregate\CmsSlot\CmsSlotEntity;
  8. use Shopware\Core\Content\Cms\CmsPageEntity;
  9. use Shopware\Core\Content\Cms\DataResolver\CmsSlotsDataResolver;
  10. use Shopware\Core\Content\Cms\DataResolver\ResolverContext\ResolverContext;
  11. use Shopware\Core\Content\Cms\Events\CmsPageLoadedEvent;
  12. use Shopware\Core\Content\Cms\Events\CmsPageLoaderCriteriaEvent;
  13. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
  16. use Shopware\Core\Framework\Log\Package;
  17. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  18. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  19. use Symfony\Component\HttpFoundation\Request;
  21. #[Package('content')]
  22. class SalesChannelCmsPageLoader implements SalesChannelCmsPageLoaderInterface
  23. {
  24.     /**
  25.      * @internal
  26.      */
  27.     public function __construct(private readonly EntityRepository $cmsPageRepository, private readonly CmsSlotsDataResolver $slotDataResolver, private readonly EventDispatcherInterface $eventDispatcher)
  28.     {
  29.     }
  31.     public function load(
  32.         Request $request,
  33.         Criteria $criteria,
  34.         SalesChannelContext $context,
  35.         ?array $config = null,
  36.         ?ResolverContext $resolverContext = null
  37.     ): EntitySearchResult {
  38.         $this->eventDispatcher->dispatch(new CmsPageLoaderCriteriaEvent($request, $criteria, $context));
  39.         $config ??= [];
  41.         // ensure sections, blocks and slots are loaded, slots and blocks can be restricted by caller
  42.         $criteria->addAssociation('sections.backgroundMedia');
  43.         $criteria->addAssociation('sections.blocks.backgroundMedia');
  44.         $criteria->addAssociation('sections.blocks.slots');
  46.         // step 1, load cms pages with blocks and slots
  47.         $pages = $this->cmsPageRepository->search($criteria, $context->getContext());
  49.         foreach ($pages as $page) {
  50.             if ($page->getSections() === null) {
  51.                 continue;
  52.             }
  54.             $page->getSections()->sort(fn (CmsSectionEntity $a, CmsSectionEntity $b) => $a->getPosition() <=> $b->getPosition());
  56.             if (!$resolverContext) {
  57.                 $resolverContext = new ResolverContext($context, $request);
  58.             }
  60.             // step 2, sort blocks into sectionPositions
  61.             foreach ($page->getSections() as $section) {
  62.                 $section->getBlocks()->sort(fn (CmsBlockEntity $a, CmsBlockEntity $b) => $a->getPosition() <=> $b->getPosition());
  64.                 foreach ($section->getBlocks() as $block) {
  65.                     $block->getSlots()->sort(fn (CmsSlotEntity $a, CmsSlotEntity $b) => $a->getSlot() <=> $b->getSlot());
  66.                 }
  67.             }
  69.             // step 3, find config overwrite
  70.             $overwrite = $config[$page->getId()] ?? $config;
  72.             // step 4, overwrite slot config
  73.             $this->overwriteSlotConfig($page, $overwrite);
  75.             // step 5, resolve slot data
  76.             $this->loadSlotData($page, $resolverContext);
  77.         }
  79.         $this->eventDispatcher->dispatch(new CmsPageLoadedEvent($request, $pages->getEntities(), $context));
  81.         return $pages;
  82.     }
  84.     private function loadSlotData(CmsPageEntity $page, ResolverContext $resolverContext): void
  85.     {
  86.         $slots = $this->slotDataResolver->resolve($page->getSections()->getBlocks()->getSlots(), $resolverContext);
  88.         $page->getSections()->getBlocks()->setSlots($slots);
  89.     }
  91.     private function overwriteSlotConfig(CmsPageEntity $page, array $config): void
  92.     {
  93.         foreach ($page->getSections()->getBlocks()->getSlots() as $slot) {
  94.             if ($slot->getConfig() === null && $slot->getTranslation('config') !== null) {
  95.                 $slot->setConfig($slot->getTranslation('config'));
  96.             }
  98.             if (empty($config)) {
  99.                 continue;
  100.             }
  102.             if (!isset($config[$slot->getId()])) {
  103.                 continue;
  104.             }
  106.             $defaultConfig = $slot->getConfig() ?? [];
  107.             $merged = array_replace_recursive(
  108.                 $defaultConfig,
  109.                 $config[$slot->getId()]
  110.             );
  112.             $slot->setConfig($merged);
  113.             $slot->addTranslated('config', $merged);
  114.         }
  115.     }
  116. }