Checkout Class Reference

Inheritance diagram for Checkout:

Public Member Functions
	__construct (\Psr\Log\LoggerInterface $logger, \Magento\Customer\Model\Url $customerUrl, \Magento\Tax\Helper\Data $taxData, \Magento\Checkout\Helper\Data $checkoutData, \Magento\Customer\Model\Session $customerSession, \Magento\Framework\App\Cache\Type\Config $configCacheType, \Magento\Framework\Locale\ResolverInterface $localeResolver, \Magento\Paypal\Model\Info $paypalInfo, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\UrlInterface $coreUrl, \Magento\Paypal\Model\CartFactory $cartFactory, \Magento\Checkout\Model\Type\OnepageFactory $onepageFactory, \Magento\Quote\Api\CartManagementInterface $quoteManagement, \Magento\Paypal\Model\Billing\AgreementFactory $agreementFactory, \Magento\Paypal\Model\Api\Type\Factory $apiTypeFactory, \Magento\Framework\DataObject\Copy $objectCopyService, \Magento\Checkout\Model\Session $checkoutSession, \Magento\Framework\Encryption\EncryptorInterface $encryptor, \Magento\Framework\Message\ManagerInterface $messageManager, \Magento\Customer\Api\CustomerRepositoryInterface $customerRepository, AccountManagement $accountManagement, OrderSender $orderSender, \Magento\Quote\Api\CartRepositoryInterface $quoteRepository, \Magento\Quote\Model\Quote\TotalsCollector $totalsCollector, $params=[])
	getCheckoutShortcutImageUrl ()
	prepareGiropayUrls ($successUrl, $cancelUrl, $pendingUrl)
	setIsBillingAgreementRequested ($flag)
	setIsBml ($isBml)
	setCustomerData (CustomerDataObject $customerData)
	setCustomerWithAddressChange (CustomerDataObject $customerData, $billingAddress=null, $shippingAddress=null)
	canSkipOrderReviewStep ()
	returnFromPaypal ($token)
	prepareOrderReview ($token=null)
	getShippingOptionsCallbackResponse (array $request)
	updateShippingMethod ($methodCode)
	place ($token, $shippingMethodCode=null)
	getRedirectUrl ()
	getBillingAgreement ()
	getOrder ()
	getCheckoutMethod ()
	getCustomerSession ()

Data Fields
const	PAL_CACHE_ID = 'paypal_express_checkout_pal'
const	PAYMENT_INFO_TRANSPORT_TOKEN = 'paypal_express_checkout_token'
const	PAYMENT_INFO_TRANSPORT_SHIPPING_OVERRIDDEN = 'paypal_express_checkout_shipping_overridden'
const	PAYMENT_INFO_TRANSPORT_SHIPPING_METHOD = 'paypal_express_checkout_shipping_method'
const	PAYMENT_INFO_TRANSPORT_PAYER_ID = 'paypal_express_checkout_payer_id'
const	PAYMENT_INFO_TRANSPORT_REDIRECT = 'paypal_express_checkout_redirect_required'
const	PAYMENT_INFO_TRANSPORT_BILLING_AGREEMENT = 'paypal_ec_create_ba'
const	PAYMENT_INFO_BUTTON = 'button'

Protected Member Functions
	_setExportedAddressData ($address, $exportedAddress)
	_setBillingAgreementRequest ()
	_getApi ()
	_prepareShippingOptions (Address $address, $mayReturnEmpty=false, $calculateTax=false)
	_matchShippingMethodCode (Address $address, $selectedCode)
	_setRedirectUrl ($button, $token)
	prepareGuestQuote ()

Static Protected Member Functions
static	cmpShippingOptions (DataObject $option1, DataObject $option2)

Protected Attributes
	$_quote
	$_config
	$_api
	$_apiType = \Magento\Paypal\Model\Api\Nvp::class
	$_methodType = PaypalConfig::METHOD_WPP_EXPRESS
	$_redirectUrl = ''
	$_pendingPaymentMessage = ''
	$_checkoutRedirectUrl = ''
	$_customerSession
	$_giropayUrls = []
	$_isBARequested = false
	$_isBml = false
	$_customerId
	$_billingAgreement
	$_order
	$_configCacheType
	$_checkoutData
	$_taxData
	$_customerUrl
	$_logger
	$_localeResolver
	$_paypalInfo
	$_storeManager
	$_coreUrl
	$_cartFactory
	$_checkoutOnepageFactory
	$_agreementFactory
	$_apiTypeFactory
	$_objectCopyService
	$_checkoutSession
	$_customerRepository
	$_accountManagement
	$_encryptor
	$_messageManager
	$orderSender
	$quoteRepository
	$quoteManagement
	$totalsCollector

