Inheritance diagram for Data:

Public Member Functions
	__construct (Context $context, StoreManagerInterface $storeManager, OrderFactory $orderFactory)

	getSaveOrderUrlParams ($controller)

	getRedirectIframeUrl ($params)

	getSuccessOrderUrl ($params)

	updateOrderEditIncrements (\Magento\Sales\Model\Order $order)

	convertMessagesToMessage ($messages)

	getTransactionMessage ( $payment, $requestType, $lastTransactionId, $card, $amount=false, $exception=false, $additionalMessage=false)

	getPaymentMethodsHtml (\Magento\Framework\App\ViewInterface $view)

	getRelayUrl ($storeId=null)

	getAllowedCurrencyCodes ()

	getFdsFilterActionLabel ($key)

	getTransactionStatusLabel ($key)

	wrapGatewayError ($text)

Public Member Functions inherited from AbstractHelper
	__construct (Context $context)

	isModuleOutputEnabled ($moduleName=null)

Protected Member Functions
	_getUrl ($route, $params=[])

	getOperation ($requestType)

	formatPrice ($payment, $amount)

Protected Member Functions inherited from AbstractHelper
	_getRequest ()

	_getModuleName ()

	_getUrl ($route, $params=[])

Protected Attributes
	$storeManager

	$orderFactory

	$allowedCurrencyCodes = ['USD']

	$transactionStatuses

	$fdsFilterActions

Protected Attributes inherited from AbstractHelper
	$_moduleName

	$_request

	$_moduleManager

	$_logger

	$_urlBuilder

	$_httpHeader

	$_eventManager

	$_remoteAddress

	$urlEncoder

	$urlDecoder

	$scopeConfig

	$_cacheConfig

Detailed Description

Authorize.net Data Helper

@api

Since: 100.0.2

Definition at line 21 of file Data.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	Context	$context,
		StoreManagerInterface	$storeManager,
		OrderFactory	$orderFactory
	)

Parameters

\Magento\Framework\App\Helper\Context	$context
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Sales\Model\OrderFactory	$orderFactory

Definition at line 74 of file Data.php.

       {
         $this->storeManager = $storeManager;
         $this->orderFactory = $orderFactory;
         parent::__construct($context);
     }

Member Function Documentation

◆ _getUrl()

_getUrl	(	$route,
		$params = `[]`
	)

protected

Set secure url checkout is secure for current store.

Parameters

string	$route
array	$params

Returns: string

Definition at line 91 of file Data.php.

     {
         $params['_type'] = \Magento\Framework\UrlInterface::URL_TYPE_LINK;
         if (isset($params['is_secure'])) {
             $params['_secure'] = (bool)$params['is_secure'];
         } elseif ($this->storeManager->getStore()->isCurrentlySecure()) {
             $params['_secure'] = true;
         }
         return parent::_getUrl($route, $params);
     }

◆ convertMessagesToMessage()

convertMessagesToMessage ( $messages )

Converts a lot of messages to message

Parameters

array $messages

Returns: string

Definition at line 183 of file Data.php.

     {
         return implode(' | ', $messages);
     }

◆ formatPrice()

formatPrice	(	$payment,
		$amount
	)

protected

Format price with currency sign

Parameters

\Magento\Payment\Model\InfoInterface	$payment
float	$amount

Returns: string

Definition at line 262 of file Data.php.

     {
         return $payment->getOrder()->getBaseCurrency()->formatTxt($amount);
     }

◆ getAllowedCurrencyCodes()

getAllowedCurrencyCodes ( )

Get allowed currencies

Returns: array

Definition at line 302 of file Data.php.

     {
         return $this->allowedCurrencyCodes;
     }

◆ getFdsFilterActionLabel()

getFdsFilterActionLabel ( $key )

Get translated filter action label

Parameters

string $key

Returns: \Magento\Framework\Phrase|string

