Inheritance diagram for Express:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory, \Magento\Payment\Helper\Data $paymentData, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Payment\Model\Method\Logger $logger, ProFactory $proFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\UrlInterface $urlBuilder, \Magento\Paypal\Model\CartFactory $cartFactory, \Magento\Checkout\Model\Session $checkoutSession, \Magento\Framework\Exception\LocalizedExceptionFactory $exception, \Magento\Sales\Api\TransactionRepositoryInterface $transactionRepository, \Magento\Sales\Model\Order\Payment\Transaction\BuilderInterface $transactionBuilder, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	setStore ($store)

	canUseCheckout ()

	canUseForCurrency ($currencyCode)

	getConfigPaymentAction ()

	isAvailable (\Magento\Quote\Api\Data\CartInterface $quote=null)

	getConfigData ($field, $storeId=null)

	order (\Magento\Payment\Model\InfoInterface $payment, $amount)

	authorize (\Magento\Payment\Model\InfoInterface $payment, $amount)

	void (\Magento\Payment\Model\InfoInterface $payment)

	capture (\Magento\Payment\Model\InfoInterface $payment, $amount)

	refund (\Magento\Payment\Model\InfoInterface $payment, $amount)

	cancel (\Magento\Payment\Model\InfoInterface $payment)

	canReviewPayment ()

	acceptPayment (\Magento\Payment\Model\InfoInterface $payment)

	denyPayment (\Magento\Payment\Model\InfoInterface $payment)

	getCheckoutRedirectUrl ()

	fetchTransactionInfo (\Magento\Payment\Model\InfoInterface $payment, $transactionId)

	getApi ()

	assignData (\Magento\Framework\DataObject $data)

	canVoid ()

	canCapture ()

	isActive ($storeId=null)

Public Member Functions inherited from AbstractMethod
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory, \Magento\Payment\Helper\Data $paymentData, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Payment\Model\Method\Logger $logger, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[], DirectoryHelper $directory=null)

	setStore ($storeId)

	getStore ()

	canOrder ()

	canAuthorize ()

	canCapture ()

	canCapturePartial ()

	canCaptureOnce ()

	canRefund ()

	canRefundPartialPerInvoice ()

	canVoid ()

	canUseInternal ()

	canUseCheckout ()

	canEdit ()

	canFetchTransactionInfo ()

	fetchTransactionInfo (InfoInterface $payment, $transactionId)

	isGateway ()

	isOffline ()

	isInitializeNeeded ()

	canUseForCountry ($country)

	canUseForCurrency ($currencyCode)

	getCode ()

	getFormBlockType ()

	getInfoBlockType ()

	getInfoInstance ()

	setInfoInstance (InfoInterface $info)

	validate ()

	order (\Magento\Payment\Model\InfoInterface $payment, $amount)

	authorize (\Magento\Payment\Model\InfoInterface $payment, $amount)

	capture (\Magento\Payment\Model\InfoInterface $payment, $amount)

	refund (\Magento\Payment\Model\InfoInterface $payment, $amount)

	cancel (\Magento\Payment\Model\InfoInterface $payment)

	void (\Magento\Payment\Model\InfoInterface $payment)

	canReviewPayment ()

	acceptPayment (InfoInterface $payment)

	denyPayment (InfoInterface $payment)

	getTitle ()

	getConfigData ($field, $storeId=null)

	assignData (\Magento\Framework\DataObject $data)

	isAvailable (\Magento\Quote\Api\Data\CartInterface $quote=null)

	isActive ($storeId=null)

	initialize ($paymentAction, $stateObject)

	getConfigPaymentAction ()

	getDebugFlag ()

	debugData ($debugData)

	getDebugReplacePrivateDataKeys ()