Detailed Description

Wrapper that performs Paypal Express and Checkout communication

@SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 25 of file Checkout.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Psr\Log\LoggerInterface	$logger,
		\Magento\Customer\Model\Url	$customerUrl,
		\Magento\Tax\Helper\Data	$taxData,
		\Magento\Checkout\Helper\Data	$checkoutData,
		\Magento\Customer\Model\Session	$customerSession,
		\Magento\Framework\App\Cache\Type\Config	$configCacheType,
		\Magento\Framework\Locale\ResolverInterface	$localeResolver,
		\Magento\Paypal\Model\Info	$paypalInfo,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\UrlInterface	$coreUrl,
		\Magento\Paypal\Model\CartFactory	$cartFactory,
		\Magento\Checkout\Model\Type\OnepageFactory	$onepageFactory,
		\Magento\Quote\Api\CartManagementInterface	$quoteManagement,
		\Magento\Paypal\Model\Billing\AgreementFactory	$agreementFactory,
		\Magento\Paypal\Model\Api\Type\Factory	$apiTypeFactory,
		\Magento\Framework\DataObject\Copy	$objectCopyService,
		\Magento\Checkout\Model\Session	$checkoutSession,
		\Magento\Framework\Encryption\EncryptorInterface	$encryptor,
		\Magento\Framework\Message\ManagerInterface	$messageManager,
		\Magento\Customer\Api\CustomerRepositoryInterface	$customerRepository,
		AccountManagement	$accountManagement,
		OrderSender	$orderSender,
		\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository,
		\Magento\Quote\Model\Quote\TotalsCollector	$totalsCollector,
			$params = []
	)

Parameters

\Psr\Log\LoggerInterface	$logger
\Magento\Customer\Model\Url	$customerUrl
\Magento\Tax\Helper\Data	$taxData
\Magento\Checkout\Helper\Data	$checkoutData
\Magento\Customer\Model\Session	$customerSession
\Magento\Framework\App\Cache\Type\Config	$configCacheType
\Magento\Framework\Locale\ResolverInterface	$localeResolver
\Magento\Paypal\Model\Info	$paypalInfo
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\UrlInterface	$coreUrl
\Magento\Paypal\Model\CartFactory	$cartFactory
\Magento\Checkout\Model\Type\OnepageFactory	$onepageFactory
\Magento\Quote\Api\CartManagementInterface	$quoteManagement
\Magento\Paypal\Model\Billing\AgreementFactory	$agreementFactory
\Magento\Paypal\Model\Api\Type\Factory	$apiTypeFactory
DataObject\Copy	$objectCopyService
\Magento\Checkout\Model\Session	$checkoutSession
\Magento\Framework\Encryption\EncryptorInterface	$encryptor
\Magento\Framework\Message\ManagerInterface	$messageManager
\Magento\Customer\Api\CustomerRepositoryInterface	$customerRepository
AccountManagement	$accountManagement
OrderSender	$orderSender
\Magento\Quote\Api\CartRepositoryInterface	$quoteRepository
\Magento\Quote\Model\Quote\TotalsCollector	$totalsCollector
array	$params

Exceptions

Definition at line 303 of file Checkout.php.

      {
        $this->quoteManagement = $quoteManagement;
        $this->_customerUrl = $customerUrl;
        $this->_taxData = $taxData;
        $this->_checkoutData = $checkoutData;
        $this->_configCacheType = $configCacheType;
        $this->_logger = $logger;
        $this->_localeResolver = $localeResolver;
        $this->_paypalInfo = $paypalInfo;
        $this->_storeManager = $storeManager;
        $this->_coreUrl = $coreUrl;
        $this->_cartFactory = $cartFactory;
        $this->_checkoutOnepageFactory = $onepageFactory;
        $this->_agreementFactory = $agreementFactory;
        $this->_apiTypeFactory = $apiTypeFactory;
        $this->_objectCopyService = $objectCopyService;
        $this->_checkoutSession = $checkoutSession;
        $this->_customerRepository = $customerRepository;
        $this->_encryptor = $encryptor;
        $this->_messageManager = $messageManager;
        $this->orderSender = $orderSender;
        $this->_accountManagement = $accountManagement;
        $this->quoteRepository = $quoteRepository;
        $this->totalsCollector = $totalsCollector;
        $this->_customerSession = isset($params['session'])
            && $params['session'] instanceof \Magento\Customer\Model\Session ? $params['session'] : $customerSession;

        if (isset($params['config']) && $params['config'] instanceof PaypalConfig) {
            $this->_config = $params['config'];
        } else {
            throw new \Exception('Config instance is required.');
        }

        if (isset($params['quote']) && $params['quote'] instanceof \Magento\Quote\Model\Quote) {
            $this->_quote = $params['quote'];
        } else {
            throw new \Exception('Quote instance is required.');
        }
    }

