AbstractExpress Class Reference

Inheritance diagram for AbstractExpress:

Public Member Functions
	__construct (\Magento\Framework\App\Action\Context $context, \Magento\Customer\Model\Session $customerSession, \Magento\Checkout\Model\Session $checkoutSession, \Magento\Sales\Model\OrderFactory $orderFactory, \Magento\Paypal\Model\Express\Checkout\Factory $checkoutFactory, \Magento\Framework\Session\Generic $paypalSession, \Magento\Framework\Url\Helper\Data $urlHelper, \Magento\Customer\Model\Url $customerUrl)
	getCustomerBeforeAuthUrl ()
	getActionFlagList ()
	getLoginUrl ()
	getRedirectActionName ()
	redirectLogin ()
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
	_initCheckout ()
	_initToken ($setToken=null)
	_getSession ()
	_getCheckoutSession ()
	_getQuote ()
Protected Member Functions inherited from Action
	_forward ($action, $controller=null, $module=null, array $params=null)
	_redirect ($path, $arguments=[])

Protected Attributes
	$_checkout
	$_checkoutTypes = []
	$_config
	$_quote = false
	$_configType
	$_configMethod
	$_checkoutType
	$_customerSession
	$_checkoutSession
	$_orderFactory
	$_checkoutFactory
	$_paypalSession
	$_urlHelper
	$_customerUrl
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'

Detailed Description

Abstract Express Checkout Controller @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 15 of file AbstractExpress.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\App\Action\Context	$context,
		\Magento\Customer\Model\Session	$customerSession,
		\Magento\Checkout\Model\Session	$checkoutSession,
		\Magento\Sales\Model\OrderFactory	$orderFactory,
		\Magento\Paypal\Model\Express\Checkout\Factory	$checkoutFactory,
		\Magento\Framework\Session\Generic	$paypalSession,
		\Magento\Framework\Url\Helper\Data	$urlHelper,
		\Magento\Customer\Model\Url	$customerUrl
	)

Parameters

\Magento\Framework\App\Action\Context	$context
\Magento\Customer\Model\Session	$customerSession
\Magento\Checkout\Model\Session	$checkoutSession
\Magento\Sales\Model\OrderFactory	$orderFactory
\Magento\Paypal\Model\Express\Checkout\Factory	$checkoutFactory
\Magento\Framework\Session\Generic	$paypalSession
\Magento\Framework\Url\Helper\Data	$urlHelper
\Magento\Customer\Model\Url	$customerUrl

Definition at line 105 of file AbstractExpress.php.

      {
        $this->_customerSession = $customerSession;
        $this->_checkoutSession = $checkoutSession;
        $this->_orderFactory = $orderFactory;
        $this->_checkoutFactory = $checkoutFactory;
        $this->_paypalSession = $paypalSession;
        $this->_urlHelper = $urlHelper;
        $this->_customerUrl = $customerUrl;
        parent::__construct($context);
        $parameters = ['params' => [$this->_configMethod]];
        $this->_config = $this->_objectManager->create($this->_configType, $parameters);
    }

Member Function Documentation

_getCheckoutSession()

_getCheckoutSession ( )

protected

Return checkout session object

Returns

\Magento\Checkout\Model\Session

Definition at line 205 of file AbstractExpress.php.

    {
        return $this->_checkoutSession;
    }

_getQuote()

_getQuote ( )

protected

Return checkout quote object

Returns

\Magento\Quote\Model\Quote

Definition at line 215 of file AbstractExpress.php.

    {
        if (!$this->_quote) {
            $this->_quote = $this->_getCheckoutSession()->getQuote();
        }
        return $this->_quote;
    }

_getSession()

_getSession ( )

protected

PayPal session instance getter

Returns

\Magento\Framework\Session\Generic

Definition at line 195 of file AbstractExpress.php.

    {
        return $this->_paypalSession;
    }

_initCheckout()

_initCheckout ( )

protected

Instantiate quote and checkout

Returns

void

Exceptions

Definition at line 133 of file AbstractExpress.php.

    {
        $quote = $this->_getQuote();
        if (!$quote->hasItems() || $quote->getHasError()) {
            $this->getResponse()->setStatusHeader(403, '1.1', 'Forbidden');
            throw new \Magento\Framework\Exception\LocalizedException(__('We can\'t initialize Express Checkout.'));
        }
        if (!isset($this->_checkoutTypes[$this->_checkoutType])) {
            $parameters = [
                'params' => [
                    'quote' => $quote,
                    'config' => $this->_config,
                ],
            ];
            $this->_checkoutTypes[$this->_checkoutType] = $this->_checkoutFactory
                ->create($this->_checkoutType, $parameters);
        }
        $this->_checkout = $this->_checkoutTypes[$this->_checkoutType];
    }

