vendor/shopware/core/Checkout/Promotion/Subscriber/Storefront/StorefrontCartSubscriber.php line 46

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Checkout\Promotion\Subscriber\Storefront;
  5. use Shopware\Core\Checkout\Cart\Cart;
  6. use Shopware\Core\Checkout\Cart\CartException;
  7. use Shopware\Core\Checkout\Cart\Event\BeforeLineItemAddedEvent;
  8. use Shopware\Core\Checkout\Cart\Event\BeforeLineItemRemovedEvent;
  9. use Shopware\Core\Checkout\Cart\Event\CheckoutOrderPlacedEvent;
  10. use Shopware\Core\Checkout\Cart\LineItem\LineItem;
  11. use Shopware\Core\Checkout\Cart\SalesChannel\CartService;
  12. use Shopware\Core\Checkout\Promotion\Aggregate\PromotionDiscount\PromotionDiscountEntity;
  13. use Shopware\Core\Checkout\Promotion\Cart\Extension\CartExtension;
  14. use Shopware\Core\Checkout\Promotion\Cart\PromotionProcessor;
  15. use Shopware\Core\Framework\Log\Package;
  16. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  17. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  18. use Symfony\Component\HttpFoundation\RequestStack;
  20. /**
  21.  * @internal
  22.  */
  23. #[Package('checkout')]
  24. class StorefrontCartSubscriber implements EventSubscriberInterface
  25. {
  26.     final public const SESSION_KEY_PROMOTION_CODES = 'cart-promotion-codes';
  28.     /**
  29.      * @internal
  30.      */
  31.     public function __construct(
  32.         private readonly CartService $cartService,
  33.         private readonly RequestStack $requestStack
  34.     ) {
  35.     }
  37.     public static function getSubscribedEvents(): array
  38.     {
  39.         return [
  40.             BeforeLineItemAddedEvent::class => 'onLineItemAdded',
  41.             BeforeLineItemRemovedEvent::class => 'onLineItemRemoved',
  42.             CheckoutOrderPlacedEvent::class => 'resetCodes',
  43.         ];
  44.     }
  46.     public function resetCodes(): void
  47.     {
  48.         $mainRequest = $this->requestStack->getMainRequest();
  50.         if ($mainRequest === null) {
  51.             return;
  52.         }
  54.         if (!$mainRequest->hasSession()) {
  55.             return;
  56.         }
  58.         $mainRequest->getSession()->set(self::SESSION_KEY_PROMOTION_CODES, []);
  59.     }
  61.     /**
  62.      * This function is called whenever a new line item has been
  63.      * added to the cart from within the controllers.
  64.      * We verify if we have a placeholder line item for a promotion
  65.      * and add that code to our extension list.
  66.      */
  67.     public function onLineItemAdded(BeforeLineItemAddedEvent $event): void
  68.     {
  69.         if ($event->getLineItem()->getType() === PromotionProcessor::LINE_ITEM_TYPE) {
  70.             $code = $event->getLineItem()->getReferencedId();
  72.             if ($code !== null && $code !== '') {
  73.                 $this->addCode($code, $event->getCart());
  74.             }
  75.         }
  76.     }
  78.     /**
  79.      * This function is called whenever a line item is being removed
  80.      * from the cart from within a controller.
  81.      * We verify if it is a promotion item, and also remove that
  82.      * code from our extension, if existing.
  83.      */
  84.     public function onLineItemRemoved(BeforeLineItemRemovedEvent $event): void
  85.     {
  86.         $cart = $event->getCart();
  88.         if ($event->getLineItem()->getType() !== PromotionProcessor::LINE_ITEM_TYPE) {
  89.             return;
  90.         }
  92.         $lineItem = $event->getLineItem();
  94.         $code = $lineItem->getReferencedId();
  96.         if (!empty($code)) {
  97.             // promotion with code
  98.             $this->checkFixedDiscountItems($cart, $lineItem);
  99.             //remove other discounts of the promotion that should be deleted
  100.             $this->removeOtherDiscountsOfPromotion($cart, $lineItem, $event->getSalesChannelContext());
  101.             $this->removeCode($code, $cart);
  103.             return;
  104.         }
  106.         // the user wants to remove an automatic added
  107.         // promotions, so lets do this
  108.         if ($lineItem->hasPayloadValue('promotionId')) {
  109.             $promotionId = (string) $lineItem->getPayloadValue('promotionId');
  110.             $this->blockPromotion($promotionId, $cart);
  111.         }
  112.     }
  114.     /**
  115.      * @throws CartException
  116.      */
  117.     private function checkFixedDiscountItems(Cart $cart, LineItem $lineItem): void
  118.     {
  119.         $lineItems = $cart->getLineItems()->filterType(PromotionProcessor::LINE_ITEM_TYPE);
  120.         if ($lineItems->count() < 1) {
  121.             return;
  122.         }
  124.         if (!$lineItem->hasPayloadValue('discountType')) {
  125.             return;
  126.         }
  128.         if ($lineItem->getPayloadValue('discountType') !== PromotionDiscountEntity::TYPE_FIXED_UNIT) {
  129.             return;
  130.         }
  132.         if (!$lineItem->hasPayloadValue('discountId')) {
  133.             return;
  134.         }
  136.         $discountId = $lineItem->getPayloadValue('discountId');
  138.         $removeThisDiscounts = $lineItems->filter(static fn (LineItem $lineItem) => $lineItem->hasPayloadValue('discountId') && $lineItem->getPayloadValue('discountId') === $discountId);
  140.         foreach ($removeThisDiscounts as $discountItem) {
  141.             $cart->remove($discountItem->getId());
  142.         }
  143.     }
  145.     private function removeOtherDiscountsOfPromotion(Cart $cart, LineItem $lineItem, SalesChannelContext $context): void
  146.     {
  147.         // ge all promotions from cart
  148.         $lineItems = $cart->getLineItems()->filterType(PromotionProcessor::LINE_ITEM_TYPE);
  149.         if ($lineItems->count() < 1) {
  150.             return;
  151.         }
  153.         //filter them by the promotion which discounts should be deleted
  154.         $lineItems = $lineItems->filter(fn (LineItem $promotionLineItem) => $promotionLineItem->getPayloadValue('promotionId') === $lineItem->getPayloadValue('promotionId'));
  156.         if ($lineItems->count() < 1) {
  157.             return;
  158.         }
  160.         $promotionLineItem = $lineItems->first();
  162.         if ($promotionLineItem instanceof LineItem) {
  163.             // this is recursive because we are listening on LineItemRemovedEvent, it will stop if there
  164.             // are no discounts in the cart, that belong to the promotion that should be deleted
  165.             $this->cartService->remove($cart, $promotionLineItem->getId(), $context);
  166.         }
  167.     }
  169.     private function addCode(string $code, Cart $cart): void
  170.     {
  171.         $extension = $this->getExtension($cart);
  172.         $extension->addCode($code);
  174.         $cart->addExtension(CartExtension::KEY, $extension);
  175.     }
  177.     private function removeCode(string $code, Cart $cart): void
  178.     {
  179.         $extension = $this->getExtension($cart);
  180.         $extension->removeCode($code);
  182.         $cart->addExtension(CartExtension::KEY, $extension);
  183.     }
  185.     private function blockPromotion(string $id, Cart $cart): void
  186.     {
  187.         $extension = $this->getExtension($cart);
  188.         $extension->blockPromotion($id);
  190.         $cart->addExtension(CartExtension::KEY, $extension);
  191.     }
  193.     private function getExtension(Cart $cart): CartExtension
  194.     {
  195.         if (!$cart->hasExtension(CartExtension::KEY)) {
  196.             $cart->addExtension(CartExtension::KEY, new CartExtension());
  197.         }
  199.         /** @var CartExtension $extension */
  200.         $extension = $cart->getExtension(CartExtension::KEY);
  202.         return $extension;
  203.     }
  204. }