Member Function Documentation

_getApi()

_getApi ( )

protected

Get api

Returns

\Magento\Paypal\Model\Api\Nvp

Definition at line 955 of file Checkout.php.

    {
        if (null === $this->_api) {
            $this->_api = $this->_apiTypeFactory->create($this->_apiType)->setConfigObject($this->_config);
        }
        return $this->_api;
    }

_matchShippingMethodCode()

_matchShippingMethodCode ( Address  $address,   $selectedCode  )

protected

Try to find whether the code provided by PayPal corresponds to any of possible shipping rates

This method was created only because PayPal has issues with returning the selected code. If in future the issue is fixed, we don't need to attempt to match it. It would be enough to set the method code before collecting shipping rates

Parameters

Address	$address
string	$selectedCode

Returns

string

Definition at line 1076 of file Checkout.php.

    {
        $options = $this->_prepareShippingOptions($address, false);
        foreach ($options as $option) {
            if ($selectedCode === $option['code'] // the proper case as outlined in documentation
                || $selectedCode === $option['name'] // workaround: PayPal may return name instead of the code
                // workaround: PayPal may concatenate code and name, and return it instead of the code:
                || $selectedCode === "{$option['code']} {$option['name']}"
            ) {
                return $option['code'];
            }
        }
        return '';
    }

_prepareShippingOptions()

_prepareShippingOptions ( Address  $address,   $mayReturnEmpty = false,   $calculateTax = false  )

protected

Attempt to collect address shipping rates and return them for further usage in instant update API

Returns empty array if it was impossible to obtain any shipping rate and if there are shipping rates obtained, the method must return one of them as default.

Parameters

Address	$address
bool	$mayReturnEmpty
bool	$calculateTax

Returns

array|false @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 976 of file Checkout.php.

    {
        $options = [];
        $i = 0;
        $iMin = false;
        $min = false;
        $userSelectedOption = null;

        foreach ($address->getGroupedAllShippingRates() as $group) {
            foreach ($group as $rate) {
                $amount = (double)$rate->getPrice();
                if ($rate->getErrorMessage()) {
                    continue;
                }
                $isDefault = $address->getShippingMethod() === $rate->getCode();
                $amountExclTax = $this->_taxData->getShippingPrice($amount, false, $address);
                $amountInclTax = $this->_taxData->getShippingPrice($amount, true, $address);

                $options[$i] = new \Magento\Framework\DataObject(
                    [
                        'is_default' => $isDefault,
                        'name' => trim("{$rate->getCarrierTitle()} - {$rate->getMethodTitle()}", ' -'),
                        'code' => $rate->getCode(),
                        'amount' => $amountExclTax,
                    ]
                );
                if ($calculateTax) {
                    $options[$i]->setTaxAmount(
                        $amountInclTax - $amountExclTax + $address->getTaxAmount() - $address->getShippingTaxAmount()
                    );
                }
                if ($isDefault) {
                    $userSelectedOption = $options[$i];
                }
                if (false === $min || $amountInclTax < $min) {
                    $min = $amountInclTax;
                    $iMin = $i;
                }
                $i++;
            }
        }

        if ($mayReturnEmpty && $userSelectedOption === null) {
            $options[] = new \Magento\Framework\DataObject(
                [
                    'is_default' => true,
                    'name'       => __('N/A'),
                    'code'       => 'no_rate',
                    'amount'     => 0.00,
                ]
            );
            if ($calculateTax) {
                $options[$i]->setTaxAmount($address->getTaxAmount());
            }
        } elseif ($userSelectedOption === null && isset($options[$iMin])) {
            $options[$iMin]->setIsDefault(true);
        }

        // Magento will transfer only first 10 cheapest shipping options if there are more than 10 available.
        if (count($options) > 10) {
            usort($options, [get_class($this), 'cmpShippingOptions']);
            array_splice($options, 10);
            // User selected option will be always included in options list
            if ($userSelectedOption !== null && !in_array($userSelectedOption, $options)) {
                $options[9] = $userSelectedOption;
            }
        }

        return $options;
    }