Public Member Functions inherited from AbstractExtensibleModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	getCustomAttributes ()

	getCustomAttribute ($attributeCode)

	setCustomAttributes (array $attributes)

	setCustomAttribute ($attributeCode, $attributeValue)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	setId ($value)

	__sleep ()

	__wakeup ()

Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	__sleep ()

	__wakeup ()

	setIdFieldName ($name)

	getIdFieldName ()

	getId ()

	setId ($value)

	isDeleted ($isDeleted=null)

	hasDataChanges ()

	setData ($key, $value=null)

	unsetData ($key=null)

	setDataChanges ($value)

	getOrigData ($key=null)

	setOrigData ($key=null, $data=null)

	dataHasChangedFor ($field)

	getResourceName ()

	getResourceCollection ()

	getCollection ()

	load ($modelId, $field=null)

	beforeLoad ($identifier, $field=null)

	afterLoad ()

	isSaveAllowed ()

	setHasDataChanges ($flag)

	save ()

	afterCommitCallback ()

	isObjectNew ($flag=null)

	beforeSave ()

	validateBeforeSave ()

	getCacheTags ()

	cleanModelCache ()

	afterSave ()

	delete ()

	beforeDelete ()

	afterDelete ()

	afterDeleteCommit ()

	getResource ()

	getEntityId ()

	setEntityId ($entityId)

	clearInstance ()

	getStoredData ()

	getEventPrefix ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from MethodInterface
	order (\Magento\Payment\Model\InfoInterface $payment, $amount)

	authorize (\Magento\Payment\Model\InfoInterface $payment, $amount)

	capture (\Magento\Payment\Model\InfoInterface $payment, $amount)

	refund (\Magento\Payment\Model\InfoInterface $payment, $amount)

	cancel (\Magento\Payment\Model\InfoInterface $payment)

	void (\Magento\Payment\Model\InfoInterface $payment)

	assignData (DataObject $data)

	isAvailable (CartInterface $quote=null)

Public Member Functions inherited from PaymentMethodInterface
	getStoreId ()

	getIsActive ()

Protected Member Functions
	_setApiProcessableErrors ()

	_placeOrder (Payment $payment, $amount)

	_importToPayment ($api, $payment)

	_callDoAuthorize ($amount, $payment, $parentTransactionId)

	_isTransactionExpired (Transaction $transaction, $period)

	getOrderTransaction ($payment)

Protected Member Functions inherited from AbstractMethod
	initializeData ($data=[])

	_debug ($debugData)

Protected Member Functions inherited from AbstractExtensibleModel
	filterCustomAttributes ($data)

	initializeCustomAttributes ()

	convertCustomAttributeValues (array &$customAttributes)

	getCustomAttributesCodes ()

	_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)

	_getExtensionAttributes ()

Protected Member Functions inherited from AbstractModel
	_construct ()

	_init ($resourceModel)

	_setResourceModel ($resourceName, $collectionName=null)

	_getResource ()

	_getEventData ()

	_beforeLoad ($modelId, $field=null)

	_afterLoad ()

	_hasModelChanged ()

	_getValidatorBeforeSave ()

	_createValidatorBeforeSave ()

	_getValidationRulesBeforeSave ()

	_clearReferences ()

	_clearData ()

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_code = \Magento\Paypal\Model\Config::METHOD_WPP_EXPRESS

	$_formBlockType = \Magento\Paypal\Block\Express\Form::class

	$_infoBlockType = \Magento\Paypal\Block\Payment\Info::class

	$_isGateway = false

	$_canOrder = true

	$_canAuthorize = true

	$_canCapture = true

	$_canCapturePartial = true

	$_canRefund = true

	$_canRefundInvoicePartial = true

	$_canVoid = true

	$_canUseInternal = false

	$_canUseCheckout = true

	$_canFetchTransactionInfo = true

	$_canReviewPayment = true

	$_pro

	$_isOrderPaymentActionKey = 'is_order_action'

	$_authorizationCountKey = 'authorization_count'

	$_storeManager

	$_urlBuilder

	$_cartFactory

	$_checkoutSession

	$_exception

	$transactionRepository

	$transactionBuilder

Protected Attributes inherited from AbstractMethod
	$_code

	$_formBlockType = \Magento\Payment\Block\Form::class

	$_infoBlockType = \Magento\Payment\Block\Info::class

	$_isGateway = false

	$_isOffline = false

	$_canOrder = false

	$_canAuthorize = false

	$_canCapture = false

	$_canCapturePartial = false

	$_canCaptureOnce = false

	$_canRefund = false

	$_canRefundInvoicePartial = false

	$_canVoid = false

	$_canUseInternal = true

	$_canUseCheckout = true

	$_isInitializeNeeded = false

	$_canFetchTransactionInfo = false

	$_canReviewPayment = false

	$_canCancelInvoice = false

	$_debugReplacePrivateDataKeys = []

	$_paymentData

	$_scopeConfig

	$logger

Protected Attributes inherited from AbstractExtensibleModel
	$extensionAttributesFactory

	$extensionAttributes

	$customAttributeFactory

	$customAttributesCodes = null

	$customAttributesChanged = false

Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'

	$_eventObject = 'object'

	$_idFieldName = 'id'

	$_hasDataChanges = false

	$_origData

	$_isDeleted = false

	$_resource

	$_resourceCollection

	$_resourceName

	$_collectionName

	$_cacheTag = false

	$_dataSaveAllowed = true

	$_isObjectNew = null

	$_validatorBeforeSave = null

	$_eventManager

	$_cacheManager

	$_registry

	$_logger

	$_appState

	$_actionValidator

	$storedData = []

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Data Fields inherited from AbstractMethod
const	STATUS_UNKNOWN = 'UNKNOWN'