Definition at line 313 of file Data.php.

     {
         return isset($this->fdsFilterActions[$key]) ? __($this->fdsFilterActions[$key]) : $key;
     }

◆ getOperation()

getOperation ( $requestType )

protected

Return operation name for request type

Parameters

string $requestType

Returns: \Magento\Framework\Phrase|bool

Definition at line 238 of file Data.php.

     {
         switch ($requestType) {
             case Authorizenet::REQUEST_TYPE_AUTH_ONLY:
                 return __('authorize');
             case Authorizenet::REQUEST_TYPE_AUTH_CAPTURE:
                 return __('authorize and capture');
             case Authorizenet::REQUEST_TYPE_PRIOR_AUTH_CAPTURE:
                 return __('capture');
             case Authorizenet::REQUEST_TYPE_CREDIT:
                 return __('refund');
             case Authorizenet::REQUEST_TYPE_VOID:
                 return __('void');
             default:
                 return false;
         }
     }

◆ getPaymentMethodsHtml()

getPaymentMethodsHtml ( \Magento\Framework\App\ViewInterface $view )

Get payment method step html

Parameters

\Magento\Framework\App\ViewInterface $view

Returns: string

Definition at line 273 of file Data.php.

     {
         $layout = $view->getLayout();
         $update = $layout->getUpdate();
         $update->load('checkout_onepage_paymentmethod');
         $layout->generateXml();
         $layout->generateElements();
         $output = $layout->getOutput();
         return $output;
     }

◆ getRedirectIframeUrl()

getRedirectIframeUrl ( $params )

Retrieve redirect iframe url

Parameters

array $params

Returns: string

Definition at line 138 of file Data.php.

     {
         return $this->_getUrl('authorizenet/directpost_payment/redirect', $params);
     }

◆ getRelayUrl()

getRelayUrl ( $storeId = null )

Get direct post relay url

Parameters

null | int | string $storeId

Returns: string

Definition at line 290 of file Data.php.

     {
         $baseUrl = $this->storeManager->getStore($storeId)
             ->getBaseUrl(\Magento\Framework\UrlInterface::URL_TYPE_LINK);
         return $baseUrl . 'authorizenet/directpost_payment/response';
     }

◆ getSaveOrderUrlParams()

getSaveOrderUrlParams ( $controller )

Retrieve save order url params

Parameters

string $controller

Returns: array

Definition at line 108 of file Data.php.

     {
         $route = [];
         switch ($controller) {
             case 'onepage':
                 $route['action'] = 'saveOrder';
                 $route['controller'] = 'onepage';
                 $route['module'] = 'checkout';
                 break;
 
             case 'sales_order_create':
             case 'sales_order_edit':
                 $route['action'] = 'save';
                 $route['controller'] = 'sales_order_create';
                 $route['module'] = 'admin';
                 break;
 
             default:
                 break;
         }
 
         return $route;
     }

◆ getSuccessOrderUrl()

getSuccessOrderUrl ( $params )

Retrieve place order url

Parameters

array $params

Returns: string

Definition at line 149 of file Data.php.

     {
         return $this->_getUrl('checkout/onepage/success', $params);
     }

◆ getTransactionMessage()

getTransactionMessage	(	$payment,
		$requestType,
		$lastTransactionId,
		$card,
		$amount = `false`,
		$exception = `false`,
		$additionalMessage = `false`
	)

Return message for gateway transaction request

Parameters

\Magento\Payment\Model\InfoInterface	$payment
string	$requestType
string	$lastTransactionId
\Magento\Framework\DataObject	$card
bool \| float	$amount
bool \| string	$exception
bool \| string	$additionalMessage

Returns: bool|string