_setBillingAgreementRequest()

_setBillingAgreementRequest ( )

protected

Set create billing agreement flag to api call

Returns

$this

Definition at line 928 of file Checkout.php.

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

        $isRequested = $this->_isBARequested || $this->_quote->getPayment()
            ->getAdditionalInformation(self::PAYMENT_INFO_TRANSPORT_BILLING_AGREEMENT);

        if (!($this->_config->getValue('allow_ba_signup') == PaypalConfig::EC_BA_SIGNUP_AUTO
            || $isRequested && $this->_config->shouldAskToCreateBillingAgreement())
        ) {
            return $this;
        }

        if (!$this->_agreementFactory->create()->needToCreateForCustomer($this->_customerId)) {
            return $this;
        }
        $this->_getApi()->setBillingType($this->_getApi()->getBillingAgreementType());
        return $this;
    }

_setExportedAddressData()

_setExportedAddressData (   $address,   $exportedAddress  )

protected

Sets address data from exported address

Parameters

Address	$address
array	$exportedAddress

Returns

void

Definition at line 913 of file Checkout.php.

    {
        foreach ($exportedAddress->getExportedKeys() as $key) {
            $data = $exportedAddress->getData($key);
            if (!empty($data)) {
                $address->setDataUsingMethod($key, $data);
            }
        }
    }

_setRedirectUrl()

_setRedirectUrl (   $button,   $token  )

protected

Create payment redirect url

Parameters

bool | null	$button
string	$token

Returns

void

Definition at line 1098 of file Checkout.php.

    {
        $this->_redirectUrl = ($button && !$this->_taxData->getConfig()->priceIncludesTax())
            ? $this->_config->getExpressCheckoutStartUrl($token)
            : $this->_config->getPayPalBasicStartUrl($token);
    }

canSkipOrderReviewStep()

canSkipOrderReviewStep

(

)

Check whether system can skip order review page before placing order

Returns

bool

Definition at line 596 of file Checkout.php.

    {
        $isOnepageCheckout = !$this->_quote->getPayment()->getAdditionalInformation(self::PAYMENT_INFO_BUTTON);
        return $this->_config->isOrderReviewStepDisabled() && $isOnepageCheckout;
    }

cmpShippingOptions()

static cmpShippingOptions ( DataObject  $option1, DataObject  $option2  )

staticprotected

Compare two shipping options based on their amounts

This function is used as a callback comparison function in shipping options sorting process

See also

self::_prepareShippingOptions()

Parameters

\Magento\Framework\DataObject	$option1
\Magento\Framework\DataObject	$option2

Returns

int

Definition at line 1057 of file Checkout.php.

    {
        if ($option1->getAmount() == $option2->getAmount()) {
            return 0;
        }
        return ($option1->getAmount() < $option2->getAmount()) ? -1 : 1;
    }

getBillingAgreement()

getBillingAgreement

(

)

Get created billing agreement

Returns

\Magento\Paypal\Model\Billing\Agreement|null

Definition at line 871 of file Checkout.php.

    {
        return $this->_billingAgreement;
    }

getCheckoutMethod()

getCheckoutMethod

(

)

Get checkout method

Returns

string

Definition at line 891 of file Checkout.php.

    {
        if ($this->getCustomerSession()->isLoggedIn()) {
            return \Magento\Checkout\Model\Type\Onepage::METHOD_CUSTOMER;
        }
        if (!$this->_quote->getCheckoutMethod()) {
            if ($this->_checkoutData->isAllowedGuestCheckout($this->_quote)) {
                $this->_quote->setCheckoutMethod(\Magento\Checkout\Model\Type\Onepage::METHOD_GUEST);
            } else {
                $this->_quote->setCheckoutMethod(\Magento\Checkout\Model\Type\Onepage::METHOD_REGISTER);
            }
        }
        return $this->_quote->getCheckoutMethod();
    }

getCheckoutShortcutImageUrl()

getCheckoutShortcutImageUrl

(

)

Checkout with PayPal image URL getter

Spares API calls of getting "pal" variable, by putting it into cache per store view

Returns

string