const	STATUS_APPROVED = 'APPROVED'

const	STATUS_ERROR = 'ERROR'

const	STATUS_DECLINED = 'DECLINED'

const	STATUS_VOID = 'VOID'

const	STATUS_SUCCESS = 'SUCCESS'

Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'

Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Data Fields inherited from MethodInterface
const	ACTION_ORDER = 'order'

const	ACTION_AUTHORIZE = 'authorize'

const	ACTION_AUTHORIZE_CAPTURE = 'authorize_capture'

const	CHECK_USE_FOR_COUNTRY = 'country'

const	CHECK_USE_FOR_CURRENCY = 'currency'

const	CHECK_USE_CHECKOUT = 'checkout'

const	CHECK_USE_INTERNAL = 'internal'

const	CHECK_ORDER_TOTAL_MIN_MAX = 'total'

const	CHECK_ZERO_TOTAL = 'zero_total'

const	GROUP_OFFLINE = 'offline'

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

PayPal Express Module @method \Magento\Quote\Api\Data\PaymentMethodExtensionInterface getExtensionAttributes() @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 25 of file Express.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		\Magento\Framework\Api\AttributeValueFactory	$customAttributeFactory,
		\Magento\Payment\Helper\Data	$paymentData,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Payment\Model\Method\Logger	$logger,
		ProFactory	$proFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\UrlInterface	$urlBuilder,
		\Magento\Paypal\Model\CartFactory	$cartFactory,
		\Magento\Checkout\Model\Session	$checkoutSession,
		\Magento\Framework\Exception\LocalizedExceptionFactory	$exception,
		\Magento\Sales\Api\TransactionRepositoryInterface	$transactionRepository,
		\Magento\Sales\Model\Order\Payment\Transaction\BuilderInterface	$transactionBuilder,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = `null`,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = `null`,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
\Magento\Framework\Api\AttributeValueFactory	$customAttributeFactory
\Magento\Payment\Helper\Data	$paymentData
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Payment\Model\Method\Logger	$logger
ProFactory	$proFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\UrlInterface	$urlBuilder
CartFactory	$cartFactory
\Magento\Checkout\Model\Session	$checkoutSession
\Magento\Framework\Exception\LocalizedExceptionFactory	$exception
\Magento\Sales\Api\TransactionRepositoryInterface	$transactionRepository
Transaction\BuilderInterface	$transactionBuilder
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 203 of file Express.php.

       {
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $paymentData,
             $scopeConfig,
             $logger,
             $resource,
             $resourceCollection,
             $data
         );
         $this->_storeManager = $storeManager;
         $this->_urlBuilder = $urlBuilder;
         $this->_cartFactory = $cartFactory;
         $this->_checkoutSession = $checkoutSession;
         $this->_exception = $exception;
         $this->transactionRepository = $transactionRepository;
         $this->transactionBuilder = $transactionBuilder;
 
         $proInstance = array_shift($data);
         if ($proInstance && $proInstance instanceof \Magento\Paypal\Model\Pro) {
             $this->_pro = $proInstance;
         } else {
             $this->_pro = $proFactory->create();
         }
         $this->_pro->setMethod($this->_code);
         $this->_setApiProcessableErrors();
     }

Member Function Documentation

◆ _callDoAuthorize()

_callDoAuthorize	(	$amount,
		$payment,
		$parentTransactionId
	)

protected

Call DoAuthorize

Parameters

int	$amount
\Magento\Framework\DataObject	$payment
string	$parentTransactionId

Returns: \Magento\Paypal\Model\Api\AbstractApi

Definition at line 775 of file Express.php.

     {
         $apiData = $this->_pro->getApi()->getData();
         foreach ($apiData as $k => $v) {
             if (is_object($v)) {
                 unset($apiData[$k]);
             }
         }
         $this->_checkoutSession->setPaypalTransactionData($apiData);
         $this->_pro->resetApi();
         $api = $this->_setApiProcessableErrors()
             ->setAmount($amount)
             ->setCurrencyCode($payment->getOrder()->getBaseCurrencyCode())
             ->setTransactionId($parentTransactionId)
             ->callDoAuthorization();
 
         $payment->setAdditionalInformation(
             $this->_authorizationCountKey,
             $payment->getAdditionalInformation($this->_authorizationCountKey) + 1
         );
 
         return $api;
     }

◆ _importToPayment()

_importToPayment	(	$api,
		$payment
	)

protected

Import payment info to payment

Parameters

Nvp	$api
Payment	$payment

Returns: void

