src/Core/Content/Product/SalesChannel/Listing/ProductListingLoader.php line 48

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Product\SalesChannel\Listing;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\Content\Product\Events\ProductListingPreviewCriteriaEvent;
  7. use Shopware\Core\Content\Product\Events\ProductListingResolvePreviewEvent;
  8. use Shopware\Core\Content\Product\ProductCollection;
  9. use Shopware\Core\Content\Product\ProductDefinition;
  10. use Shopware\Core\Content\Product\SalesChannel\AbstractProductCloseoutFilterFactory;
  11. use Shopware\Core\Content\Product\SalesChannel\ProductAvailableFilter;
  12. use Shopware\Core\Framework\DataAbstractionLayer\Entity;
  13. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  14. use Shopware\Core\Framework\DataAbstractionLayer\Search\EntitySearchResult;
  15. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\NotFilter;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Search\Grouping\FieldGrouping;
  18. use Shopware\Core\Framework\DataAbstractionLayer\Search\IdSearchResult;
  19. use Shopware\Core\Framework\Log\Package;
  20. use Shopware\Core\Framework\Struct\ArrayEntity;
  21. use Shopware\Core\Framework\Uuid\Uuid;
  22. use Shopware\Core\System\SalesChannel\Entity\SalesChannelRepository;
  23. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  24. use Shopware\Core\System\SystemConfig\SystemConfigService;
  25. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  27. #[Package('inventory')]
  28. class ProductListingLoader
  29. {
  30.     /**
  31.      * @internal
  32.      */
  33.     public function __construct(private readonly SalesChannelRepository $repository, private readonly SystemConfigService $systemConfigService, private readonly Connection $connection, private readonly EventDispatcherInterface $eventDispatcher, private readonly AbstractProductCloseoutFilterFactory $productCloseoutFilterFactory)
  34.     {
  35.     }
  37.     public function load(Criteria $origin, SalesChannelContext $context): EntitySearchResult
  38.     {
  39.         $origin->addState(Criteria::STATE_ELASTICSEARCH_AWARE);
  40.         $criteria = clone $origin;
  42.         $this->addGrouping($criteria);
  43.         $this->handleAvailableStock($criteria, $context);
  45.         $ids = $this->repository->searchIds($criteria, $context);
  46.         /** @var list<string> $keys */
  47.         $keys = $ids->getIds();
  48.         $aggregations = $this->repository->aggregate($criteria, $context);
  50.         // no products found, no need to continue
  51.         if (empty($keys)) {
  52.             return new EntitySearchResult(
  53.                 ProductDefinition::ENTITY_NAME,
  54.                 0,
  55.                 new ProductCollection(),
  56.                 $aggregations,
  57.                 $origin,
  58.                 $context->getContext()
  59.             );
  60.         }
  62.         $mapping = array_combine($keys, $keys);
  64.         $hasOptionFilter = $this->hasOptionFilter($criteria);
  65.         if (!$hasOptionFilter) {
  66.             $mapping = $this->resolvePreviews($keys, $context);
  67.         }
  69.         $event = new ProductListingResolvePreviewEvent($context, $criteria, $mapping, $hasOptionFilter);
  70.         $this->eventDispatcher->dispatch($event);
  71.         $mapping = $event->getMapping();
  73.         $read = $criteria->cloneForRead(array_values($mapping));
  74.         $read->addAssociation('options.group');
  76.         $entities = $this->repository->search($read, $context);
  78.         $this->addExtensions($ids, $entities, $mapping);
  80.         $result = new EntitySearchResult(ProductDefinition::ENTITY_NAME, $ids->getTotal(), $entities->getEntities(), $aggregations, $origin, $context->getContext());
  81.         $result->addState(...$ids->getStates());
  83.         return $result;
  84.     }
  86.     private function hasOptionFilter(Criteria $criteria): bool
  87.     {
  88.         $filters = $criteria->getPostFilters();
  90.         $fields = [];
  91.         foreach ($filters as $filter) {
  92.             array_push($fields, ...$filter->getFields());
  93.         }
  95.         $fields = array_map(fn (string $field) => preg_replace('/^product./', '', $field), $fields);
  97.         if (\in_array('options.id', $fields, true)) {
  98.             return true;
  99.         }
  101.         if (\in_array('optionIds', $fields, true)) {
  102.             return true;
  103.         }
  105.         return false;
  106.     }
  108.     private function addGrouping(Criteria $criteria): void
  109.     {
  110.         $criteria->addGroupField(new FieldGrouping('displayGroup'));
  112.         $criteria->addFilter(
  113.             new NotFilter(
  114.                 NotFilter::CONNECTION_AND,
  115.                 [new EqualsFilter('displayGroup', null)]
  116.             )
  117.         );
  118.     }
  120.     private function handleAvailableStock(Criteria $criteria, SalesChannelContext $context): void
  121.     {
  122.         $salesChannelId = $context->getSalesChannel()->getId();
  124.         $hide = $this->systemConfigService->get('core.listing.hideCloseoutProductsWhenOutOfStock', $salesChannelId);
  126.         if (!$hide) {
  127.             return;
  128.         }
  130.         $closeoutFilter = $this->productCloseoutFilterFactory->create($context);
  131.         $criteria->addFilter($closeoutFilter);
  132.     }
  134.     /**
  135.      * @param array<string> $ids
  136.      *
  137.      * @throws \JsonException
  138.      *
  139.      * @return array<string>
  140.      */
  141.     private function resolvePreviews(array $ids, SalesChannelContext $context): array
  142.     {
  143.         $ids = array_combine($ids, $ids);
  145.         $config = $this->connection->fetchAllAssociative(
  146.             '# product-listing-loader::resolve-previews
  147.             SELECT
  148.                 parent.variant_listing_config as variantListingConfig,
  149.                 LOWER(HEX(child.id)) as id,
  150.                 LOWER(HEX(parent.id)) as parentId
  151.              FROM product as child
  152.                 INNER JOIN product as parent
  153.                     ON parent.id = child.parent_id
  154.                     AND parent.version_id = child.version_id
  155.              WHERE child.version_id = :version
  156.              AND child.id IN (:ids)',
  157.             [
  158.                 'ids' => Uuid::fromHexToBytesList(array_values($ids)),
  159.                 'version' => Uuid::fromHexToBytes($context->getContext()->getVersionId()),
  160.             ],
  161.             ['ids' => Connection::PARAM_STR_ARRAY]
  162.         );
  164.         $mapping = [];
  165.         foreach ($config as $item) {
  166.             if ($item['variantListingConfig'] === null) {
  167.                 continue;
  168.             }
  169.             $variantListingConfig = json_decode((string) $item['variantListingConfig'], true, 512, \JSON_THROW_ON_ERROR);
  171.             if (isset($variantListingConfig['mainVariantId']) && $variantListingConfig['mainVariantId']) {
  172.                 $mapping[$item['id']] = $variantListingConfig['mainVariantId'];
  173.             }
  175.             if (isset($variantListingConfig['displayParent']) && $variantListingConfig['displayParent']) {
  176.                 $mapping[$item['id']] = $item['parentId'];
  177.             }
  178.         }
  180.         // now we have a mapping for "child => main variant"
  181.         if (empty($mapping)) {
  182.             return $ids;
  183.         }
  185.         // filter inactive and not available variants
  186.         $criteria = new Criteria(array_values($mapping));
  187.         $criteria->addFilter(new ProductAvailableFilter($context->getSalesChannel()->getId()));
  188.         $this->handleAvailableStock($criteria, $context);
  190.         $this->eventDispatcher->dispatch(
  191.             new ProductListingPreviewCriteriaEvent($criteria, $context)
  192.         );
  194.         $available = $this->repository->searchIds($criteria, $context);
  196.         $remapped = [];
  197.         // replace existing ids with main variant id
  198.         foreach ($ids as $id) {
  199.             // id has no mapped main_variant - keep old id
  200.             if (!isset($mapping[$id])) {
  201.                 $remapped[$id] = $id;
  203.                 continue;
  204.             }
  206.             // get access to main variant id over the fetched config mapping
  207.             $main = $mapping[$id];
  209.             // main variant is configured but not active/available - keep old id
  210.             if (!$available->has($main)) {
  211.                 $remapped[$id] = $id;
  213.                 continue;
  214.             }
  216.             // main variant is configured and available - add main variant id
  217.             $remapped[$id] = $main;
  218.         }
  220.         return $remapped;
  221.     }
  223.     /**
  224.      * @param array<string> $mapping
  225.      */
  226.     private function addExtensions(IdSearchResult $ids, EntitySearchResult $entities, array $mapping): void
  227.     {
  228.         foreach ($ids->getExtensions() as $name => $extension) {
  229.             $entities->addExtension($name, $extension);
  230.         }
  232.         /** @var string $id */
  233.         foreach ($ids->getIds() as $id) {
  234.             if (!isset($mapping[$id])) {
  235.                 continue;
  236.             }
  238.             // current id was mapped to another variant
  239.             if (!$entities->has($mapping[$id])) {
  240.                 continue;
  241.             }
  243.             /** @var Entity $entity */
  244.             $entity = $entities->get($mapping[$id]);
  246.             // get access to the data of the search result
  247.             $entity->addExtension('search', new ArrayEntity($ids->getDataOfId($id)));
  248.         }
  249.     }
  250. }