Definition at line 200 of file Data.php.

       {
         $message[] = __('Credit Card: xxxx-%1', $card->getCcLast4());
         if ($amount) {
             $message[] = __('amount %1', $this->formatPrice($payment, $amount));
         }
         $operation = $this->getOperation($requestType);
         if (!$operation) {
             return false;
         } else {
             $message[] = $operation;
         }
         $message[] = ($exception) ? '- ' . __('failed.') : '- ' . __('successful.');
         if ($lastTransactionId !== null) {
             $message[] = __('Authorize.Net Transaction ID %1.', $lastTransactionId);
         }
         if ($additionalMessage) {
             $message[] = $additionalMessage;
         }
         if ($exception) {
             $message[] = $exception;
         }
         return implode(' ', $message);
     }

◆ getTransactionStatusLabel()

getTransactionStatusLabel ( $key )

Get translated transaction status label

Parameters

string $key

Returns: \Magento\Framework\Phrase|string

Definition at line 324 of file Data.php.

     {
         return isset($this->transactionStatuses[$key]) ? __($this->transactionStatuses[$key]) : $key;
     }

◆ updateOrderEditIncrements()

updateOrderEditIncrements ( \Magento\Sales\Model\Order $order )

Update all child and parent order's edit increment numbers. Needed for Admin area.

Parameters

\Magento\Sales\Model\Order $order

Returns: void

Definition at line 161 of file Data.php.

     {
         if ($order->getId() && $order->getOriginalIncrementId()) {
             $collection = $order->getCollection();
             $quotedIncrId = $collection->getConnection()->quote($order->getOriginalIncrementId());
             $collection->getSelect()->where(
                 "original_increment_id = {$quotedIncrId} OR increment_id = {$quotedIncrId}"
             );
 
             foreach ($collection as $orderToUpdate) {
                 $orderToUpdate->setEditIncrement($order->getEditIncrement());
                 $orderToUpdate->save();
             }
         }
     }

◆ wrapGatewayError()

wrapGatewayError ( $text )

Gateway error response wrapper

Parameters

string $text

Returns: \Magento\Framework\Phrase

Definition at line 335 of file Data.php.

     {
         return __('Gateway error: %1', $text);
     }

Field Documentation

◆ $allowedCurrencyCodes

$allowedCurrencyCodes = ['USD']

protected

Definition at line 38 of file Data.php.

◆ $fdsFilterActions

$fdsFilterActions

protected

Initial value:

= [
        'decline ' => 'Decline',
        'hold' => 'Hold',
        'authAndHold' => 'Authorize and Hold',
        'report' => 'Report Only'
    ]

Definition at line 62 of file Data.php.

◆ $orderFactory

$orderFactory

protected

Definition at line 31 of file Data.php.

◆ $storeManager

$storeManager

protected

Definition at line 26 of file Data.php.

◆ $transactionStatuses

$transactionStatuses

protected

Initial value:

= [
        'authorizedPendingCapture' => 'Authorized/Pending Capture',
        'capturedPendingSettlement' => 'Captured/Pending Settlement',
        'refundSettledSuccessfully' => 'Refund/Settled Successfully',
        'refundPendingSettlement' => 'Refund/Pending Settlement',
        'declined' => 'Declined',
        'expired' => 'Expired',
        'voided' => 'Voided',
        'FDSPendingReview' => 'FDS - Pending Review',
        'FDSAuthorizedPendingReview' => 'FDS - Authorized/Pending Review'
    ]

Definition at line 45 of file Data.php.

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

vendor/magento/module-authorizenet/Helper/Data.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getUrl()

◆ convertMessagesToMessage()

◆ formatPrice()

◆ getAllowedCurrencyCodes()

◆ getFdsFilterActionLabel()

◆ getOperation()

◆ getPaymentMethodsHtml()

◆ getRedirectIframeUrl()

◆ getRelayUrl()

◆ getSaveOrderUrlParams()

◆ getSuccessOrderUrl()

◆ getTransactionMessage()

◆ getTransactionStatusLabel()

◆ updateOrderEditIncrements()

◆ wrapGatewayError()

Field Documentation

◆ $allowedCurrencyCodes

◆ $fdsFilterActions

◆ $orderFactory

◆ $storeManager

◆ $transactionStatuses