Definition at line 695 of file Express.php.

     {
         $payment->setTransactionId(
             $api->getTransactionId()
         )->setIsTransactionClosed(
             0
         )->setAdditionalInformation(
             ExpressCheckout::PAYMENT_INFO_TRANSPORT_REDIRECT,
             $api->getRedirectRequired()
         );
 
         if ($api->getBillingAgreementId()) {
             $payment->setBillingAgreementData(
                 [
                     'billing_agreement_id' => $api->getBillingAgreementId(),
                     'method_code' => \Magento\Paypal\Model\Config::METHOD_BILLING_AGREEMENT,
                 ]
             );
         }
 
         $this->_pro->importPaymentInfo($api, $payment);
     }

◆ _isTransactionExpired()

_isTransactionExpired	(	Transaction	$transaction,
			$period
	)

protected

Check transaction for expiration in PST

Parameters

Transaction	$transaction
int	$period

Returns: bool

11:49:00 PayPal transactions closing time

Definition at line 806 of file Express.php.

     {
         $period = intval($period);
         if (0 == $period) {
             return true;
         }
 
         $transactionClosingDate = new \DateTime($transaction->getCreatedAt(), new \DateTimeZone('GMT'));
         $transactionClosingDate->setTimezone(new \DateTimeZone('US/Pacific'));
         $transactionClosingDate->setTime(11, 49, 00);
         $transactionClosingDate->modify('+' . $period . ' days');
 
         $currentTime = new \DateTime(null, new \DateTimeZone('US/Pacific'));
 
         if ($currentTime > $transactionClosingDate) {
             return true;
         }
 
         return false;
     }

◆ _placeOrder()

_placeOrder	(	Payment	$payment,
			$amount
	)

protected

Place an order with authorization or capture action

Parameters

Payment	$payment
float	$amount

Returns: $this

Definition at line 646 of file Express.php.

     {
         $order = $payment->getOrder();
 
         // prepare api call
         $token = $payment->getAdditionalInformation(ExpressCheckout::PAYMENT_INFO_TRANSPORT_TOKEN);
 
         $cart = $this->_cartFactory->create(['salesModel' => $order]);
 
         $api = $this->getApi()->setToken(
             $token
         )->setPayerId(
             $payment->getAdditionalInformation(ExpressCheckout::PAYMENT_INFO_TRANSPORT_PAYER_ID)
         )->setAmount(
             $amount
         )->setPaymentAction(
             $this->_pro->getConfig()->getValue('paymentAction')
         )->setNotifyUrl(
             $this->_urlBuilder->getUrl('paypal/ipn/')
         )->setInvNum(
             $order->getIncrementId()
         )->setCurrencyCode(
             $order->getBaseCurrencyCode()
         )->setPaypalCart(
             $cart
         )->setIsLineItemsEnabled(
             $this->_pro->getConfig()->getValue('lineItemsEnabled')
         );
         if ($order->getIsVirtual()) {
             $api->setAddress($order->getBillingAddress())->setSuppressShipping(true);
         } else {
             $api->setAddress($order->getShippingAddress());
             $api->setBillingAddress($order->getBillingAddress());
         }
 
         // call api and get details from it
         $api->callDoExpressCheckoutPayment();
 
         $this->_importToPayment($api, $payment);
         return $this;
     }

◆ _setApiProcessableErrors()

_setApiProcessableErrors ( )

protected

Set processable error codes to API model

Returns: \Magento\Paypal\Model\Api\Nvp

Definition at line 258 of file Express.php.

     {
         return $this->_pro->getApi()->setProcessableErrors(
             [
                 ApiProcessableException::API_INTERNAL_ERROR,
                 ApiProcessableException::API_UNABLE_PROCESS_PAYMENT_ERROR_CODE,
                 ApiProcessableException::API_DO_EXPRESS_CHECKOUT_FAIL,
                 ApiProcessableException::API_UNABLE_TRANSACTION_COMPLETE,
                 ApiProcessableException::API_TRANSACTION_EXPIRED,
                 ApiProcessableException::API_MAX_PAYMENT_ATTEMPTS_EXCEEDED,
                 ApiProcessableException::API_COUNTRY_FILTER_DECLINE,
                 ApiProcessableException::API_MAXIMUM_AMOUNT_FILTER_DECLINE,
                 ApiProcessableException::API_OTHER_FILTER_DECLINE,
                 ApiProcessableException::API_ADDRESS_MATCH_FAIL,
             ]
         );
     }

◆ acceptPayment()

acceptPayment ( \Magento\Payment\Model\InfoInterface $payment )

Attempt to accept a pending payment

Parameters

\Magento\Payment\Model\Info | Payment $payment

Returns: bool

