src/Core/Checkout/Promotion/Subscriber/Storefront/StorefrontCartSubscriber.php line 44

  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(private readonly CartService $cartService, private readonly RequestStack $requestStack)
  32.     {
  33.     }
  35.     public static function getSubscribedEvents(): array
  36.     {
  37.         return [
  38.             BeforeLineItemAddedEvent::class => 'onLineItemAdded',
  39.             BeforeLineItemRemovedEvent::class => 'onLineItemRemoved',
  40.             CheckoutOrderPlacedEvent::class => 'resetCodes',
  41.         ];
  42.     }
  44.     public function resetCodes(): void
  45.     {
  46.         $mainRequest = $this->requestStack->getMainRequest();
  48.         if ($mainRequest === null) {
  49.             return;
  50.         }
  52.         if (!$mainRequest->hasSession()) {
  53.             return;
  54.         }
  56.         $mainRequest->getSession()->set(self::SESSION_KEY_PROMOTION_CODES, []);
  57.     }
  59.     /**
  60.      * This function is called whenever a new line item has been
  61.      * added to the cart from within the controllers.
  62.      * We verify if we have a placeholder line item for a promotion
  63.      * and add that code to our extension list.
  64.      */
  65.     public function onLineItemAdded(BeforeLineItemAddedEvent $event): void
  66.     {
  67.         if ($event->getLineItem()->getType() === PromotionProcessor::LINE_ITEM_TYPE) {
  68.             $code = $event->getLineItem()->getReferencedId();
  70.             if ($code !== null && $code !== '') {
  71.                 $this->addCode($code, $event->getCart());
  72.             }
  73.         }
  74.     }
  76.     /**
  77.      * This function is called whenever a line item is being removed
  78.      * from the cart from within a controller.
  79.      * We verify if it is a promotion item, and also remove that
  80.      * code from our extension, if existing.
  81.      */
  82.     public function onLineItemRemoved(BeforeLineItemRemovedEvent $event): void
  83.     {
  84.         $cart = $event->getCart();
  86.         if ($event->getLineItem()->getType() !== PromotionProcessor::LINE_ITEM_TYPE) {
  87.             return;
  88.         }
  90.         $lineItem = $event->getLineItem();
  92.         $code = $lineItem->getReferencedId();
  94.         if (!empty($code)) {
  95.             // promotion with code
  96.             $this->checkFixedDiscountItems($cart, $lineItem);
  97.             //remove other discounts of the promotion that should be deleted
  98.             $this->removeOtherDiscountsOfPromotion($cart, $lineItem, $event->getSalesChannelContext());
  99.             $this->removeCode($code, $cart);
  101.             return;
  102.         }
  104.         // the user wants to remove an automatic added
  105.         // promotions, so lets do this
  106.         if ($lineItem->hasPayloadValue('promotionId')) {
  107.             $promotionId = (string) $lineItem->getPayloadValue('promotionId');
  108.             $this->blockPromotion($promotionId, $cart);
  109.         }
  110.     }
  112.     /**
  113.      * @throws CartException
  114.      */
  115.     private function checkFixedDiscountItems(Cart $cart, LineItem $lineItem): void
  116.     {
  117.         $lineItems = $cart->getLineItems()->filterType(PromotionProcessor::LINE_ITEM_TYPE);
  118.         if ($lineItems->count() < 1) {
  119.             return;
  120.         }
  122.         if (!$lineItem->hasPayloadValue('discountType')) {
  123.             return;
  124.         }
  126.         if ($lineItem->getPayloadValue('discountType') !== PromotionDiscountEntity::TYPE_FIXED_UNIT) {
  127.             return;
  128.         }
  130.         if (!$lineItem->hasPayloadValue('discountId')) {
  131.             return;
  132.         }
  134.         $discountId = $lineItem->getPayloadValue('discountId');
  136.         $removeThisDiscounts = $lineItems->filter(static fn (LineItem $lineItem) => $lineItem->hasPayloadValue('discountId') && $lineItem->getPayloadValue('discountId') === $discountId);
  138.         foreach ($removeThisDiscounts as $discountItem) {
  139.             $cart->remove($discountItem->getId());
  140.         }
  141.     }
  143.     private function removeOtherDiscountsOfPromotion(Cart $cart, LineItem $lineItem, SalesChannelContext $context): void
  144.     {
  145.         // ge all promotions from cart
  146.         $lineItems = $cart->getLineItems()->filterType(PromotionProcessor::LINE_ITEM_TYPE);
  147.         if ($lineItems->count() < 1) {
  148.             return;
  149.         }
  151.         //filter them by the promotion which discounts should be deleted
  152.         $lineItems = $lineItems->filter(fn (LineItem $promotionLineItem) => $promotionLineItem->getPayloadValue('promotionId') === $lineItem->getPayloadValue('promotionId'));
  154.         if ($lineItems->count() < 1) {
  155.             return;
  156.         }
  158.         $promotionLineItem = $lineItems->first();
  160.         if ($promotionLineItem instanceof LineItem) {
  161.             // this is recursive because we are listening on LineItemRemovedEvent, it will stop if there
  162.             // are no discounts in the cart, that belong to the promotion that should be deleted
  163.             $this->cartService->remove($cart, $promotionLineItem->getId(), $context);
  164.         }
  165.     }
  167.     private function addCode(string $code, Cart $cart): void
  168.     {
  169.         $extension = $this->getExtension($cart);
  170.         $extension->addCode($code);
  172.         $cart->addExtension(CartExtension::KEY, $extension);
  173.     }
  175.     private function removeCode(string $code, Cart $cart): void
  176.     {
  177.         $extension = $this->getExtension($cart);
  178.         $extension->removeCode($code);
  180.         $cart->addExtension(CartExtension::KEY, $extension);
  181.     }
  183.     private function blockPromotion(string $id, Cart $cart): void
  184.     {
  185.         $extension = $this->getExtension($cart);
  186.         $extension->blockPromotion($id);
  188.         $cart->addExtension(CartExtension::KEY, $extension);
  189.     }
  191.     private function getExtension(Cart $cart): CartExtension
  192.     {
  193.         if (!$cart->hasExtension(CartExtension::KEY)) {
  194.             $cart->addExtension(CartExtension::KEY, new CartExtension());
  195.         }
  197.         /** @var CartExtension $extension */
  198.         $extension = $cart->getExtension(CartExtension::KEY);
  200.         return $extension;
  201.     }
  202. }