src/Core/Content/Product/SalesChannel/CrossSelling/ProductCrossSellingRoute.php line 50

  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(private readonly EntityRepository $crossSellingRepository, private readonly EventDispatcherInterface $eventDispatcher, private readonly ProductStreamBuilderInterface $productStreamBuilder, private readonly SalesChannelRepository $productRepository, private readonly SystemConfigService $systemConfigService, private readonly ProductListingLoader $listingLoader, private readonly AbstractProductCloseoutFilterFactory $productCloseoutFilterFactory)
  39.     {
  40.     }
  42.     public function getDecorated(): AbstractProductCrossSellingRoute
  43.     {
  44.         throw new DecorationPatternException(self::class);
  45.     }
  47.     #[Route(path: '/store-api/product/{productId}/cross-selling', name: 'store-api.product.cross-selling', methods: ['POST'], defaults: ['_entity' => 'product'])]
  48.     public function load(string $productId, Request $request, SalesChannelContext $context, Criteria $criteria): ProductCrossSellingRouteResponse
  49.     {
  50.         $crossSellings = $this->loadCrossSellings($productId, $context);
  52.         $elements = new CrossSellingElementCollection();
  54.         foreach ($crossSellings as $crossSelling) {
  55.             $clone = clone $criteria;
  56.             if ($this->useProductStream($crossSelling)) {
  57.                 $element = $this->loadByStream($crossSelling, $context, $clone);
  58.             } else {
  59.                 $element = $this->loadByIds($crossSelling, $context, $clone);
  60.             }
  62.             $elements->add($element);
  63.         }
  65.         $this->eventDispatcher->dispatch(new ProductCrossSellingsLoadedEvent($elements, $context));
  67.         return new ProductCrossSellingRouteResponse($elements);
  68.     }
  70.     private function loadCrossSellings(string $productId, SalesChannelContext $context): ProductCrossSellingCollection
  71.     {
  72.         $criteria = new Criteria();
  73.         $criteria->setTitle('product-cross-selling-route');
  74.         $criteria
  75.             ->addAssociation('assignedProducts')
  76.             ->addFilter(new EqualsFilter('product.id', $productId))
  77.             ->addFilter(new EqualsFilter('active', 1))
  78.             ->addSorting(new FieldSorting('position', FieldSorting::ASCENDING));
  80.         $this->eventDispatcher->dispatch(
  81.             new ProductCrossSellingCriteriaLoadEvent($criteria, $context)
  82.         );
  84.         /** @var ProductCrossSellingCollection $crossSellings */
  85.         $crossSellings = $this->crossSellingRepository
  86.             ->search($criteria, $context->getContext())
  87.             ->getEntities();
  89.         return $crossSellings;
  90.     }
  92.     private function loadByStream(ProductCrossSellingEntity $crossSelling, SalesChannelContext $context, Criteria $criteria): CrossSellingElement
  93.     {
  94.         /** @var string $productStreamId */
  95.         $productStreamId = $crossSelling->getProductStreamId();
  97.         $filters = $this->productStreamBuilder->buildFilters(
  98.             $productStreamId,
  99.             $context->getContext()
  100.         );
  102.         $criteria->addFilter(...$filters)
  103.             ->setOffset(0)
  104.             ->setLimit($crossSelling->getLimit())
  105.             ->addSorting($crossSelling->getSorting());
  107.         $criteria = $this->handleAvailableStock($criteria, $context);
  109.         $this->eventDispatcher->dispatch(
  110.             new ProductCrossSellingStreamCriteriaEvent($crossSelling, $criteria, $context)
  111.         );
  113.         $searchResult = $this->listingLoader->load($criteria, $context);
  115.         /** @var ProductCollection $products */
  116.         $products = $searchResult->getEntities();
  118.         $element = new CrossSellingElement();
  119.         $element->setCrossSelling($crossSelling);
  120.         $element->setProducts($products);
  121.         $element->setStreamId($crossSelling->getProductStreamId());
  123.         $element->setTotal($products->count());
  125.         return $element;
  126.     }
  128.     private function loadByIds(ProductCrossSellingEntity $crossSelling, SalesChannelContext $context, Criteria $criteria): CrossSellingElement
  129.     {
  130.         $element = new CrossSellingElement();
  131.         $element->setCrossSelling($crossSelling);
  132.         $element->setProducts(new ProductCollection());
  133.         $element->setTotal(0);
  135.         if (!$crossSelling->getAssignedProducts()) {
  136.             return $element;
  137.         }
  139.         $crossSelling->getAssignedProducts()->sortByPosition();
  141.         $ids = array_values($crossSelling->getAssignedProducts()->getProductIds());
  143.         $filter = new ProductAvailableFilter(
  144.             $context->getSalesChannel()->getId(),
  145.             ProductVisibilityDefinition::VISIBILITY_LINK
  146.         );
  148.         if (!\count($ids)) {
  149.             return $element;
  150.         }
  152.         $criteria->setIds($ids);
  153.         $criteria->addFilter($filter);
  154.         $criteria->addAssociation('options.group');
  156.         $criteria = $this->handleAvailableStock($criteria, $context);
  158.         $this->eventDispatcher->dispatch(
  159.             new ProductCrossSellingIdsCriteriaEvent($crossSelling, $criteria, $context)
  160.         );
  162.         $result = $this->productRepository
  163.             ->search($criteria, $context);
  165.         /** @var ProductCollection $products */
  166.         $products = $result->getEntities();
  168.         $products->sortByIdArray($ids);
  170.         $element->setProducts($products);
  171.         $element->setTotal(\count($products));
  173.         return $element;
  174.     }
  176.     private function handleAvailableStock(Criteria $criteria, SalesChannelContext $context): Criteria
  177.     {
  178.         $salesChannelId = $context->getSalesChannel()->getId();
  179.         $hide = $this->systemConfigService->get('core.listing.hideCloseoutProductsWhenOutOfStock', $salesChannelId);
  181.         if (!$hide) {
  182.             return $criteria;
  183.         }
  185.         $closeoutFilter = $this->productCloseoutFilterFactory->create($context);
  186.         $criteria->addFilter($closeoutFilter);
  188.         return $criteria;
  189.     }
  191.     private function useProductStream(ProductCrossSellingEntity $crossSelling): bool
  192.     {
  193.         return $crossSelling->getType() === ProductCrossSellingDefinition::TYPE_PRODUCT_STREAM
  194.             && $crossSelling->getProductStreamId() !== null;
  195.     }
  196. }