Definition at line 561 of file Express.php.

     {
         parent::acceptPayment($payment);
         return $this->_pro->reviewPayment($payment, \Magento\Paypal\Model\Pro::PAYMENT_REVIEW_ACCEPT);
     }

◆ assignData()

assignData ( \Magento\Framework\DataObject $data )

Assign data to info model instance

Parameters

array | \Magento\Framework\DataObject $data

Returns: \Magento\Payment\Model\Info

Exceptions

Definition at line 618 of file Express.php.

     {
         parent::assignData($data);
 
         $additionalData = $data->getData(PaymentInterface::KEY_ADDITIONAL_DATA);
 
         if (!is_array($additionalData)) {
             return $this;
         }
 
         foreach ($additionalData as $key => $value) {
             // Skip extension attributes
             if ($key === \Magento\Framework\Api\ExtensibleDataInterface::EXTENSION_ATTRIBUTES_KEY) {
                 continue;
             }
 
             $this->getInfoInstance()->setAdditionalInformation($key, $value);
         }
         return $this;
     }

◆ authorize()

authorize	(	\Magento\Payment\Model\InfoInterface	$payment,
			$amount
	)

Authorize payment

Parameters

\Magento\Framework\DataObject \| \Magento\Payment\Model\InfoInterface \| Payment	$payment
float	$amount

Returns: $this

Definition at line 394 of file Express.php.

     {
         return $this->_placeOrder($payment, $amount);
     }

◆ canCapture()

canCapture ( )

Check capture availability

Returns: bool

Implements MethodInterface.

Definition at line 742 of file Express.php.

     {
         $payment = $this->getInfoInstance();
         $this->_pro->getConfig()->setStoreId($payment->getOrder()->getStore()->getId());
 
         if ($payment->getAdditionalInformation($this->_isOrderPaymentActionKey)) {
             $orderTransaction = $this->getOrderTransaction($payment);
             if ($orderTransaction->getIsClosed()) {
                 return false;
             }
 
             $orderValidPeriod = abs(intval($this->getConfigData('order_valid_period')));
 
             $dateCompass = new \DateTime($orderTransaction->getCreatedAt());
             $dateCompass->modify('+' . $orderValidPeriod . ' days');
             $currentDate = new \DateTime();
 
             if ($currentDate > $dateCompass || $orderValidPeriod == 0) {
                 return false;
             }
         }
 
         return $this->_canCapture;
     }

◆ cancel()

cancel ( \Magento\Payment\Model\InfoInterface $payment )

Cancel payment

Parameters

\Magento\Framework\DataObject | \Magento\Payment\Model\InfoInterface | Payment $payment

Returns: $this

Definition at line 539 of file Express.php.

     {
         $this->void($payment);
 
         return $this;
     }

◆ canReviewPayment()

canReviewPayment ( )

Whether payment can be reviewed

Returns: bool

Implements MethodInterface.

Definition at line 550 of file Express.php.

     {
         return parent::canReviewPayment() && $this->_pro->canReviewPayment($this->getInfoInstance());
     }

◆ canUseCheckout()

canUseCheckout ( )

Can be used in regular checkout

Returns: bool

Implements MethodInterface.

Definition at line 298 of file Express.php.

     {
         if ($this->_scopeConfig->isSetFlag(
             'payment/hosted_pro/active',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         ) && !$this->_scopeConfig->isSetFlag(
             'payment/hosted_pro/display_ec',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         )
         ) {
             return false;
         }
         return parent::canUseCheckout();
     }

◆ canUseForCurrency()

canUseForCurrency ( $currencyCode )

Whether method is available for specified currency

Parameters

string $currencyCode

Returns: bool

Implements MethodInterface.

Definition at line 319 of file Express.php.

     {
         return $this->_pro->getConfig()->isCurrencyCodeSupported($currencyCode);
     }

◆ canVoid()

canVoid ( )

Check void availability

Returns: bool

Exceptions

Implements MethodInterface.

Definition at line 724 of file Express.php.

     {
         $info = $this->getInfoInstance();
         if ($info->getAdditionalInformation($this->_isOrderPaymentActionKey)) {
             $orderTransaction = $this->getOrderTransaction($info);
             if ($orderTransaction) {
                 $info->setParentTransactionId($orderTransaction->getTxnId());
             }
         }
 
         return $this->_canVoid;
     }

◆ capture()

capture	(	\Magento\Payment\Model\InfoInterface	$payment,
			$amount
	)

Capture payment

Parameters

\Magento\Framework\DataObject \| \Magento\Payment\Model\InfoInterface \| Payment	$payment
float	$amount