Definition at line 376 of file Checkout.php.

    {
        // get "pal" thing from cache or lookup it via API
        $pal = null;
        if ($this->_config->areButtonsDynamic()) {
            $cacheId = self::PAL_CACHE_ID . $this->_storeManager->getStore()->getId();
            $pal = $this->_configCacheType->load($cacheId);
            if (self::PAL_CACHE_ID == $pal) {
                $pal = null;
            } elseif (!$pal) {
                $pal = null;
                try {
                    $this->_getApi()->callGetPalDetails();
                    $pal = $this->_getApi()->getPal();
                    $this->_configCacheType->save($pal, $cacheId);
                } catch (\Exception $e) {
                    $this->_configCacheType->save(self::PAL_CACHE_ID, $cacheId);
                    $this->_logger->critical($e);
                }
            }
        }

        return $this->_config->getExpressCheckoutShortcutImageUrl(
            $this->_localeResolver->getLocale(),
            $this->_quote->getBaseGrandTotal(),
            $pal
        );
    }

getCustomerSession()

getCustomerSession

(

)

Get customer session object

Returns

\Magento\Customer\Model\Session

Definition at line 1110 of file Checkout.php.

    {
        return $this->_customerSession;
    }

getOrder()

getOrder

(

)

Return order

Returns

\Magento\Sales\Model\Order

Definition at line 881 of file Checkout.php.

    {
        return $this->_order;
    }

getRedirectUrl()

getRedirectUrl

(

)

Determine whether redirect somewhere specifically is required

Returns

string

Definition at line 861 of file Checkout.php.

    {
        return $this->_redirectUrl;
    }

getShippingOptionsCallbackResponse()

getShippingOptionsCallbackResponse

(

array

$request

)

Return callback response with shipping options

Parameters

array

$request

Returns

string

Exceptions

Definition at line 726 of file Checkout.php.

    {
        $debugData = ['request' => $request, 'response' => []];

        try {
            // obtain addresses
            $address = $this->_getApi()->prepareShippingOptionsCallbackAddress($request);
            $quoteAddress = $this->_quote->getShippingAddress();

            // compare addresses, calculate shipping rates and prepare response
            $options = [];
            if ($address && $quoteAddress && !$this->_quote->getIsVirtual()) {
                foreach ($address->getExportedKeys() as $key) {
                    $quoteAddress->setDataUsingMethod($key, $address->getData($key));
                }
                $quoteAddress->setCollectShippingRates(true);
                $this->totalsCollector->collectAddressTotals($this->_quote, $quoteAddress);
                $options = $this->_prepareShippingOptions($quoteAddress, false, true);
            }
            $response = $this->_getApi()->setShippingOptions($options)->formatShippingOptionsCallback();

            // log request and response
            $debugData['response'] = $response;
            $this->_logger->debug(var_export($debugData, true));
            return $response;
        } catch (\Exception $e) {
            $this->_logger->debug(var_export($debugData, true));
            throw $e;
        }
    }

place()

place	(		$token,
			$shippingMethodCode = null
	)

Place the order when customer returned from PayPal until this moment all quote data must be valid.

Parameters

string	$token
string | null	$shippingMethodCode

Returns

void @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 791 of file Checkout.php.

    {
        if ($shippingMethodCode) {
            $this->updateShippingMethod($shippingMethodCode);
        }

        if ($this->getCheckoutMethod() == \Magento\Checkout\Model\Type\Onepage::METHOD_GUEST) {
            $this->prepareGuestQuote();
        }

        $this->ignoreAddressValidation();
        $this->_quote->collectTotals();
        $order = $this->quoteManagement->submit($this->_quote);

        if (!$order) {
            return;
        }

        // commence redirecting to finish payment, if paypal requires it
        if ($order->getPayment()->getAdditionalInformation(self::PAYMENT_INFO_TRANSPORT_REDIRECT)) {
            $this->_redirectUrl = $this->_config->getExpressCheckoutCompleteUrl($token);
        }

        switch ($order->getState()) {
            // even after placement paypal can disallow to authorize/capture, but will wait until bank transfers money
            case \Magento\Sales\Model\Order::STATE_PENDING_PAYMENT:
                // TODO
                break;
                // regular placement, when everything is ok
            case \Magento\Sales\Model\Order::STATE_PROCESSING:
            case \Magento\Sales\Model\Order::STATE_COMPLETE:
            case \Magento\Sales\Model\Order::STATE_PAYMENT_REVIEW:
                try {
                    if (!$order->getEmailSent()) {
                        $this->orderSender->send($order);
                    }
                } catch (\Exception $e) {
                    $this->_logger->critical($e);
                }
                $this->_checkoutSession->start();
                break;
            default:
                break;
        }
        $this->_order = $order;
    }

prepareGiropayUrls()

prepareGiropayUrls	(		$successUrl,
			$cancelUrl,
			$pendingUrl
	)

Setter that enables giropay redirects flow

Parameters

string	$successUrl	- payment success result
string	$cancelUrl	- payment cancellation result
string	$pendingUrl	- pending payment result

