PlaceOrder Class Reference

Inheritance diagram for PlaceOrder:

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, \Magento\Checkout\Api\AgreementsValidatorInterface $agreementValidator, \Magento\Sales\Api\PaymentFailuresInterface $paymentFailures=null)
	execute ()
Public Member Functions inherited from AbstractExpress
	__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 RedirectLoginInterface
	getResponse ()

Protected Member Functions
	_processPaypalApiError ($exception)
	_redirectSameToken ()
	_redirectToCartAndShowError ($errorMessage)
	isValidationRequired ()
Protected Member Functions inherited from AbstractExpress
	_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
	$agreementsValidator
Protected Attributes inherited from AbstractExpress
	$_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

Class PlaceOrder @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 17 of file PlaceOrder.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,
		\Magento\Checkout\Api\AgreementsValidatorInterface	$agreementValidator,
		\Magento\Sales\Api\PaymentFailuresInterface	$paymentFailures = null
	)

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
\Magento\Checkout\Api\AgreementsValidatorInterface	$agreementValidator
\Magento\Sales\Api\PaymentFailuresInterface | null	$paymentFailures	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 42 of file PlaceOrder.php.

      {
        parent::__construct(
            $context,
            $customerSession,
            $checkoutSession,
            $orderFactory,
            $checkoutFactory,
            $paypalSession,
            $urlHelper,
            $customerUrl
        );

        $this->agreementsValidator = $agreementValidator;
        $this->paymentFailures = $paymentFailures ? : $this->_objectManager->get(
            \Magento\Sales\Api\PaymentFailuresInterface::class
        );
    }

Member Function Documentation

_processPaypalApiError()

_processPaypalApiError (   $exception )

protected

Process PayPal API's processable errors

Parameters

\Magento\Paypal\Model\Api\ProcessableException

$exception

Returns

void

Definition at line 161 of file PlaceOrder.php.

    {
        $this->paymentFailures->handle((int)$this->_getCheckoutSession()->getQuoteId(), $exception->getMessage());

        switch ($exception->getCode()) {
            case ApiProcessableException::API_MAX_PAYMENT_ATTEMPTS_EXCEEDED:
            case ApiProcessableException::API_TRANSACTION_EXPIRED:
                $this->getResponse()->setRedirect(
                    $this->_getQuote()->getPayment()->getCheckoutRedirectUrl()
                );
                break;
            case ApiProcessableException::API_DO_EXPRESS_CHECKOUT_FAIL:
                $this->_redirectSameToken();
                break;
            case ApiProcessableException::API_ADDRESS_MATCH_FAIL:
                $this->redirectToOrderReviewPageAndShowError($exception->getUserMessage());
                break;
            case ApiProcessableException::API_UNABLE_TRANSACTION_COMPLETE:
                if ($this->_config->getPaymentAction() == \Magento\Payment\Model\Method\AbstractMethod::ACTION_ORDER) {
                    $paypalTransactionData = $this->_getCheckoutSession()->getPaypalTransactionData();
                    $this->getResponse()->setRedirect(
                        $this->_config->getExpressCheckoutOrderUrl($paypalTransactionData['transaction_id'])
                    );
                } else {
                    $this->_redirectSameToken();
                }
                break;
            default:
                $this->_redirectToCartAndShowError($exception->getUserMessage());
                break;
        }
    }

_redirectSameToken()

_redirectSameToken ( )

protected

Redirect customer back to PayPal with the same token

Returns

void

Definition at line 199 of file PlaceOrder.php.

    {
        $token = $this->_initToken();
        $this->getResponse()->setRedirect(
            $this->_config->getExpressCheckoutStartUrl($token)
        );
    }

_redirectToCartAndShowError()

_redirectToCartAndShowError (   $errorMessage )

protected

Redirect customer to shopping cart and show error message

Parameters

string

$errorMessage

Returns

void

Definition at line 213 of file PlaceOrder.php.

    {
        $this->messageManager->addErrorMessage($errorMessage);
        $this->_redirect('checkout/cart');
    }

execute()

execute

(

)

Submit the order

Returns

void

Exceptions

Implements ActionInterface.

Definition at line 77 of file PlaceOrder.php.

    {
        if ($this->isValidationRequired() &&
            !$this->agreementsValidator->isValid(array_keys($this->getRequest()->getPost('agreement', [])))
        ) {
            $e = new \Magento\Framework\Exception\LocalizedException(
                __(
                    "The order wasn't placed. "
                    . "First, agree to the terms and conditions, then try placing your order again."
                )
            );
            $this->messageManager->addExceptionMessage(
                $e,
                $e->getMessage()
            );
            $this->_redirect('*/*/review');
            return;
        }

        try {
            $this->_initCheckout();
            $this->_checkout->place($this->_initToken());

            // prepare session to success or cancellation page
            $this->_getCheckoutSession()->clearHelperData();

            // "last successful quote"
            $quoteId = $this->_getQuote()->getId();
            $this->_getCheckoutSession()->setLastQuoteId($quoteId)->setLastSuccessQuoteId($quoteId);

            // an order may be created
            $order = $this->_checkout->getOrder();
            if ($order) {
                $this->_getCheckoutSession()->setLastOrderId($order->getId())
                    ->setLastRealOrderId($order->getIncrementId())
                    ->setLastOrderStatus($order->getStatus());
            }

            $this->_eventManager->dispatch(
                'paypal_express_place_order_success',
                [
                    'order' => $order,
                    'quote' => $this->_getQuote()
                ]
            );

            // redirect if PayPal specified some URL (for example, to Giropay bank)
            $url = $this->_checkout->getRedirectUrl();
            if ($url) {
                $this->getResponse()->setRedirect($url);
                return;
            }
            $this->_initToken(false); // no need in token anymore
            $this->_redirect('checkout/onepage/success');
            return;
        } catch (ApiProcessableException $e) {
            $this->_processPaypalApiError($e);
        } catch (LocalizedException $e) {
            $this->processException($e, $e->getRawMessage());
        } catch (\Exception $e) {
            $this->processException($e, 'We can\'t place the order.');
        }
    }

isValidationRequired()

isValidationRequired ( )

protected

Return true if agreements validation required

Returns

bool

Definition at line 236 of file PlaceOrder.php.

    {
        return is_array($this->getRequest()->getBeforeForwardInfo())
            && empty($this->getRequest()->getBeforeForwardInfo());
    }

Field Documentation

$agreementsValidator

$agreementsValidator

protected

Definition at line 22 of file PlaceOrder.php.

---

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

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