Returns: $this @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 432 of file Express.php.

     {
         $authorizationTransaction = $payment->getAuthorizationTransaction();
         $authorizationPeriod = abs(intval($this->getConfigData('authorization_honor_period')));
         $maxAuthorizationNumber = abs(intval($this->getConfigData('child_authorization_number')));
         $order = $payment->getOrder();
         $isAuthorizationCreated = false;
 
         if ($payment->getAdditionalInformation($this->_isOrderPaymentActionKey)) {
             $voided = false;
             if (!$authorizationTransaction->getIsClosed() && $this->_isTransactionExpired(
                 $authorizationTransaction,
                 $authorizationPeriod
             )
             ) {
                 //Save payment state and configure payment object for voiding
                 $isCaptureFinal = $payment->getShouldCloseParentTransaction();
                 $payment->setShouldCloseParentTransaction(false);
                 $payment->setParentTransactionId($authorizationTransaction->getTxnId());
                 $payment->unsTransactionId();
                 $payment->setVoidOnlyAuthorization(true);
                 $payment->void(new \Magento\Framework\DataObject());
 
                 //Revert payment state after voiding
                 $payment->unsAuthorizationTransaction();
                 $payment->unsTransactionId();
                 $payment->setShouldCloseParentTransaction($isCaptureFinal);
                 $voided = true;
             }
 
             if ($authorizationTransaction->getIsClosed() || $voided) {
                 if ($payment->getAdditionalInformation($this->_authorizationCountKey) > $maxAuthorizationNumber - 1) {
                     $this->_exception->create(
                         ['phrase' => __('The maximum number of child authorizations is reached.')]
                     );
                 }
                 $api = $this->_callDoAuthorize($amount, $payment, $authorizationTransaction->getParentTxnId());
 
                 //Adding authorization transaction
                 $this->_pro->importPaymentInfo($api, $payment);
                 $payment->setTransactionId($api->getTransactionId());
                 $payment->setParentTransactionId($authorizationTransaction->getParentTxnId());
                 $payment->setIsTransactionClosed(false);
 
                 $formatedPrice = $order->getBaseCurrency()->formatTxt($amount);
 
                 if ($payment->getIsTransactionPending()) {
                     $message = __(
                         'We\'ll authorize the amount of %1 as soon as the payment gateway approves it.',
                         $formatedPrice
                     );
                 } else {
                     $message = __('The authorized amount is %1.', $formatedPrice);
                 }
 
                 $transaction = $this->transactionBuilder->setPayment($payment)
                     ->setOrder($order)
                     ->setTransactionId($payment->getTransactionId())
                     ->setFailSafe(true)
                     ->build(Transaction::TYPE_AUTH);
                 $payment->addTransactionCommentsToOrder($transaction, $message);
 
                 $payment->setParentTransactionId($api->getTransactionId());
                 $isAuthorizationCreated = true;
             }
             //close order transaction if needed
             if ($payment->getShouldCloseParentTransaction()) {
                 $orderTransaction = $this->getOrderTransaction($payment);
 
                 if ($orderTransaction) {
                     $orderTransaction->setIsClosed(true);
                     $order->addRelatedObject($orderTransaction);
                 }
             }
         }
 
         if (false === $this->_pro->capture($payment, $amount)) {
             $this->_placeOrder($payment, $amount);
         }
 
         if ($isAuthorizationCreated && isset($transaction)) {
             $transaction->setIsClosed(true);
         }
 
         return $this;
     }

◆ denyPayment()

denyPayment ( \Magento\Payment\Model\InfoInterface $payment )

Attempt to deny a pending payment

Parameters

\Magento\Payment\Model\InfoInterface | Payment $payment

Returns: bool

Definition at line 573 of file Express.php.

     {
         parent::denyPayment($payment);
         return $this->_pro->reviewPayment($payment, \Magento\Paypal\Model\Pro::PAYMENT_REVIEW_DENY);
     }

◆ fetchTransactionInfo()

fetchTransactionInfo	(	\Magento\Payment\Model\InfoInterface	$payment,
			$transactionId
	)

Fetch transaction details info

Parameters

\Magento\Payment\Model\InfoInterface	$payment
string	$transactionId

Returns: array

Definition at line 598 of file Express.php.

     {
         return $this->_pro->fetchTransactionInfo($payment, $transactionId);
     }

◆ getApi()

getApi ( )

Returns: Api\Nvp

Definition at line 606 of file Express.php.

     {
         return $this->_pro->getApi();
     }

◆ getCheckoutRedirectUrl()

getCheckoutRedirectUrl ( )

Checkout redirect URL getter for onepage checkout (hardcode)

See also: \Magento\Checkout\Controller\Onepage::savePaymentAction(); Quote\Payment::getCheckoutRedirectUrl()