Returns

$this

Definition at line 413 of file Checkout.php.

    {
        $this->_giropayUrls = [$successUrl, $cancelUrl, $pendingUrl];
        return $this;
    }

prepareGuestQuote()

prepareGuestQuote ( )

protected

Prepare quote for guest checkout order submit

Returns

$this

Definition at line 1152 of file Checkout.php.

    {
        $quote = $this->_quote;
        $quote->setCustomerId(null)
            ->setCustomerEmail($quote->getBillingAddress()->getEmail())
            ->setCustomerIsGuest(true)
            ->setCustomerGroupId(\Magento\Customer\Model\Group::NOT_LOGGED_IN_ID);
        return $this;
    }

prepareOrderReview()

prepareOrderReview

(

$token = null

)

Check whether order review has enough data to initialize

Parameters

string | null

$token

Returns

void

Exceptions

Definition at line 702 of file Checkout.php.

    {
        $payment = $this->_quote->getPayment();
        if (!$payment || !$payment->getAdditionalInformation(self::PAYMENT_INFO_TRANSPORT_PAYER_ID)) {
            throw new \Magento\Framework\Exception\LocalizedException(__('A payer is not identified.'));
        }
        $this->_quote->setMayEditShippingAddress(
            1 != $this->_quote->getPayment()->getAdditionalInformation(self::PAYMENT_INFO_TRANSPORT_SHIPPING_OVERRIDDEN)
        );
        $this->_quote->setMayEditShippingMethod(
            '' == $this->_quote->getPayment()->getAdditionalInformation(self::PAYMENT_INFO_TRANSPORT_SHIPPING_METHOD)
        );
        $this->ignoreAddressValidation();
        $this->_quote->collectTotals();
        $this->quoteRepository->save($this->_quote);
    }

returnFromPaypal()

returnFromPaypal

(

$token

)

Update quote when returned from PayPal

Rewrite billing address by paypal, save old billing address for new customer, and export shipping address in case address absence

Parameters

string

$token

Returns

void @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 612 of file Checkout.php.

    {
        $this->_getApi()
            ->setToken($token)
            ->callGetExpressCheckoutDetails();
        $quote = $this->_quote;

        $this->ignoreAddressValidation();

        // check if we came from the Express Checkout button
        $isButton = (bool)$quote->getPayment()->getAdditionalInformation(self::PAYMENT_INFO_BUTTON);

        // import shipping address
        $exportedShippingAddress = $this->_getApi()->getExportedShippingAddress();
        if (!$quote->getIsVirtual()) {
            $shippingAddress = $quote->getShippingAddress();
            if ($shippingAddress) {
                if ($exportedShippingAddress && $isButton) {
                    $this->_setExportedAddressData($shippingAddress, $exportedShippingAddress);
                    // PayPal doesn't provide detailed shipping info: prefix, middlename, lastname, suffix
                    $shippingAddress->setPrefix(null);
                    $shippingAddress->setMiddlename(null);
                    $shippingAddress->setLastname(null);
                    $shippingAddress->setSuffix(null);
                    $shippingAddress->setCollectShippingRates(true);
                    $shippingAddress->setSameAsBilling(0);
                }

                // import shipping method
                $code = '';
                if ($this->_getApi()->getShippingRateCode()) {
                    $code = $this->_matchShippingMethodCode($shippingAddress, $this->_getApi()->getShippingRateCode());
                    if ($code) {
                        // possible bug of double collecting rates :-/
                        $shippingAddress->setShippingMethod($code)->setCollectShippingRates(true);
                    }
                }
                $quote->getPayment()->setAdditionalInformation(
                    self::PAYMENT_INFO_TRANSPORT_SHIPPING_METHOD,
                    $code
                );
            }
        }

        // import billing address
        $requireBillingAddress = (int)$this->_config->getValue(
            'requireBillingAddress'
        ) === \Magento\Paypal\Model\Config::REQUIRE_BILLING_ADDRESS_ALL;

        if ($isButton && !$requireBillingAddress && !$quote->isVirtual()) {
            $billingAddress = clone $shippingAddress;
            $billingAddress->unsAddressId()->unsAddressType()->setCustomerAddressId(null);
            $data = $billingAddress->getData();
            $data['save_in_address_book'] = 0;
            $quote->getBillingAddress()->addData($data);
            $quote->getShippingAddress()->setSameAsBilling(1);
        } else {
            $billingAddress = $quote->getBillingAddress()->setCustomerAddressId(null);
        }
        $exportedBillingAddress = $this->_getApi()->getExportedBillingAddress();

        // Since country is required field for billing and shipping address,
        // we consider the address information to be empty if country is empty.
        $isEmptyAddress = ($billingAddress->getCountryId() === null);

        if ($requireBillingAddress || $isEmptyAddress) {
            $this->_setExportedAddressData($billingAddress, $exportedBillingAddress);
        }
        $billingAddress->setCustomerNote($exportedBillingAddress->getData('note'));
        $quote->setBillingAddress($billingAddress);
        $quote->setCheckoutMethod($this->getCheckoutMethod());

        // import payment info
        $payment = $quote->getPayment();
        $payment->setMethod($this->_methodType);
        $this->_paypalInfo->importToPayment($this->_getApi(), $payment);
        $payment->setAdditionalInformation(self::PAYMENT_INFO_TRANSPORT_PAYER_ID, $this->_getApi()->getPayerId())
            ->setAdditionalInformation(self::PAYMENT_INFO_TRANSPORT_TOKEN, $token);
        $quote->collectTotals();
        $this->quoteRepository->save($quote);
    }

