vendor/shopware/core/Content/Product/SalesChannel/CrossSelling/ProductCrossSellingRoute.php line 57

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Content\Product\SalesChannel\CrossSelling;
  5. use Shopware\Core\Content\Product\Aggregate\ProductCrossSelling\ProductCrossSellingCollection;
  6. use Shopware\Core\Content\Product\Aggregate\ProductCrossSelling\ProductCrossSellingDefinition;
  7. use Shopware\Core\Content\Product\Aggregate\ProductCrossSelling\ProductCrossSellingEntity;
  8. use Shopware\Core\Content\Product\Aggregate\ProductVisibility\ProductVisibilityDefinition;
  9. use Shopware\Core\Content\Product\Events\ProductCrossSellingCriteriaLoadEvent;
  10. use Shopware\Core\Content\Product\Events\ProductCrossSellingIdsCriteriaEvent;
  11. use Shopware\Core\Content\Product\Events\ProductCrossSellingsLoadedEvent;
  12. use Shopware\Core\Content\Product\Events\ProductCrossSellingStreamCriteriaEvent;
  13. use Shopware\Core\Content\Product\ProductCollection;
  14. use Shopware\Core\Content\Product\SalesChannel\AbstractProductCloseoutFilterFactory;
  15. use Shopware\Core\Content\Product\SalesChannel\Listing\ProductListingLoader;
  16. use Shopware\Core\Content\Product\SalesChannel\ProductAvailableFilter;
  17. use Shopware\Core\Content\ProductStream\Service\ProductStreamBuilderInterface;
  18. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  19. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  20. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  21. use Shopware\Core\Framework\DataAbstractionLayer\Search\Sorting\FieldSorting;
  22. use Shopware\Core\Framework\Log\Package;
  23. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  24. use Shopware\Core\System\SalesChannel\Entity\SalesChannelRepository;
  25. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  26. use Shopware\Core\System\SystemConfig\SystemConfigService;
  27. use Symfony\Component\HttpFoundation\Request;
  28. use Symfony\Component\Routing\Annotation\Route;
  29. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  31. #[Route(defaults: ['_routeScope' => ['store-api']])]
  32. #[Package('inventory')]
  33. class ProductCrossSellingRoute extends AbstractProductCrossSellingRoute
  34. {
  35.     /**
  36.      * @internal
  37.      */
  38.     public function __construct(
  39.         private readonly EntityRepository $crossSellingRepository,
  40.         private readonly EventDispatcherInterface $eventDispatcher,
  41.         private readonly ProductStreamBuilderInterface $productStreamBuilder,
  42.         private readonly SalesChannelRepository $productRepository,
  43.         private readonly SystemConfigService $systemConfigService,
  44.         private readonly ProductListingLoader $listingLoader,
  45.         private readonly AbstractProductCloseoutFilterFactory $productCloseoutFilterFactory
  46.     ) {
  47.     }
  49.     public function getDecorated(): AbstractProductCrossSellingRoute
  50.     {
  51.         throw new DecorationPatternException(self::class);
  52.     }
  54.     #[Route(path: '/store-api/product/{productId}/cross-selling', name: 'store-api.product.cross-selling', methods: ['POST'], defaults: ['_entity' => 'product'])]
  55.     public function load(string $productId, Request $request, SalesChannelContext $context, Criteria $criteria): ProductCrossSellingRouteResponse
  56.     {
  57.         $crossSellings = $this->loadCrossSellings($productId, $context);
  59.         $elements = new CrossSellingElementCollection();
  61.         foreach ($crossSellings as $crossSelling) {
  62.             $clone = clone $criteria;
  63.             if ($this->useProductStream($crossSelling)) {
  64.                 $element = $this->loadByStream($crossSelling, $context, $clone);
  65.             } else {
  66.                 $element = $this->loadByIds($crossSelling, $context, $clone);
  67.             }
  69.             $elements->add($element);
  70.         }
  72.         $this->eventDispatcher->dispatch(new ProductCrossSellingsLoadedEvent($elements, $context));
  74.         return new ProductCrossSellingRouteResponse($elements);
  75.     }
  77.     private function loadCrossSellings(string $productId, SalesChannelContext $context): ProductCrossSellingCollection
  78.     {
  79.         $criteria = new Criteria();
  80.         $criteria->setTitle('product-cross-selling-route');
  81.         $criteria
  82.             ->addAssociation('assignedProducts')
  83.             ->addFilter(new EqualsFilter('product.id', $productId))
  84.             ->addFilter(new EqualsFilter('active', 1))
  85.             ->addSorting(new FieldSorting('position', FieldSorting::ASCENDING));
  87.         $this->eventDispatcher->dispatch(
  88.             new ProductCrossSellingCriteriaLoadEvent($criteria, $context)
  89.         );
  91.         /** @var ProductCrossSellingCollection $crossSellings */
  92.         $crossSellings = $this->crossSellingRepository
  93.             ->search($criteria, $context->getContext())
  94.             ->getEntities();
  96.         return $crossSellings;
  97.     }
  99.     private function loadByStream(ProductCrossSellingEntity $crossSelling, SalesChannelContext $context, Criteria $criteria): CrossSellingElement
  100.     {
  101.         /** @var string $productStreamId */
  102.         $productStreamId = $crossSelling->getProductStreamId();
  104.         $filters = $this->productStreamBuilder->buildFilters(
  105.             $productStreamId,
  106.             $context->getContext()
  107.         );
  109.         $criteria->addFilter(...$filters)
  110.             ->setOffset(0)
  111.             ->setLimit($crossSelling->getLimit())
  112.             ->addSorting($crossSelling->getSorting());
  114.         $criteria = $this->handleAvailableStock($criteria, $context);
  116.         $this->eventDispatcher->dispatch(
  117.             new ProductCrossSellingStreamCriteriaEvent($crossSelling, $criteria, $context)
  118.         );
  120.         $searchResult = $this->listingLoader->load($criteria, $context);
  122.         /** @var ProductCollection $products */
  123.         $products = $searchResult->getEntities();
  125.         $element = new CrossSellingElement();
  126.         $element->setCrossSelling($crossSelling);
  127.         $element->setProducts($products);
  128.         $element->setStreamId($crossSelling->getProductStreamId());
  130.         $element->setTotal($products->count());
  132.         return $element;
  133.     }
  135.     private function loadByIds(ProductCrossSellingEntity $crossSelling, SalesChannelContext $context, Criteria $criteria): CrossSellingElement
  136.     {
  137.         $element = new CrossSellingElement();
  138.         $element->setCrossSelling($crossSelling);
  139.         $element->setProducts(new ProductCollection());
  140.         $element->setTotal(0);
  142.         if (!$crossSelling->getAssignedProducts()) {
  143.             return $element;
  144.         }
  146.         $crossSelling->getAssignedProducts()->sortByPosition();
  148.         $ids = array_values($crossSelling->getAssignedProducts()->getProductIds());
  150.         $filter = new ProductAvailableFilter(
  151.             $context->getSalesChannel()->getId(),
  152.             ProductVisibilityDefinition::VISIBILITY_LINK
  153.         );
  155.         if (!\count($ids)) {
  156.             return $element;
  157.         }
  159.         $criteria->setIds($ids);
  160.         $criteria->addFilter($filter);
  161.         $criteria->addAssociation('options.group');
  163.         $criteria = $this->handleAvailableStock($criteria, $context);
  165.         $this->eventDispatcher->dispatch(
  166.             new ProductCrossSellingIdsCriteriaEvent($crossSelling, $criteria, $context)
  167.         );
  169.         $result = $this->productRepository
  170.             ->search($criteria, $context);
  172.         /** @var ProductCollection $products */
  173.         $products = $result->getEntities();
  175.         $products->sortByIdArray($ids);
  177.         $element->setProducts($products);
  178.         $element->setTotal(\count($products));
  180.         return $element;
  181.     }
  183.     private function handleAvailableStock(Criteria $criteria, SalesChannelContext $context): Criteria
  184.     {
  185.         $salesChannelId = $context->getSalesChannel()->getId();
  186.         $hide = $this->systemConfigService->get('core.listing.hideCloseoutProductsWhenOutOfStock', $salesChannelId);
  188.         if (!$hide) {
  189.             return $criteria;
  190.         }
  192.         $closeoutFilter = $this->productCloseoutFilterFactory->create($context);
  193.         $criteria->addFilter($closeoutFilter);
  195.         return $criteria;
  196.     }
  198.     private function useProductStream(ProductCrossSellingEntity $crossSelling): bool
  199.     {
  200.         return $crossSelling->getType() === ProductCrossSellingDefinition::TYPE_PRODUCT_STREAM
  201.             && $crossSelling->getProductStreamId() !== null;
  202.     }
  203. }