Inheritance diagram for Direct:

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, \Magento\Framework\Module\ModuleListInterface $moduleList, \Magento\Framework\Stdlib\DateTime\TimezoneInterface $localeDate, \Magento\Paypal\Model\ProFactory $proFactory, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Framework\UrlInterface $urlBuilder, \Magento\Framework\App\RequestInterface $requestHttp, \Magento\Paypal\Model\CartFactory $cartFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])

	setStore ($store)

	canUseForCurrency ($currencyCode)

	getConfigPaymentAction ()

	getAllowedCcTypes ()

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

	getConfigData ($field, $storeId=null)

	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)

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

	canVoid ()

Protected Member Functions
	_placeOrder (Payment $payment, $amount)

	_getFormattedCcExpirationDate ($month, $year)

	_importResultToPayment ($api, $payment)

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

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

	$_isGateway = true

	$_canAuthorize = true

	$_canCapture = true

	$_canCapturePartial = true

	$_canRefund = true

	$_canRefundInvoicePartial = true

	$_canVoid = true

	$_canUseInternal = true

	$_canUseCheckout = true

	$_canSaveCc = false

	$_canFetchTransactionInfo = true

	$_canReviewPayment = true

	$_pro

	$_storeManager

	$_urlBuilder

	$_requestHttp

	$_cartFactory

Detailed Description

PayPal Direct Module @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 16 of file Direct.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,
		\Magento\Framework\Module\ModuleListInterface	$moduleList,
		\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate,
		\Magento\Paypal\Model\ProFactory	$proFactory,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Framework\UrlInterface	$urlBuilder,
		\Magento\Framework\App\RequestInterface	$requestHttp,
		\Magento\Paypal\Model\CartFactory	$cartFactory,
		\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
\Magento\Framework\Module\ModuleListInterface	$moduleList
\Magento\Framework\Stdlib\DateTime\TimezoneInterface	$localeDate
ProFactory	$proFactory
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Framework\UrlInterface	$urlBuilder
\Magento\Framework\App\RequestInterface	$requestHttp
CartFactory	$cartFactory
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 157 of file Direct.php.

       {
         parent::__construct(
             $context,
             $registry,
             $extensionFactory,
             $customAttributeFactory,
             $paymentData,
             $scopeConfig,
             $logger,
             $moduleList,
             $localeDate,
             $resource,
             $resourceCollection,
             $data
         );
         $this->_storeManager = $storeManager;
         $this->_urlBuilder = $urlBuilder;
         $this->_requestHttp = $requestHttp;
         $this->_cartFactory = $cartFactory;
 
         $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);
     }

Member Function Documentation

◆ _getFormattedCcExpirationDate()

_getFormattedCcExpirationDate	(	$month,
		$year
	)

protected

Format credit card expiration date based on month and year values Format: mmyyyy

Parameters

string \| int	$month
string \| int	$year

Returns: string

Definition at line 477 of file Direct.php.

     {
         return sprintf('%02d%02d', $month, $year);
     }

◆ _importResultToPayment()

_importResultToPayment	(	$api,
		$payment
	)

protected

Import direct payment results to payment

Parameters

\Magento\Paypal\Model\Api\Nvp	$api
Payment	$payment

Returns: void

Definition at line 489 of file Direct.php.

     {
         $payment->setTransactionId($api->getTransactionId())->setIsTransactionClosed(0);
         $this->_pro->importPaymentInfo($api, $payment);
     }

◆ _placeOrder()

_placeOrder	(	Payment	$payment,
			$amount
	)

protected

Place an order with authorization or capture action

Parameters

Payment	$payment
float	$amount

Returns: $this

Definition at line 415 of file Direct.php.

     {
         $order = $payment->getOrder();
         $api = $this->_pro->getApi()->setPaymentAction(
             $this->_pro->getConfig()->getValue('paymentAction')
         )->setIpAddress(
             $this->_requestHttp->getClientIp(false)
         )->setAmount(
             $amount
         )->setCurrencyCode(
             $order->getBaseCurrencyCode()
         )->setInvNum(
             $order->getIncrementId()
         )->setEmail(
             $order->getCustomerEmail()
         )->setNotifyUrl(
             $this->_urlBuilder->getUrl('paypal/ipn/')
         )->setCreditCardType(
             $payment->getCcType()
         )->setCreditCardNumber(
             $payment->getCcNumber()
         )->setCreditCardExpirationDate(
             $this->_getFormattedCcExpirationDate($payment->getCcExpMonth(), $payment->getCcExpYear())
         )->setCreditCardCvv2(
             $payment->getCcCid()
         );
 
         // add shipping and billing addresses
         if ($order->getIsVirtual()) {
             $api->setAddress($order->getBillingAddress())->setSuppressShipping(true);
         } else {
             $api->setAddress($order->getShippingAddress());
             $api->setBillingAddress($order->getBillingAddress());
         }
 
         // add line items
         $cart = $this->_cartFactory->create(['salesModel' => $order]);
 
         $api->setPaypalCart($cart)->setIsLineItemsEnabled($this->_pro->getConfig()->getValue('lineItemsEnabled'));
 
         // call api and import transaction and other payment information
         $api->callDoDirectPayment();
         $this->_importResultToPayment($api, $payment);
 
         try {
             $api->callGetTransactionDetails();
         } catch (\Magento\Framework\Exception\LocalizedException $e) {
             // if we receive errors, but DoDirectPayment response is Success, then set Pending status for transaction
             $payment->setIsTransactionPending(true);
         }
         $this->_importResultToPayment($api, $payment);
         return $this;
     }

◆ 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 378 of file Direct.php.

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