setCustomerData()

setCustomerData

(

CustomerDataObject

$customerData

)

Setter for customer

Parameters

CustomerDataObject

$customerData

Returns

$this

Definition at line 449 of file Checkout.php.

    {
        $this->_quote->assignCustomer($customerData);
        $this->_customerId = $customerData->getId();
        return $this;
    }

setCustomerWithAddressChange()

setCustomerWithAddressChange	(	CustomerDataObject	$customerData,
			$billingAddress = null,
			$shippingAddress = null
	)

Setter for customer with billing and shipping address changing ability

Parameters

CustomerDataObject	$customerData
Address | null	$billingAddress
Address | null	$shippingAddress

Returns

$this

Definition at line 464 of file Checkout.php.

      {
        $this->_quote->assignCustomerWithAddressChange($customerData, $billingAddress, $shippingAddress);
        $this->_customerId = $customerData->getId();
        return $this;
    }

setIsBillingAgreementRequested()

setIsBillingAgreementRequested

(

$flag

)

Set create billing agreement flag

Parameters

bool

$flag

Returns

$this

Definition at line 425 of file Checkout.php.

    {
        $this->_isBARequested = $flag;
        return $this;
    }

setIsBml()

setIsBml

(

$isBml

)

Set flag that forces to use BillMeLater

Parameters

bool

$isBml

Returns

$this

Definition at line 437 of file Checkout.php.

    {
        $this->_isBml = $isBml;
        return $this;
    }

updateShippingMethod()

updateShippingMethod

(

$methodCode

)

Set shipping method to quote, if needed

Parameters

string

$methodCode

Returns

void

Definition at line 763 of file Checkout.php.

    {
        $shippingAddress = $this->_quote->getShippingAddress();
        if (!$this->_quote->getIsVirtual() && $shippingAddress) {
            if ($methodCode != $shippingAddress->getShippingMethod()) {
                $this->ignoreAddressValidation();
                $shippingAddress->setShippingMethod($methodCode)->setCollectShippingRates(true);
                $cartExtension = $this->_quote->getExtensionAttributes();
                if ($cartExtension && $cartExtension->getShippingAssignments()) {
                    $cartExtension->getShippingAssignments()[0]
                        ->getShipping()
                        ->setMethod($methodCode);
                }
                $this->_quote->collectTotals();
                $this->quoteRepository->save($this->_quote);
            }
        }
    }

Field Documentation

$_accountManagement

$_accountManagement

protected

Definition at line 242 of file Checkout.php.

$_agreementFactory

$_agreementFactory

protected

Definition at line 217 of file Checkout.php.

$_api

$_api

protected

Definition at line 69 of file Checkout.php.

$_apiType

$_apiType = \Magento\Paypal\Model\Api\Nvp::class

protected

Definition at line 76 of file Checkout.php.

$_apiTypeFactory

$_apiTypeFactory

protected

Definition at line 222 of file Checkout.php.

$_billingAgreement

$_billingAgreement

protected

Definition at line 144 of file Checkout.php.

$_cartFactory

$_cartFactory

protected

Definition at line 207 of file Checkout.php.

$_checkoutData

$_checkoutData

protected

Definition at line 163 of file Checkout.php.

$_checkoutOnepageFactory

$_checkoutOnepageFactory

protected

Definition at line 212 of file Checkout.php.

$_checkoutRedirectUrl

$_checkoutRedirectUrl = ''

protected

Definition at line 104 of file Checkout.php.

