CouponPost Class Reference

Inheritance diagram for CouponPost:

Public Member Functions
	__construct (\Magento\Framework\App\Action\Context $context, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Checkout\Model\Session $checkoutSession, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Data\Form\FormKey\Validator $formKeyValidator, \Magento\Checkout\Model\Cart $cart, \Magento\SalesRule\Model\CouponFactory $couponFactory, \Magento\Quote\Api\CartRepositoryInterface $quoteRepository)
	execute ()
Public Member Functions inherited from Cart
	__construct (\Magento\Framework\App\Action\Context $context, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Checkout\Model\Session $checkoutSession, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\Data\Form\FormKey\Validator $formKeyValidator, CustomerCart $cart)
Public Member Functions inherited from Action
	__construct (Context $context)
	dispatch (RequestInterface $request)
	getActionFlag ()
Public Member Functions inherited from AbstractAction
	__construct (Context $context)
	dispatch (RequestInterface $request)
	getRequest ()
	getResponse ()

Protected Attributes
	$quoteRepository
	$couponFactory
Protected Attributes inherited from Cart
	$_scopeConfig
	$_checkoutSession
	$_storeManager
	$_formKeyValidator
	$cart
Protected Attributes inherited from Action
	$_objectManager
	$_sessionNamespace
	$_eventManager
	$_actionFlag
	$_redirect
	$_view
	$_url
	$messageManager
Protected Attributes inherited from AbstractAction
	$_request
	$_response
	$resultRedirectFactory
	$resultFactory

Additional Inherited Members
Data Fields inherited from ActionInterface
const	FLAG_NO_DISPATCH = 'no-dispatch'
const	FLAG_NO_POST_DISPATCH = 'no-postDispatch'
const	FLAG_NO_DISPATCH_BLOCK_EVENT = 'no-beforeGenerateLayoutBlocksDispatch'
const	PARAM_NAME_BASE64_URL = 'r64'
const	PARAM_NAME_URL_ENCODED = 'uenc'
Protected Member Functions inherited from Cart
	_goBack ($backUrl=null)
	getBackUrl ($defaultUrl=null)
Protected Member Functions inherited from Action
	_forward ($action, $controller=null, $module=null, array $params=null)
	_redirect ($path, $arguments=[])

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 13 of file CouponPost.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Action\Context	$context,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Checkout\Model\Session	$checkoutSession,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\Data\Form\FormKey\Validator	$formKeyValidator,
		\Magento\Checkout\Model\Cart	$cart,
		\Magento\SalesRule\Model\CouponFactory	$couponFactory,
		\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository
	)

Parameters

\Magento\Framework\App\Action\Context	$context
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Checkout\Model\Session	$checkoutSession
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\Data\Form\FormKey\Validator	$formKeyValidator
\Magento\Checkout\Model\Cart	$cart
\Magento\SalesRule\Model\CouponFactory	$couponFactory
\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository	@codeCoverageIgnore

Definition at line 40 of file CouponPost.php.

      {
        parent::__construct(
            $context,
            $scopeConfig,
            $checkoutSession,
            $storeManager,
            $formKeyValidator,
            $cart
        );
        $this->couponFactory = $couponFactory;
        $this->quoteRepository = $quoteRepository;
    }

Member Function Documentation

execute()

execute

(

)

Initialize coupon

Returns

\Magento\Framework\Controller\Result\Redirect @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Implements ActionInterface.

Definition at line 69 of file CouponPost.php.

    {
        $couponCode = $this->getRequest()->getParam('remove') == 1
            ? ''
            : trim($this->getRequest()->getParam('coupon_code'));

        $cartQuote = $this->cart->getQuote();
        $oldCouponCode = $cartQuote->getCouponCode();

        $codeLength = strlen($couponCode);
        if (!$codeLength && !strlen($oldCouponCode)) {
            return $this->_goBack();
        }

        try {
            $isCodeLengthValid = $codeLength && $codeLength <= \Magento\Checkout\Helper\Cart::COUPON_CODE_MAX_LENGTH;

            $itemsCount = $cartQuote->getItemsCount();
            if ($itemsCount) {
                $cartQuote->getShippingAddress()->setCollectShippingRates(true);
                $cartQuote->setCouponCode($isCodeLengthValid ? $couponCode : '')->collectTotals();
                $this->quoteRepository->save($cartQuote);
            }

            if ($codeLength) {
                $escaper = $this->_objectManager->get(\Magento\Framework\Escaper::class);
                $coupon = $this->couponFactory->create();
                $coupon->load($couponCode, 'code');
                if (!$itemsCount) {
                    if ($isCodeLengthValid && $coupon->getId()) {
                        $this->_checkoutSession->getQuote()->setCouponCode($couponCode)->save();
                        $this->messageManager->addSuccessMessage(
                            __(
                                'You used coupon code "%1".',
                                $escaper->escapeHtml($couponCode)
                            )
                        );
                    } else {
                        $this->messageManager->addErrorMessage(
                            __(
                                'The coupon code "%1" is not valid.',
                                $escaper->escapeHtml($couponCode)
                            )
                        );
                    }
                } else {
                    if ($isCodeLengthValid && $coupon->getId() && $couponCode == $cartQuote->getCouponCode()) {
                        $this->messageManager->addSuccessMessage(
                            __(
                                'You used coupon code "%1".',
                                $escaper->escapeHtml($couponCode)
                            )
                        );
                    } else {
                        $this->messageManager->addErrorMessage(
                            __(
                                'The coupon code "%1" is not valid.',
                                $escaper->escapeHtml($couponCode)
                            )
                        );
                    }
                }
            } else {
                $this->messageManager->addSuccessMessage(__('You canceled the coupon code.'));
            }
        } catch (\Magento\Framework\Exception\LocalizedException $e) {
            $this->messageManager->addErrorMessage($e->getMessage());
        } catch (\Exception $e) {
            $this->messageManager->addErrorMessage(__('We cannot apply the coupon code.'));
            $this->_objectManager->get(\Psr\Log\LoggerInterface::class)->critical($e);
        }

        return $this->_goBack();
    }

Field Documentation

$couponFactory

$couponFactory

protected

Definition at line 27 of file CouponPost.php.

$quoteRepository

$quoteRepository

protected

Definition at line 20 of file CouponPost.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-checkout/Controller/Cart/CouponPost.php