◆ 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 303 of file Direct.php.

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

◆ cancel()

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

Cancel payment

Parameters

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

Returns: $this

Definition at line 356 of file Direct.php.

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

◆ canReviewPayment()

canReviewPayment ( )

Whether payment can be reviewed

Returns: bool

Definition at line 367 of file Direct.php.

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

◆ canUseForCurrency()

canUseForCurrency ( $currencyCode )

Whether method is available for specified currency

Parameters

string $currencyCode

Returns: bool

Definition at line 227 of file Direct.php.

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

◆ canVoid()

canVoid ( )

Check void availability

Returns: bool

Definition at line 500 of file Direct.php.

     {
         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

Definition at line 328 of file Direct.php.

     {
         if (false === $this->_pro->capture($payment, $amount)) {
             $this->_placeOrder($payment, $amount);
         }
         return $this;
     }

◆ denyPayment()

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

Attempt to deny a pending payment

Parameters

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

Returns: bool

Definition at line 390 of file Direct.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 403 of file Direct.php.

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

◆ getAllowedCcTypes()

getAllowedCcTypes ( )

Return available CC types for gateway based on merchant country

Returns: string

Definition at line 248 of file Direct.php.

     {
         $ccTypes = explode(',', $this->_pro->getConfig()->getValue('cctypes'));
         $country = $this->_pro->getConfig()->getMerchantCountry();
 
         if ($country == 'GB') {
             $ccTypes = array_intersect(['SM', 'SO', 'MC', 'DI', 'VI'], $ccTypes);
         } elseif ($country == 'CA') {
             $ccTypes = array_intersect(['MC', 'VI'], $ccTypes);
         }
         return implode(',', $ccTypes);
     }

◆ getConfigData()

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

Custom getter for payment configuration

Parameters

string	$field
int \| null	$storeId

Returns: null|string @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 280 of file Direct.php.

     {
         $value = null;
         switch ($field) {
             case 'cctypes':
                 $value = $this->getAllowedCcTypes();
                 break;
             case 'order_place_redirect_url':
                 $value = $this->getOrderPlaceRedirectUrl();
                 break;
             default:
                 $value = $this->_pro->getConfig()->getValue($field);
         }
         return $value;
     }

◆ getConfigPaymentAction()

getConfigPaymentAction ( )

Payment action getter compatible with payment model

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

Returns: string

Definition at line 238 of file Direct.php.

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

◆ isAvailable()

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

Check whether payment method can be used

Parameters

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

Returns: bool

Definition at line 267 of file Direct.php.

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

◆ 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 344 of file Direct.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

Definition at line 211 of file Direct.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 315 of file Direct.php.

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

Field Documentation

◆ $_canAuthorize

$_canAuthorize = true

protected

Definition at line 40 of file Direct.php.

◆ $_canCapture

$_canCapture = true

protected

Definition at line 47 of file Direct.php.

◆ $_canCapturePartial

$_canCapturePartial = true

protected

Definition at line 54 of file Direct.php.

◆ $_canFetchTransactionInfo

$_canFetchTransactionInfo = true

protected

Definition at line 101 of file Direct.php.

◆ $_canRefund

$_canRefund = true

protected

Definition at line 61 of file Direct.php.

◆ $_canRefundInvoicePartial

$_canRefundInvoicePartial = true

protected

Definition at line 68 of file Direct.php.

◆ $_canReviewPayment

$_canReviewPayment = true

protected

Definition at line 108 of file Direct.php.

◆ $_canSaveCc

$_canSaveCc = false

protected

Definition at line 96 of file Direct.php.

◆ $_canUseCheckout

$_canUseCheckout = true

protected

Definition at line 89 of file Direct.php.

◆ $_canUseInternal

$_canUseInternal = true

protected

Definition at line 82 of file Direct.php.

◆ $_canVoid

$_canVoid = true

protected

Definition at line 75 of file Direct.php.

◆ $_cartFactory

$_cartFactory

protected

Definition at line 135 of file Direct.php.

◆ $_code

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

protected

Definition at line 21 of file Direct.php.

◆ $_infoBlockType

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

protected

Definition at line 26 of file Direct.php.

◆ $_isGateway

$_isGateway = true

protected

Definition at line 33 of file Direct.php.

◆ $_pro

$_pro

protected

Definition at line 115 of file Direct.php.

◆ $_requestHttp

$_requestHttp

protected

Definition at line 130 of file Direct.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 120 of file Direct.php.

◆ $_urlBuilder

$_urlBuilder

protected

Definition at line 125 of file Direct.php.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getFormattedCcExpirationDate()

◆ _importResultToPayment()

◆ _placeOrder()

◆ acceptPayment()

◆ authorize()

◆ cancel()

◆ canReviewPayment()

◆ canUseForCurrency()

◆ canVoid()

◆ capture()

◆ denyPayment()

◆ fetchTransactionInfo()

◆ getAllowedCcTypes()

◆ getConfigData()

◆ getConfigPaymentAction()

◆ isAvailable()

◆ refund()

◆ setStore()

◆ void()

Field Documentation

◆ $_canAuthorize

◆ $_canCapture

◆ $_canCapturePartial

◆ $_canFetchTransactionInfo

◆ $_canRefund

◆ $_canRefundInvoicePartial

◆ $_canReviewPayment

◆ $_canSaveCc

◆ $_canUseCheckout

◆ $_canUseInternal

◆ $_canVoid

◆ $_cartFactory

◆ $_code

◆ $_infoBlockType

◆ $_isGateway

◆ $_pro

◆ $_requestHttp

◆ $_storeManager

◆ $_urlBuilder