$_checkoutSession

$_checkoutSession

protected

Definition at line 232 of file Checkout.php.

$_config

$_config

protected

Definition at line 62 of file Checkout.php.

$_configCacheType

$_configCacheType

protected

Definition at line 156 of file Checkout.php.

$_coreUrl

$_coreUrl

protected

Definition at line 202 of file Checkout.php.

$_customerId

$_customerId

protected

Definition at line 137 of file Checkout.php.

$_customerRepository

$_customerRepository

protected

Definition at line 237 of file Checkout.php.

$_customerSession

$_customerSession

protected

Definition at line 109 of file Checkout.php.

$_customerUrl

$_customerUrl

protected

Definition at line 177 of file Checkout.php.

$_encryptor

$_encryptor

protected

Definition at line 247 of file Checkout.php.

$_giropayUrls

$_giropayUrls = []

protected

Definition at line 116 of file Checkout.php.

$_isBARequested

$_isBARequested = false

protected

Definition at line 123 of file Checkout.php.

$_isBml

$_isBml = false

protected

Definition at line 130 of file Checkout.php.

$_localeResolver

$_localeResolver

protected

Definition at line 187 of file Checkout.php.

$_logger

$_logger

protected

Definition at line 182 of file Checkout.php.

$_messageManager

$_messageManager

protected

Definition at line 252 of file Checkout.php.

$_methodType

$_methodType = PaypalConfig::METHOD_WPP_EXPRESS

protected

Definition at line 83 of file Checkout.php.

$_objectCopyService

$_objectCopyService

protected

Definition at line 227 of file Checkout.php.

$_order

$_order

protected

Definition at line 151 of file Checkout.php.

$_paypalInfo

$_paypalInfo

protected

Definition at line 192 of file Checkout.php.

$_pendingPaymentMessage

$_pendingPaymentMessage = ''

protected

Definition at line 97 of file Checkout.php.

$_quote

$_quote

protected

Definition at line 55 of file Checkout.php.

$_redirectUrl

$_redirectUrl = ''

protected

Definition at line 90 of file Checkout.php.

$_storeManager

$_storeManager

protected

Definition at line 197 of file Checkout.php.

$_taxData

$_taxData

protected

Definition at line 170 of file Checkout.php.

$orderSender

$orderSender

protected

Definition at line 257 of file Checkout.php.

$quoteManagement

$quoteManagement

protected

Definition at line 267 of file Checkout.php.

$quoteRepository

$quoteRepository

protected

Definition at line 262 of file Checkout.php.

$totalsCollector

$totalsCollector

protected

Definition at line 272 of file Checkout.php.

PAL_CACHE_ID

const PAL_CACHE_ID = 'paypal_express_checkout_pal'

Definition at line 32 of file Checkout.php.

PAYMENT_INFO_BUTTON

const PAYMENT_INFO_BUTTON = 'button'

Definition at line 50 of file Checkout.php.

PAYMENT_INFO_TRANSPORT_BILLING_AGREEMENT

const PAYMENT_INFO_TRANSPORT_BILLING_AGREEMENT = 'paypal_ec_create_ba'

Definition at line 43 of file Checkout.php.

PAYMENT_INFO_TRANSPORT_PAYER_ID

const PAYMENT_INFO_TRANSPORT_PAYER_ID = 'paypal_express_checkout_payer_id'

Definition at line 41 of file Checkout.php.

PAYMENT_INFO_TRANSPORT_REDIRECT

const PAYMENT_INFO_TRANSPORT_REDIRECT = 'paypal_express_checkout_redirect_required'

Definition at line 42 of file Checkout.php.

PAYMENT_INFO_TRANSPORT_SHIPPING_METHOD

const PAYMENT_INFO_TRANSPORT_SHIPPING_METHOD = 'paypal_express_checkout_shipping_method'

Definition at line 40 of file Checkout.php.

PAYMENT_INFO_TRANSPORT_SHIPPING_OVERRIDDEN

const PAYMENT_INFO_TRANSPORT_SHIPPING_OVERRIDDEN = 'paypal_express_checkout_shipping_overridden'

Definition at line 39 of file Checkout.php.

PAYMENT_INFO_TRANSPORT_TOKEN

const PAYMENT_INFO_TRANSPORT_TOKEN = 'paypal_express_checkout_token'

Keys for passthrough variables in sales/quote_payment and sales/order_payment Uses additional_information as storage

Definition at line 38 of file Checkout.php.

---

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

• vendor/magento/module-paypal/Model/Express/Checkout.php