Checkout Class Reference

Inheritance diagram for Checkout:

Public Member Functions
	__construct (\Magento\Framework\App\Action\Context $context, \Magento\Customer\Model\Session $customerSession, CustomerRepositoryInterface $customerRepository, AccountManagementInterface $accountManagement)
	dispatch (RequestInterface $request)
	getCustomerBeforeAuthUrl ()
	getActionFlagList ()
	getLoginUrl ()
	getRedirectActionName ()
Public Member Functions inherited from Action
	__construct (\Magento\Framework\App\Action\Context $context, \Magento\Customer\Model\Session $customerSession, CustomerRepositoryInterface $customerRepository, AccountManagementInterface $accountManagement)
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 ()
Public Member Functions inherited from ActionInterface
	execute ()
Public Member Functions inherited from RedirectLoginInterface
	getResponse ()

Protected Member Functions
	_getCheckout ()
	_getState ()
	_getHelper ()
	_getCheckoutSession ()
	_validateMinimumAmount ()
Protected Member Functions inherited from Action
	_preDispatchValidateCustomer ($redirect=true, $addErrors=true)
Protected Member Functions inherited from Action
	_forward ($action, $controller=null, $module=null, array $params=null)
	_redirect ($path, $arguments=[])

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 Attributes inherited from Action
	$_customerSession
	$customerRepository
	$accountManagement
Protected Attributes inherited from Action
	$_objectManager
	$_sessionNamespace
	$_eventManager
	$_actionFlag
	$_redirect
	$_view
	$_url
	$messageManager
Protected Attributes inherited from AbstractAction
	$_request
	$_response
	$resultRedirectFactory
	$resultFactory

Detailed Description

Multishipping checkout controller @SuppressWarnings(PHPMD.NumberOfChildren) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 18 of file Checkout.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Action\Context	$context,
		\Magento\Customer\Model\Session	$customerSession,
		CustomerRepositoryInterface	$customerRepository,
		AccountManagementInterface	$accountManagement
	)

Constructor

Parameters

\Magento\Framework\App\Action\Context	$context
\Magento\Customer\Model\Session	$customerSession
CustomerRepositoryInterface	$customerRepository
AccountManagementInterface	$accountManagement

Definition at line 29 of file Checkout.php.

      {
        parent::__construct(
            $context,
            $customerSession,
            $customerRepository,
            $accountManagement
        );
    }

Member Function Documentation

_getCheckout()

_getCheckout ( )

protected

Retrieve checkout model

Returns

\Magento\Multishipping\Model\Checkout\Type\Multishipping

Definition at line 48 of file Checkout.php.

    {
        return $this->_objectManager->get(\Magento\Multishipping\Model\Checkout\Type\Multishipping::class);
    }

_getCheckoutSession()

_getCheckoutSession ( )

protected

Retrieve checkout session

Returns

\Magento\Checkout\Model\Session

Definition at line 78 of file Checkout.php.

    {
        return $this->_objectManager->get(\Magento\Checkout\Model\Session::class);
    }

_getHelper()

_getHelper ( )

protected

Retrieve checkout url helper

Returns

\Magento\Multishipping\Helper\Url

Definition at line 68 of file Checkout.php.

    {
        return $this->_objectManager->get(\Magento\Multishipping\Helper\Url::class);
    }

_getState()

_getState ( )

protected

Retrieve checkout state model

Returns

\Magento\Multishipping\Model\Checkout\Type\Multishipping\State

Definition at line 58 of file Checkout.php.

    {
        return $this->_objectManager->get(\Magento\Multishipping\Model\Checkout\Type\Multishipping\State::class);
    }

_validateMinimumAmount()

_validateMinimumAmount ( )

protected

Validate minimum amount

Returns

bool

Definition at line 179 of file Checkout.php.

    {
        if (!$this->_getCheckout()->validateMinimumAmount()) {
            $error = $this->_getCheckout()->getMinimumAmountError();
            $this->messageManager->addError($error);
            $this->_forward('backToAddresses');
            return false;
        }
        return true;
    }

dispatch()

dispatch

(

RequestInterface

$request

)

Dispatch request

Parameters

RequestInterface

$request

Returns

\Magento\Framework\App\ResponseInterface

Exceptions

Catch index action call to set some flags before checkout/type_multishipping model initialization