Returns: string

Definition at line 586 of file Express.php.

     {
         return $this->_urlBuilder->getUrl('paypal/express/start');
     }

◆ getConfigData()

getConfigData	(	$field,
		$storeId = `null`
	)

Custom getter for payment configuration

Parameters

string	$field
int \| null	$storeId

Returns: mixed @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements MethodInterface.

Definition at line 353 of file Express.php.

     {
         if ('order_place_redirect_url' === $field) {
             return $this->getOrderPlaceRedirectUrl();
         }
         return $this->_pro->getConfig()->getValue($field);
     }

◆ getConfigPaymentAction()

getConfigPaymentAction ( )

Payment action getter compatible with payment model

See also: \Magento\Sales\Model\Payment::place()

Returns: string

Implements MethodInterface.

Definition at line 330 of file Express.php.

     {
         return $this->_pro->getConfig()->getPaymentAction();
     }

◆ getOrderTransaction()

getOrderTransaction ( $payment )

protected

Get transaction with type order

Parameters

OrderPaymentInterface $payment

Returns: false|\Magento\Sales\Api\Data\TransactionInterface

Definition at line 852 of file Express.php.

     {
         return $this->transactionRepository->getByTransactionType(
             Transaction::TYPE_ORDER,
             $payment->getId(),
             $payment->getOrder()->getId()
         );
     }

◆ isActive()

isActive ( $storeId = null )

Is active

Parameters

int | null $storeId

Returns: bool

Implements MethodInterface.

Definition at line 836 of file Express.php.

     {
         $pathStandardExpress = 'payment/' . Config::METHOD_WPS_EXPRESS . '/active';
         $pathPaypalExpress = 'payment/' . Config::METHOD_WPP_EXPRESS . '/active';
 
         return parent::isActive($storeId)
         || (bool)(int)$this->_scopeConfig->getValue($pathStandardExpress, ScopeInterface::SCOPE_STORE, $storeId)
         || (bool)(int)$this->_scopeConfig->getValue($pathPaypalExpress, ScopeInterface::SCOPE_STORE, $storeId);
     }

◆ isAvailable()

isAvailable ( \Magento\Quote\Api\Data\CartInterface $quote = null )

Check whether payment method can be used

Parameters

\Magento\Quote\Api\Data\CartInterface | Quote | null $quote

Returns: bool

Definition at line 340 of file Express.php.

     {
         return parent::isAvailable($quote) && $this->_pro->getConfig()->isMethodAvailable();
     }

◆ order()

order	(	\Magento\Payment\Model\InfoInterface	$payment,
			$amount
	)

Order payment

Parameters

\Magento\Framework\DataObject \| \Magento\Payment\Model\InfoInterface \| Payment	$payment
float	$amount

Returns: $this

Definition at line 368 of file Express.php.

     {
         $paypalTransactionData = $this->_checkoutSession->getPaypalTransactionData();
         if (!is_array($paypalTransactionData)) {
             $this->_placeOrder($payment, $amount);
         } else {
             $this->_importToPayment($this->_pro->getApi()->setData($paypalTransactionData), $payment);
         }
 
         $payment->setAdditionalInformation($this->_isOrderPaymentActionKey, true);
         if ($payment->getIsFraudDetected()) {
             return $this;
         }
 
         $payment->getOrder()->setActionFlag(Order::ACTION_FLAG_INVOICE, false);
 
         return $this;
     }

◆ refund()

refund	(	\Magento\Payment\Model\InfoInterface	$payment,
			$amount
	)

Refund capture

Parameters

\Magento\Framework\DataObject \| \Magento\Payment\Model\InfoInterface \| Payment	$payment
float	$amount

Returns: $this

Exceptions

Definition at line 527 of file Express.php.

     {
         $this->_pro->refund($payment, $amount);
         return $this;
     }

◆ setStore()

setStore ( $store )

Store setter Also updates store ID in config object

Parameters

\Magento\Store\Model\Store | int $store

Returns: $this

Implements MethodInterface.

Definition at line 283 of file Express.php.

     {
         $this->setData('store', $store);
         if (null === $store) {
             $store = $this->_storeManager->getStore()->getId();
         }
         $this->_pro->getConfig()->setStoreId(is_object($store) ? $store->getId() : $store);
         return $this;
     }

◆ void()

void ( \Magento\Payment\Model\InfoInterface $payment )

Void payment

Parameters

\Magento\Framework\DataObject | \Magento\Payment\Model\InfoInterface | Payment $payment

Returns: $this

Exceptions