_initToken()

_initToken (   $setToken = null )

protected

Search for proper checkout token in request or session or (un)set specified one Combined getter/setter

Parameters

string | null

$setToken

Returns

$this|string

Exceptions

Definition at line 161 of file AbstractExpress.php.

    {
        if (null !== $setToken) {
            if (false === $setToken) {
                // security measure for avoid unsetting token twice
                if (!$this->_getSession()->getExpressCheckoutToken()) {
                    throw new \Magento\Framework\Exception\LocalizedException(
                        __('PayPal Express Checkout Token does not exist.')
                    );
                }
                $this->_getSession()->unsExpressCheckoutToken();
            } else {
                $this->_getSession()->setExpressCheckoutToken($setToken);
            }
            return $this;
        }
        $setToken = $this->getRequest()->getParam('token');
        if ($setToken) {
            if ($setToken !== $this->_getSession()->getExpressCheckoutToken()) {
                throw new \Magento\Framework\Exception\LocalizedException(
                    __('A wrong PayPal Express Checkout Token is specified.')
                );
            }
        } else {
            $setToken = $this->_getSession()->getExpressCheckoutToken();
        }
        return $setToken;
    }

getActionFlagList()

getActionFlagList

(

)

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

Returns

array

Implements RedirectLoginInterface.

Definition at line 236 of file AbstractExpress.php.

    {
        return [];
    }

getCustomerBeforeAuthUrl()

getCustomerBeforeAuthUrl

(

)

Returns before_auth_url redirect parameter for customer session

Returns

null

Implements RedirectLoginInterface.

Definition at line 227 of file AbstractExpress.php.

    {
        return;
    }

getLoginUrl()

getLoginUrl

(

)

Returns login url parameter for redirect

Returns

string

Implements RedirectLoginInterface.

Definition at line 245 of file AbstractExpress.php.

    {
        return $this->_customerUrl->getLoginUrl();
    }

getRedirectActionName()

getRedirectActionName

(

)

Returns action name which requires redirect

Returns

string

Implements RedirectLoginInterface.

Definition at line 254 of file AbstractExpress.php.

    {
        return 'start';
    }

redirectLogin()

redirectLogin

(

)

Redirect to login page

Returns

void

Definition at line 264 of file AbstractExpress.php.

    {
        $this->_actionFlag->set('', 'no-dispatch', true);
        $this->_customerSession->setBeforeAuthUrl($this->_redirect->getRefererUrl());
        $this->getResponse()->setRedirect(
            $this->_urlHelper->addRequestParam($this->_customerUrl->getLoginUrl(), ['context' => 'checkout'])
        );
    }

Field Documentation

$_checkout

$_checkout

protected

Definition at line 20 of file AbstractExpress.php.

$_checkoutFactory

$_checkoutFactory

protected

Definition at line 78 of file AbstractExpress.php.

$_checkoutSession

$_checkoutSession

protected

Definition at line 68 of file AbstractExpress.php.

$_checkoutType

$_checkoutType

protected

Definition at line 58 of file AbstractExpress.php.

$_checkoutTypes

$_checkoutTypes = []

protected

Definition at line 27 of file AbstractExpress.php.

$_config

$_config

protected

Definition at line 32 of file AbstractExpress.php.

$_configMethod

$_configMethod

protected

Definition at line 51 of file AbstractExpress.php.

$_configType

$_configType

protected

Definition at line 44 of file AbstractExpress.php.

$_customerSession

$_customerSession

protected

Definition at line 63 of file AbstractExpress.php.

$_customerUrl

$_customerUrl

protected

Definition at line 93 of file AbstractExpress.php.

$_orderFactory

$_orderFactory

protected

Definition at line 73 of file AbstractExpress.php.

$_paypalSession

$_paypalSession

protected

Definition at line 83 of file AbstractExpress.php.

$_quote

$_quote = false

protected

Definition at line 37 of file AbstractExpress.php.

$_urlHelper

$_urlHelper

protected

Definition at line 88 of file AbstractExpress.php.

---

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

• vendor/magento/module-paypal/Controller/Express/AbstractExpress.php