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

Open in your IDE?
  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\EntityRepositoryInterface;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
  16. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  17. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  18. use Symfony\Component\HttpFoundation\Request;
  20. class SalesChannelCmsPageLoader implements SalesChannelCmsPageLoaderInterface
  21. {
  22.     private EntityRepositoryInterface $cmsPageRepository;
  24.     private CmsSlotsDataResolver $slotDataResolver;
  26.     private EventDispatcherInterface $eventDispatcher;
  28.     /**
  29.      * @internal
  30.      */
  31.     public function __construct(
  32.         EntityRepositoryInterface $cmsPageRepository,
  33.         CmsSlotsDataResolver $slotDataResolver,
  34.         EventDispatcherInterface $eventDispatcher
  35.     ) {
  36.         $this->cmsPageRepository = $cmsPageRepository;
  37.         $this->slotDataResolver = $slotDataResolver;
  38.         $this->eventDispatcher = $eventDispatcher;
  39.     }
  41.     public function load(
  42.         Request $request,
  43.         Criteria $criteria,
  44.         SalesChannelContext $context,
  45.         ?array $config = null,
  46.         ?ResolverContext $resolverContext = null
  47.     ): EntitySearchResult {
  48.         $this->eventDispatcher->dispatch(new CmsPageLoaderCriteriaEvent($request, $criteria, $context));
  49.         $config = $config ?? [];
  51.         // ensure sections, blocks and slots are loaded, slots and blocks can be restricted by caller
  52.         $criteria->addAssociation('sections.backgroundMedia');
  53.         $criteria->addAssociation('sections.blocks.backgroundMedia');
  54.         $criteria->addAssociation('sections.blocks.slots');
  56.         // step 1, load cms pages with blocks and slots
  57.         $pages = $this->cmsPageRepository->search($criteria, $context->getContext());
  59.         foreach ($pages as $page) {
  60.             if ($page->getSections() === null) {
  61.                 continue;
  62.             }
  64.             $page->getSections()->sort(function (CmsSectionEntity $a, CmsSectionEntity $b) {
  65.                 return $a->getPosition() <=> $b->getPosition();
  66.             });
  68.             if (!$resolverContext) {
  69.                 $resolverContext = new ResolverContext($context, $request);
  70.             }
  72.             // step 2, sort blocks into sectionPositions
  73.             foreach ($page->getSections() as $section) {
  74.                 $section->getBlocks()->sort(function (CmsBlockEntity $a, CmsBlockEntity $b) {
  75.                     return $a->getPosition() <=> $b->getPosition();
  76.                 });
  78.                 foreach ($section->getBlocks() as $block) {
  79.                     $block->getSlots()->sort(function (CmsSlotEntity $a, CmsSlotEntity $b) {
  80.                         return $a->getSlot() <=> $b->getSlot();
  81.                     });
  82.                 }
  83.             }
  85.             // step 3, find config overwrite
  86.             $overwrite = $config[$page->getId()] ?? $config;
  88.             // step 4, overwrite slot config
  89.             $this->overwriteSlotConfig($page, $overwrite);
  91.             // step 5, resolve slot data
  92.             $this->loadSlotData($page, $resolverContext);
  93.         }
  95.         $this->eventDispatcher->dispatch(new CmsPageLoadedEvent($request, $pages->getEntities(), $context));
  97.         return $pages;
  98.     }
  100.     private function loadSlotData(CmsPageEntity $page, ResolverContext $resolverContext): void
  101.     {
  102.         $slots = $this->slotDataResolver->resolve($page->getSections()->getBlocks()->getSlots(), $resolverContext);
  104.         $page->getSections()->getBlocks()->setSlots($slots);
  105.     }
  107.     private function overwriteSlotConfig(CmsPageEntity $page, array $config): void
  108.     {
  109.         foreach ($page->getSections()->getBlocks()->getSlots() as $slot) {
  110.             if ($slot->getConfig() === null && $slot->getTranslation('config') !== null) {
  111.                 $slot->setConfig($slot->getTranslation('config'));
  112.             }
  114.             if (empty($config)) {
  115.                 continue;
  116.             }
  118.             if (!isset($config[$slot->getId()])) {
  119.                 continue;
  120.             }
  122.             $defaultConfig = $slot->getConfig() ?? [];
  123.             $merged = array_replace_recursive(
  124.                 $defaultConfig,
  125.                 $config[$slot->getId()]
  126.             );
  128.             $slot->setConfig($merged);
  129.             $slot->addTranslated('config', $merged);
  130.         }
  131.     }
  132. }