src/Core/Content/Product/Cms/ProductListingCmsElementResolver.php line 59

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Product\Cms;
  5. use Shopware\Core\Content\Cms\Aggregate\CmsSlot\CmsSlotEntity;
  6. use Shopware\Core\Content\Cms\DataResolver\CriteriaCollection;
  7. use Shopware\Core\Content\Cms\DataResolver\Element\AbstractCmsElementResolver;
  8. use Shopware\Core\Content\Cms\DataResolver\Element\ElementDataCollection;
  9. use Shopware\Core\Content\Cms\DataResolver\ResolverContext\ResolverContext;
  10. use Shopware\Core\Content\Cms\SalesChannel\Struct\ProductListingStruct;
  11. use Shopware\Core\Content\Product\SalesChannel\Listing\AbstractProductListingRoute;
  12. use Shopware\Core\Content\Product\SalesChannel\Listing\ProductListingFeaturesSubscriber;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  14. use Shopware\Core\Framework\Log\Package;
  15. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  16. use Symfony\Component\HttpFoundation\Request;
  18. #[Package('inventory')]
  19. class ProductListingCmsElementResolver extends AbstractCmsElementResolver
  20. {
  21.     /**
  22.      * @internal
  23.      */
  24.     public function __construct(private readonly AbstractProductListingRoute $listingRoute)
  25.     {
  26.     }
  28.     public function getType(): string
  29.     {
  30.         return 'product-listing';
  31.     }
  33.     public function collect(CmsSlotEntity $slot, ResolverContext $resolverContext): ?CriteriaCollection
  34.     {
  35.         return null;
  36.     }
  38.     public function enrich(CmsSlotEntity $slot, ResolverContext $resolverContext, ElementDataCollection $result): void
  39.     {
  40.         $data = new ProductListingStruct();
  41.         $slot->setData($data);
  43.         $request = $resolverContext->getRequest();
  44.         $context = $resolverContext->getSalesChannelContext();
  46.         $this->restrictFilters($slot, $request);
  48.         if ($this->isCustomSorting($slot)) {
  49.             $this->restrictSortings($request, $slot);
  50.             $this->addDefaultSorting($request, $slot);
  51.         }
  53.         $navigationId = $this->getNavigationId($request, $context);
  55.         $criteria = new Criteria();
  56.         $criteria->setTitle('cms::product-listing');
  58.         $listing = $this->listingRoute
  59.             ->load($navigationId, $request, $context, $criteria)
  60.             ->getResult();
  62.         $data->setListing($listing);
  63.     }
  65.     private function getNavigationId(Request $request, SalesChannelContext $salesChannelContext): string
  66.     {
  67.         if ($navigationId = $request->get('navigationId')) {
  68.             return $navigationId;
  69.         }
  71.         $params = $request->attributes->get('_route_params');
  73.         if ($params && isset($params['navigationId'])) {
  74.             return $params['navigationId'];
  75.         }
  77.         return $salesChannelContext->getSalesChannel()->getNavigationCategoryId();
  78.     }
  80.     private function isCustomSorting(CmsSlotEntity $slot): bool
  81.     {
  82.         $config = $slot->getTranslation('config');
  84.         if ($config && isset($config['useCustomSorting']) && isset($config['useCustomSorting']['value'])) {
  85.             return $config['useCustomSorting']['value'];
  86.         }
  88.         return false;
  89.     }
  91.     private function addDefaultSorting(Request $request, CmsSlotEntity $slot): void
  92.     {
  93.         if ($request->get('order')) {
  94.             return;
  95.         }
  97.         $config = $slot->getTranslation('config');
  99.         if ($config && isset($config['defaultSorting']) && isset($config['defaultSorting']['value']) && $config['defaultSorting']['value']) {
  100.             $request->request->set('order', $config['defaultSorting']['value']);
  102.             return;
  103.         }
  105.         // if we have no specific order given at this point, set the order to be the highest's priority available sorting
  106.         if ($request->get('availableSortings')) {
  107.             $availableSortings = $request->get('availableSortings');
  108.             arsort($availableSortings, \SORT_DESC | \SORT_NUMERIC);
  110.             $request->request->set('order', array_key_first($availableSortings));
  111.         }
  112.     }
  114.     private function restrictSortings(Request $request, CmsSlotEntity $slot): void
  115.     {
  116.         $config = $slot->getTranslation('config');
  118.         if (!$config || !isset($config['availableSortings']) || !isset($config['availableSortings']['value'])) {
  119.             return;
  120.         }
  122.         $request->request->set('availableSortings', $config['availableSortings']['value']);
  123.     }
  125.     private function restrictFilters(CmsSlotEntity $slot, Request $request): void
  126.     {
  127.         // setup the default behavior
  128.         $defaults = ['manufacturer-filter', 'rating-filter', 'shipping-free-filter', 'price-filter', 'property-filter'];
  130.         $request->request->set(ProductListingFeaturesSubscriber::PROPERTY_GROUP_IDS_REQUEST_PARAM, null);
  132.         $config = $slot->get('config');
  134.         if (isset($config['propertyWhitelist']['value']) && (is_countable($config['propertyWhitelist']['value']) ? \count($config['propertyWhitelist']['value']) : 0) > 0) {
  135.             $request->request->set(ProductListingFeaturesSubscriber::PROPERTY_GROUP_IDS_REQUEST_PARAM, $config['propertyWhitelist']['value']);
  136.         }
  138.         if (!isset($config['filters']['value'])) {
  139.             return;
  140.         }
  142.         // apply config settings
  143.         $config = explode(',', (string) $config['filters']['value']);
  145.         foreach ($defaults as $filter) {
  146.             if (\in_array($filter, $config, true)) {
  147.                 continue;
  148.             }
  150.             $request->request->set($filter, false);
  151.         }
  152.     }
  153. }