Definition at line 406 of file Express.php.

     {
         //Switching to order transaction if needed
         if ($payment->getAdditionalInformation(
             $this->_isOrderPaymentActionKey
         ) && !$payment->getVoidOnlyAuthorization()
         ) {
             $orderTransaction = $this->getOrderTransaction($payment);
             if ($orderTransaction) {
                 $payment->setParentTransactionId($orderTransaction->getTxnId());
                 $payment->setTransactionId($orderTransaction->getTxnId() . '-void');
             }
         }
         $this->_pro->void($payment);
         return $this;
     }

Field Documentation

◆ $_authorizationCountKey

$_authorizationCountKey = 'authorization_count'

protected

Definition at line 145 of file Express.php.

◆ $_canAuthorize

$_canAuthorize = true

protected

Definition at line 61 of file Express.php.

◆ $_canCapture

$_canCapture = true

protected

Definition at line 68 of file Express.php.

◆ $_canCapturePartial

$_canCapturePartial = true

protected

Definition at line 75 of file Express.php.

◆ $_canFetchTransactionInfo

$_canFetchTransactionInfo = true

protected

Definition at line 117 of file Express.php.

◆ $_canOrder

$_canOrder = true

protected

Definition at line 54 of file Express.php.

◆ $_canRefund

$_canRefund = true

protected

Definition at line 82 of file Express.php.

◆ $_canRefundInvoicePartial

$_canRefundInvoicePartial = true

protected

Definition at line 89 of file Express.php.

◆ $_canReviewPayment

$_canReviewPayment = true

protected

Definition at line 124 of file Express.php.

◆ $_canUseCheckout

$_canUseCheckout = true

protected

Definition at line 110 of file Express.php.

◆ $_canUseInternal

$_canUseInternal = false

protected

Definition at line 103 of file Express.php.

◆ $_canVoid

$_canVoid = true

protected

Definition at line 96 of file Express.php.

◆ $_cartFactory

$_cartFactory

protected

Definition at line 160 of file Express.php.

◆ $_checkoutSession

$_checkoutSession

protected

Definition at line 165 of file Express.php.

◆ $_code

$_code = \Magento\Paypal\Model\Config::METHOD_WPP_EXPRESS

protected

Definition at line 30 of file Express.php.

◆ $_exception

$_exception

protected

Definition at line 170 of file Express.php.

◆ $_formBlockType

$_formBlockType = \Magento\Paypal\Block\Express\Form::class

protected

Definition at line 35 of file Express.php.

◆ $_infoBlockType

$_infoBlockType = \Magento\Paypal\Block\Payment\Info::class

protected

Definition at line 40 of file Express.php.

◆ $_isGateway

$_isGateway = false

protected

Definition at line 47 of file Express.php.

◆ $_isOrderPaymentActionKey

$_isOrderPaymentActionKey = 'is_order_action'

protected

Definition at line 138 of file Express.php.

◆ $_pro

$_pro

protected

Definition at line 131 of file Express.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 150 of file Express.php.

◆ $_urlBuilder

$_urlBuilder

protected

Definition at line 155 of file Express.php.

◆ $transactionBuilder

$transactionBuilder

protected

Definition at line 180 of file Express.php.

◆ $transactionRepository

$transactionRepository

protected

Definition at line 175 of file Express.php.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _callDoAuthorize()

◆ _importToPayment()

◆ _isTransactionExpired()

◆ _placeOrder()

◆ _setApiProcessableErrors()

◆ acceptPayment()

◆ assignData()

◆ authorize()

◆ canCapture()

◆ cancel()

◆ canReviewPayment()

◆ canUseCheckout()

◆ canUseForCurrency()

◆ canVoid()

◆ capture()

◆ denyPayment()

◆ fetchTransactionInfo()

◆ getApi()

◆ getCheckoutRedirectUrl()

◆ getConfigData()

◆ getConfigPaymentAction()

◆ getOrderTransaction()

◆ isActive()

◆ isAvailable()

◆ order()

◆ refund()

◆ setStore()

◆ void()

Field Documentation

◆ $_authorizationCountKey

◆ $_canAuthorize

◆ $_canCapture

◆ $_canCapturePartial

◆ $_canFetchTransactionInfo

◆ $_canOrder

◆ $_canRefund

◆ $_canRefundInvoicePartial

◆ $_canReviewPayment

◆ $_canUseCheckout

◆ $_canUseInternal

◆ $_canVoid

◆ $_cartFactory

◆ $_checkoutSession

◆ $_code

◆ $_exception

◆ $_formBlockType

◆ $_infoBlockType

◆ $_isGateway

◆ $_isOrderPaymentActionKey

◆ $_pro

◆ $_storeManager

◆ $_urlBuilder

◆ $transactionBuilder

◆ $transactionRepository