vendor/shopware/storefront/Controller/CartLineItemController.php line 239

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Storefront\Controller;
  5. use Shopware\Core\Checkout\Cart\Cart;
  6. use Shopware\Core\Checkout\Cart\CartException;
  7. use Shopware\Core\Checkout\Cart\Error\Error;
  8. use Shopware\Core\Checkout\Cart\Exception\LineItemNotFoundException;
  9. use Shopware\Core\Checkout\Cart\LineItem\LineItem;
  10. use Shopware\Core\Checkout\Cart\SalesChannel\CartService;
  11. use Shopware\Core\Checkout\Promotion\Cart\PromotionCartAddedInformationError;
  12. use Shopware\Core\Checkout\Promotion\Cart\PromotionItemBuilder;
  13. use Shopware\Core\Content\Product\Cart\ProductLineItemFactory;
  14. use Shopware\Core\Content\Product\Exception\ProductNotFoundException;
  15. use Shopware\Core\Content\Product\SalesChannel\AbstractProductListRoute;
  16. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  17. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  18. use Shopware\Core\Framework\Feature;
  19. use Shopware\Core\Framework\Log\Package;
  20. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  21. use Shopware\Core\Framework\Routing\Annotation\Since;
  22. use Shopware\Core\Framework\Routing\Exception\MissingRequestParameterException;
  23. use Shopware\Core\Framework\Util\HtmlSanitizer;
  24. use Shopware\Core\Framework\Validation\DataBag\RequestDataBag;
  25. use Shopware\Core\Profiling\Profiler;
  26. use Shopware\Core\System\SalesChannel\SalesChannelContext;
  27. use Symfony\Component\HttpFoundation\Request;
  28. use Symfony\Component\HttpFoundation\Response;
  29. use Symfony\Component\Routing\Annotation\Route;
  31. /**
  32.  * @Route(defaults={"_routeScope"={"storefront"}})
  33.  *
  34.  * @deprecated tag:v6.5.0 - reason:becomes-internal - Will be internal
  35.  */
  36. #[Package('storefront')]
  37. class CartLineItemController extends StorefrontController
  38. {
  39.     private CartService $cartService;
  41.     private PromotionItemBuilder $promotionItemBuilder;
  43.     private ProductLineItemFactory $productLineItemFactory;
  45.     private HtmlSanitizer $htmlSanitizer;
  47.     private AbstractProductListRoute $productListRoute;
  49.     /**
  50.      * @internal
  51.      */
  52.     public function __construct(
  53.         CartService $cartService,
  54.         PromotionItemBuilder $promotionItemBuilder,
  55.         ProductLineItemFactory $productLineItemFactory,
  56.         HtmlSanitizer $htmlSanitizer,
  57.         AbstractProductListRoute $productListRoute
  58.     ) {
  59.         $this->cartService = $cartService;
  60.         $this->promotionItemBuilder = $promotionItemBuilder;
  61.         $this->productLineItemFactory = $productLineItemFactory;
  62.         $this->htmlSanitizer = $htmlSanitizer;
  63.         $this->productListRoute = $productListRoute;
  64.     }
  66.     /**
  67.      * @Since("6.0.0.0")
  68.      * @Route("/checkout/line-item/delete/{id}", name="frontend.checkout.line-item.delete", methods={"POST", "DELETE"}, defaults={"XmlHttpRequest": true})
  69.      */
  70.     public function deleteLineItem(Cart $cart, string $id, Request $request, SalesChannelContext $context): Response
  71.     {
  72.         return Profiler::trace('cart::delete-line-item', function () use ($cart, $id, $request, $context) {
  73.             try {
  74.                 if (!$cart->has($id)) {
  75.                     if (Feature::isActive('v6.5.0.0')) {
  76.                         throw CartException::lineItemNotFound($id);
  77.                     }
  79.                     throw new LineItemNotFoundException($id);
  80.                 }
  82.                 $cart = $this->cartService->remove($cart, $id, $context);
  84.                 if (!$this->traceErrors($cart)) {
  85.                     $this->addFlash(self::SUCCESS, $this->trans('checkout.cartUpdateSuccess'));
  86.                 }
  87.             } catch (\Exception $exception) {
  88.                 $this->addFlash(self::DANGER, $this->trans('error.message-default'));
  89.             }
  91.             return $this->createActionResponse($request);
  92.         });
  93.     }
  95.     /**
  96.      * @Since("6.0.0.0")
  97.      * This is the storefront controller action for adding a promotion.
  98.      * It has some individual code for the storefront layouts, like visual
  99.      * error and success messages.
  100.      *
  101.      * @Route("/checkout/promotion/add", name="frontend.checkout.promotion.add", defaults={"XmlHttpRequest": true}, methods={"POST"})
  102.      */
  103.     public function addPromotion(Cart $cart, Request $request, SalesChannelContext $context): Response
  104.     {
  105.         return Profiler::trace('cart::add-promotion', function () use ($cart, $request, $context) {
  106.             try {
  107.                 $code = (string) $request->request->get('code');
  109.                 if ($code === '') {
  110.                     throw new \InvalidArgumentException('Code is required');
  111.                 }
  113.                 $lineItem = $this->promotionItemBuilder->buildPlaceholderItem($code);
  115.                 $cart = $this->cartService->add($cart, $lineItem, $context);
  117.                 // we basically show all cart errors or notices
  118.                 // at the moments its not possible to show success messages with "green" color
  119.                 // from the cart...thus it has to be done in the storefront level
  120.                 // so if we have an promotion added notice, we simply convert this to
  121.                 // a success flash message
  122.                 $addedEvents = $cart->getErrors()->filterInstance(PromotionCartAddedInformationError::class);
  123.                 if ($addedEvents->count() > 0) {
  124.                     $this->addFlash(self::SUCCESS, $this->trans('checkout.codeAddedSuccessful'));
  126.                     return $this->createActionResponse($request);
  127.                 }
  129.                 // if we have no custom error message above
  130.                 // then simply continue with the default display
  131.                 // of the cart errors and notices
  132.                 $this->traceErrors($cart);
  133.             } catch (\Exception $exception) {
  134.                 $this->addFlash(self::DANGER, $this->trans('error.message-default'));
  135.             }
  137.             return $this->createActionResponse($request);
  138.         });
  139.     }
  141.     /**
  142.      * @Since("6.0.0.0")
  143.      * @Route("/checkout/line-item/change-quantity/{id}", name="frontend.checkout.line-item.change-quantity", defaults={"XmlHttpRequest": true}, methods={"POST"})
  144.      */
  145.     public function changeQuantity(Cart $cart, string $id, Request $request, SalesChannelContext $context): Response
  146.     {
  147.         return Profiler::trace('cart::change-quantity', function () use ($cart, $id, $request, $context) {
  148.             try {
  149.                 $quantity = $request->get('quantity');
  151.                 if ($quantity === null) {
  152.                     throw new \InvalidArgumentException('quantity field is required');
  153.                 }
  155.                 if (!$cart->has($id)) {
  156.                     if (Feature::isActive('v6.5.0.0')) {
  157.                         throw CartException::lineItemNotFound($id);
  158.                     }
  160.                     throw new LineItemNotFoundException($id);
  161.                 }
  163.                 $cart = $this->cartService->changeQuantity($cart, $id, (int) $quantity, $context);
  165.                 if (!$this->traceErrors($cart)) {
  166.                     $this->addFlash(self::SUCCESS, $this->trans('checkout.cartUpdateSuccess'));
  167.                 }
  168.             } catch (\Exception $exception) {
  169.                 $this->addFlash(self::DANGER, $this->trans('error.message-default'));
  170.             }
  172.             return $this->createActionResponse($request);
  173.         });
  174.     }
  176.     /**
  177.      * @Since("6.0.0.0")
  178.      * @Route("/checkout/product/add-by-number", name="frontend.checkout.product.add-by-number", methods={"POST"})
  179.      */
  180.     public function addProductByNumber(Request $request, SalesChannelContext $context): Response
  181.     {
  182.         return Profiler::trace('cart::add-product-by-number', function () use ($request, $context) {
  183.             $number = (string) $request->request->get('number');
  185.             if (!$number) {
  186.                 throw new MissingRequestParameterException('number');
  187.             }
  189.             $criteria = new Criteria();
  190.             $criteria->setLimit(1);
  191.             $criteria->addFilter(new EqualsFilter('productNumber', $number));
  193.             $data = $this->productListRoute->load($criteria, $context)->getProducts()->getIds();
  195.             if (empty($data)) {
  196.                 $this->addFlash(self::DANGER, $this->trans(
  197.                     'error.productNotFound',
  198.                     ['%number%' => $this->htmlSanitizer->sanitize($number, null, true)]
  199.                 ));
  201.                 return $this->createActionResponse($request);
  202.             }
  204.             /** @var string $productId */
  205.             $productId = array_shift($data);
  207.             $product = $this->productLineItemFactory->create($productId);
  209.             $cart = $this->cartService->getCart($context->getToken(), $context);
  211.             $cart = $this->cartService->add($cart, $product, $context);
  213.             if (!$this->traceErrors($cart)) {
  214.                 $this->addFlash(self::SUCCESS, $this->trans('checkout.addToCartSuccess', ['%count%' => 1]));
  215.             }
  217.             return $this->createActionResponse($request);
  218.         });
  219.     }
  221.     /**
  222.      * @Since("6.0.0.0")
  223.      * @Route("/checkout/line-item/add", name="frontend.checkout.line-item.add", methods={"POST"}, defaults={"XmlHttpRequest"=true})
  224.      *
  225.      * requires the provided items in the following form
  226.      * 'lineItems' => [
  227.      *     'anyKey' => [
  228.      *         'id' => 'someKey'
  229.      *         'quantity' => 2,
  230.      *         'type' => 'someType'
  231.      *     ],
  232.      *     'randomKey' => [
  233.      *         'id' => 'otherKey'
  234.      *         'quantity' => 2,
  235.      *         'type' => 'otherType'
  236.      *     ]
  237.      * ]
  238.      */
  239.     public function addLineItems(Cart $cart, RequestDataBag $requestDataBag, Request $request, SalesChannelContext $context): Response
  240.     {
  241.         return Profiler::trace('cart::add-line-item', function () use ($cart, $requestDataBag, $request, $context) {
  242.             /** @var RequestDataBag|null $lineItems */
  243.             $lineItems = $requestDataBag->get('lineItems');
  244.             if (!$lineItems) {
  245.                 throw new MissingRequestParameterException('lineItems');
  246.             }
  248.             $count = 0;
  250.             try {
  251.                 $items = [];
  252.                 /** @var RequestDataBag $lineItemData */
  253.                 foreach ($lineItems as $lineItemData) {
  254.                     $lineItem = new LineItem(
  255.                         $lineItemData->getAlnum('id'),
  256.                         $lineItemData->getAlnum('type'),
  257.                         $lineItemData->get('referencedId'),
  258.                         $lineItemData->getInt('quantity', 1)
  259.                     );
  261.                     $lineItem->setStackable($lineItemData->getBoolean('stackable', true));
  262.                     $lineItem->setRemovable($lineItemData->getBoolean('removable', true));
  264.                     $count += $lineItem->getQuantity();
  266.                     $items[] = $lineItem;
  267.                 }
  269.                 $cart = $this->cartService->add($cart, $items, $context);
  271.                 if (!$this->traceErrors($cart)) {
  272.                     $this->addFlash(self::SUCCESS, $this->trans('checkout.addToCartSuccess', ['%count%' => $count]));
  273.                 }
  274.             } catch (ProductNotFoundException $exception) {
  275.                 $this->addFlash(self::DANGER, $this->trans('error.addToCartError'));
  276.             }
  278.             return $this->createActionResponse($request);
  279.         });
  280.     }
  282.     private function traceErrors(Cart $cart): bool
  283.     {
  284.         if ($cart->getErrors()->count() <= 0) {
  285.             return false;
  286.         }
  288.         $this->addCartErrors($cart, function (Error $error) {
  289.             return $error->isPersistent();
  290.         });
  292.         return true;
  293.     }
  294. }