Definition at line 92 of file Checkout.php.

    {
        $this->_request = $request;
        if ($this->_actionFlag->get('', 'redirectLogin')) {
            return parent::dispatch($request);
        }

        $action = $request->getActionName();

        $checkoutSessionQuote = $this->_getCheckoutSession()->getQuote();
        if ($action == 'index') {
            $checkoutSessionQuote->setIsMultiShipping(true);
            $this->_getCheckoutSession()->setCheckoutState(\Magento\Checkout\Model\Session::CHECKOUT_STATE_BEGIN);
        } elseif (!$checkoutSessionQuote->getIsMultiShipping() && !in_array(
            $action,
            ['login', 'register', 'success']
        )
        ) {
            $this->_redirect('*/*/index');
            $this->_actionFlag->set('', self::FLAG_NO_DISPATCH, true);
            return parent::dispatch($request);
        }

        if (!in_array($action, ['login', 'register'])) {
            $customerSession = $this->_objectManager->get(\Magento\Customer\Model\Session::class);
            if (!$customerSession->authenticate($this->_getHelper()->getMSLoginUrl())) {
                $this->_actionFlag->set('', self::FLAG_NO_DISPATCH, true);
            }

            if (!$this->_objectManager->get(
                \Magento\Multishipping\Helper\Data::class
            )->isMultishippingCheckoutAvailable()) {
                $error = $this->_getCheckout()->getMinimumAmountError();
                $this->messageManager->addError($error);
                $this->getResponse()->setRedirect($this->_getHelper()->getCartUrl());
                $this->_actionFlag->set('', self::FLAG_NO_DISPATCH, true);
                return parent::dispatch($request);
            }
        }

        $result = $this->_preDispatchValidateCustomer();
        if ($result instanceof \Magento\Framework\Controller\ResultInterface) {
            return $result;
        }

        if (!$result) {
            return $this->getResponse();
        }

        if ($this->_getCheckoutSession()->getCartWasUpdated(true)
            &&
            !in_array($action, ['index', 'login', 'register', 'addresses', 'success'])
        ) {
            $this->getResponse()->setRedirect($this->_getHelper()->getCartUrl());
            $this->_actionFlag->set('', self::FLAG_NO_DISPATCH, true);
            return parent::dispatch($request);
        }

        if ($action == 'success' && $this->_getCheckout()->getCheckoutSession()->getDisplaySuccess(true)) {
            return parent::dispatch($request);
        }

        try {
            $checkout = $this->_getCheckout();
        } catch (StateException $e) {
            $this->getResponse()->setRedirect($this->_getHelper()->getMSNewShippingUrl());
            $this->_actionFlag->set('', self::FLAG_NO_DISPATCH, true);
            return parent::dispatch($request);
        }

        $quote = $checkout->getQuote();
        if (!$quote->hasItems() || $quote->getHasError() || $quote->isVirtual()) {
            $this->getResponse()->setRedirect($this->_getHelper()->getCartUrl());
            $this->_actionFlag->set('', self::FLAG_NO_DISPATCH, true);
        }

        return parent::dispatch($request);
    }

getActionFlagList()

getActionFlagList

(

)

Returns a list of action flags [flag_key] => boolean

Returns

array

Implements RedirectLoginInterface.

Definition at line 207 of file Checkout.php.

    {
        return ['redirectLogin' => true];
    }

getCustomerBeforeAuthUrl()

getCustomerBeforeAuthUrl

(

)

Returns before_auth_url redirect parameter for customer session

Returns

string

Implements RedirectLoginInterface.

Definition at line 195 of file Checkout.php.

    {
        return $this->_objectManager->create(
            \Magento\Framework\UrlInterface::class
        )->getUrl('*/*', ['_secure' => true]);
    }

getLoginUrl()

getLoginUrl

(

)

Returns login url parameter for redirect

Returns

string

Implements RedirectLoginInterface.

Definition at line 217 of file Checkout.php.

    {
        return $this->_getHelper()->getMSLoginUrl();
    }

getRedirectActionName()

getRedirectActionName

(

)

Returns action name which requires redirect

Returns

string

Implements RedirectLoginInterface.

Definition at line 227 of file Checkout.php.

    {
        return 'index';
    }

---

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

• vendor/magento/module-multishipping/Controller/Checkout.php