Adapter Class Reference

Inheritance diagram for Adapter:

Public Member Functions
	__construct (ManagerInterface $eventManager, ValueHandlerPoolInterface $valueHandlerPool, PaymentDataObjectFactory $paymentDataObjectFactory, $code, $formBlockType, $infoBlockType, CommandPoolInterface $commandPool=null, ValidatorPoolInterface $validatorPool=null, CommandManagerInterface $commandExecutor=null, LoggerInterface $logger=null)
	getValidatorPool ()
	canOrder ()
	canAuthorize ()
	canCapture ()
	canCapturePartial ()
	canCaptureOnce ()
	canRefund ()
	canRefundPartialPerInvoice ()
	canVoid ()
	canUseInternal ()
	canUseCheckout ()
	canEdit ()
	canFetchTransactionInfo ()
	canReviewPayment ()
	isGateway ()
	isOffline ()
	isInitializeNeeded ()
	isAvailable (CartInterface $quote=null)
	isActive ($storeId=null)
	canUseForCountry ($country)
	canUseForCurrency ($currencyCode)
	getConfigData ($field, $storeId=null)
	validate ()
	fetchTransactionInfo (InfoInterface $payment, $transactionId)
	order (InfoInterface $payment, $amount)
	authorize (InfoInterface $payment, $amount)
	capture (InfoInterface $payment, $amount)
	refund (InfoInterface $payment, $amount)
	cancel (InfoInterface $payment)
	void (InfoInterface $payment)
	acceptPayment (InfoInterface $payment)
	denyPayment (InfoInterface $payment)
	getCode ()
	getTitle ()
	setStore ($storeId)
	getStore ()
	getFormBlockType ()
	getInfoBlockType ()
	getInfoInstance ()
	setInfoInstance (InfoInterface $info)
	assignData (\Magento\Framework\DataObject $data)
	initialize ($paymentAction, $stateObject)
	getConfigPaymentAction ()
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)

Additional Inherited Members
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'

Detailed Description

Payment method facade. Abstract method adapter

@SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.CouplingBetweenObjects)

@api Use this class as a base for virtual types declaration

Since

100.0.2

Definition at line 33 of file Adapter.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ManagerInterface	$eventManager,
		ValueHandlerPoolInterface	$valueHandlerPool,
		PaymentDataObjectFactory	$paymentDataObjectFactory,
			$code,
			$formBlockType,
			$infoBlockType,
		CommandPoolInterface	$commandPool = null,
		ValidatorPoolInterface	$validatorPool = null,
		CommandManagerInterface	$commandExecutor = null,
		LoggerInterface	$logger = null
	)

Parameters

ManagerInterface	$eventManager
ValueHandlerPoolInterface	$valueHandlerPool
PaymentDataObjectFactory	$paymentDataObjectFactory
string	$code
string	$formBlockType
string	$infoBlockType
CommandPoolInterface | null	$commandPool
ValidatorPoolInterface | null	$validatorPool
CommandManagerInterface | null	$commandExecutor
LoggerInterface | null	$logger	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 110 of file Adapter.php.

      {
        $this->valueHandlerPool = $valueHandlerPool;
        $this->validatorPool = $validatorPool;
        $this->commandPool = $commandPool;
        $this->code = $code;
        $this->infoBlockType = $infoBlockType;
        $this->formBlockType = $formBlockType;
        $this->eventManager = $eventManager;
        $this->paymentDataObjectFactory = $paymentDataObjectFactory;
        $this->commandExecutor = $commandExecutor;
        $this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
    }

Member Function Documentation

acceptPayment()

acceptPayment

(

InfoInterface

$payment

)

Attempt to accept a payment that us under review

Parameters

InfoInterface

$payment

Returns

false

Exceptions

Implements MethodInterface.

Definition at line 504 of file Adapter.php.

    {
        $this->executeCommand('accept_payment', ['payment' => $payment]);

        return $this;
    }

assignData()

assignData

(

\Magento\Framework\DataObject

$data

)

Parameters

DataObject

$data

Returns

$this

Definition at line 619 of file Adapter.php.

    {
        $this->eventManager->dispatch(
            'payment_method_assign_data_' . $this->getCode(),
            [
                AbstractDataAssignObserver::METHOD_CODE => $this,
                AbstractDataAssignObserver::MODEL_CODE => $this->getInfoInstance(),
                AbstractDataAssignObserver::DATA_CODE => $data
            ]
        );

        $this->eventManager->dispatch(
            'payment_method_assign_data',
            [
                AbstractDataAssignObserver::METHOD_CODE => $this,
                AbstractDataAssignObserver::MODEL_CODE => $this->getInfoInstance(),
                AbstractDataAssignObserver::DATA_CODE => $data
            ]
        );

        return $this;
    }

authorize()

authorize	(	InfoInterface	$payment,
			$amount
	)

Definition at line 445 of file Adapter.php.

    {
        $this->executeCommand(
            'authorize',
            ['payment' => $payment, 'amount' => $amount]
        );

        return $this;
    }

canAuthorize()

canAuthorize

(

)

Check authorize availability

Returns

bool

Implements MethodInterface.

Definition at line 159 of file Adapter.php.

    {
        return $this->canPerformCommand('authorize');
    }

canCapture()

canCapture

(

)

Check capture availability

Returns

bool

Implements MethodInterface.

Definition at line 167 of file Adapter.php.

    {
        return $this->canPerformCommand('capture');
    }

canCaptureOnce()

canCaptureOnce

(

)

Check whether capture can be performed once and no further capture possible

Returns

bool

Implements MethodInterface.

Definition at line 183 of file Adapter.php.

    {
        return $this->canPerformCommand('capture_once');
    }

canCapturePartial()

canCapturePartial

(

)

Check partial capture availability

Returns

bool

Implements MethodInterface.

Definition at line 175 of file Adapter.php.

    {
        return $this->canPerformCommand('capture_partial');
    }

cancel()

cancel

(

InfoInterface

$payment

)

Definition at line 484 of file Adapter.php.

    {
        $this->executeCommand('cancel', ['payment' => $payment]);

        return $this;
    }

canEdit()

canEdit

(

)

Can be edit order (renew order)

Returns

bool

Implements MethodInterface.

Definition at line 231 of file Adapter.php.

    {
        return (bool)$this->getConfiguredValue('can_edit');
    }

canFetchTransactionInfo()

canFetchTransactionInfo

(

)

Check fetch transaction info availability

Returns

bool

Implements MethodInterface.

Definition at line 239 of file Adapter.php.

    {
        return $this->canPerformCommand('fetch_transaction_info');
    }

canOrder()

canOrder

(

)

Check order availability

Returns

bool

Implements MethodInterface.

Definition at line 151 of file Adapter.php.

    {
        return $this->canPerformCommand('order');
    }

canRefund()

canRefund

(

)

Check refund availability

Returns

bool

Implements MethodInterface.

Definition at line 191 of file Adapter.php.

    {
        return $this->canPerformCommand('refund');
    }

canRefundPartialPerInvoice()

canRefundPartialPerInvoice

(

)

Check partial refund availability for invoice

Returns

bool

Implements MethodInterface.

Definition at line 199 of file Adapter.php.

    {
        return $this->canPerformCommand('refund_partial_per_invoice');
    }

canReviewPayment()

canReviewPayment

(

)

Whether this method can accept or deny payment

Returns

bool

Implements MethodInterface.

Definition at line 247 of file Adapter.php.

    {
        return $this->canPerformCommand('review_payment');
    }

canUseCheckout()

canUseCheckout

(

)

Can be used in regular checkout

Returns

bool

Implements MethodInterface.

Definition at line 223 of file Adapter.php.

    {
        return (bool)$this->getConfiguredValue('can_use_checkout');
    }

canUseForCountry()

canUseForCountry

(

$country

)

To check billing country is allowed for the payment method

Parameters

string

$country

Returns

bool

Implements MethodInterface.

Definition at line 327 of file Adapter.php.

    {
        try {
            $validator = $this->getValidatorPool()->get('country');
        } catch (\Exception $e) {
            return true;
        }

        $result = $validator->validate(['country' => $country, 'storeId' => $this->getStore()]);
        return $result->isValid();
    }

canUseForCurrency()

canUseForCurrency

(

$currencyCode

)

Check method for processing with base currency

Parameters

string

$currencyCode

Returns

bool @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements MethodInterface.

Definition at line 342 of file Adapter.php.

    {
        try {
            $validator = $this->getValidatorPool()->get('currency');
        } catch (\Exception $e) {
            return true;
        }

        $result = $validator->validate(['currency' => $currencyCode, 'storeId' => $this->getStore()]);
        return $result->isValid();
    }

canUseInternal()

canUseInternal

(

)

Using internal pages for input payment data Can be used in admin

Returns

bool

Implements MethodInterface.

Definition at line 215 of file Adapter.php.

    {
        return (bool)$this->getConfiguredValue('can_use_internal');
    }

canVoid()

canVoid

(

)

Check void availability

Returns

bool

Implements MethodInterface.

Definition at line 207 of file Adapter.php.

    {
        return $this->canPerformCommand('void');
    }

capture()

capture	(	InfoInterface	$payment,
			$amount
	)

Definition at line 458 of file Adapter.php.

    {
        $this->executeCommand(
            'capture',
            ['payment' => $payment, 'amount' => $amount]
        );

        return $this;
    }

denyPayment()

denyPayment

(

InfoInterface

$payment

)

Attempt to deny a payment that us under review

Parameters

InfoInterface

$payment

Returns

false

Exceptions

Implements MethodInterface.

Definition at line 514 of file Adapter.php.

    {
        $this->executeCommand('deny_payment', ['payment' => $payment]);

        return $this;
    }

fetchTransactionInfo()

fetchTransactionInfo	(	InfoInterface	$payment,
			$transactionId
	)

Fetch transaction info

Parameters

InfoInterface	$payment
string	$transactionId

Returns

array @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements MethodInterface.

Definition at line 421 of file Adapter.php.

    {
        return $this->executeCommand(
            'fetch_transaction_information',
            ['payment' => $payment, 'transactionId' => $transactionId]
        );
    }

getCode()

getCode

(

)

Retrieve payment method code

Returns

string

Implements MethodInterface.

Definition at line 553 of file Adapter.php.

    {
        return $this->code;
    }

getConfigData()

getConfigData	(		$field,
			$storeId = null
	)

Retrieve information from payment configuration

Parameters

string	$field
int | string | null | \Magento\Store\Model\Store	$storeId

Returns

mixed

Implements MethodInterface.

Definition at line 389 of file Adapter.php.

    {
        return $this->getConfiguredValue($field, $storeId);
    }

getConfigPaymentAction()

getConfigPaymentAction

(

)

Get config payment action url Used to universalize payment actions when processing payment place

Returns

string

Implements MethodInterface.

Definition at line 662 of file Adapter.php.

    {
        return $this->getConfiguredValue('payment_action');
    }

getFormBlockType()

getFormBlockType

(

)

Retrieve block type for method form generation

Returns

string

Deprecated:

100.0.2

Implements MethodInterface.

Definition at line 585 of file Adapter.php.

    {
        return $this->formBlockType;
    }

getInfoBlockType()

getInfoBlockType

(

)

Retrieve block type for display method information

Returns

string

Deprecated:

100.0.2

Implements MethodInterface.

Definition at line 593 of file Adapter.php.

    {
        return $this->infoBlockType;
    }

getInfoInstance()

getInfoInstance

(

)

Retrieve payment information model object

Returns

InfoInterface

Exceptions

Implements MethodInterface.

Definition at line 601 of file Adapter.php.

    {
        return $this->infoInstance;
    }

getStore()

getStore

(

)

Store id getter

Returns

int

Implements MethodInterface.

Definition at line 577 of file Adapter.php.

    {
        return $this->storeId;
    }

getTitle()

getTitle

(

)

Retrieve payment method title

Returns

string

Implements MethodInterface.

Definition at line 561 of file Adapter.php.

    {
        return $this->getConfiguredValue('title');
    }

getValidatorPool()

getValidatorPool

(

)

Returns Validator pool

Returns

ValidatorPoolInterface

Exceptions

Definition at line 140 of file Adapter.php.

    {
        if ($this->validatorPool === null) {
            throw new \DomainException('Validator pool is not configured for use.');
        }
        return $this->validatorPool;
    }

initialize()

initialize	(		$paymentAction,
			$stateObject
	)

Method that will be executed instead of authorize or capture if flag isInitializeNeeded set to true

Parameters

string	$paymentAction
object	$stateObject

Returns

$this @SuppressWarnings(PHPMD.UnusedFormalParameter)

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements MethodInterface.

Definition at line 646 of file Adapter.php.

    {
        $this->executeCommand(
            'initialize',
            [
                'payment' => $this->getInfoInstance(),
                'paymentAction' => $paymentAction,
                'stateObject' => $stateObject
            ]
        );
        return $this;
    }

isActive()

isActive

(

$storeId = null

)

Is active

Parameters

int | null

$storeId

Returns

bool

Implements MethodInterface.

Definition at line 319 of file Adapter.php.

    {
        return (bool)$this->getConfiguredValue('active', $storeId);
    }

isAvailable()

isAvailable

(

CartInterface

$quote = null

)

Check whether payment method can be used

Parameters

CartInterface | null

$quote

Returns

bool

Implements MethodInterface.

Definition at line 279 of file Adapter.php.

    {
        if (!$this->isActive($quote ? $quote->getStoreId() : null)) {
            return false;
        }

        $checkResult = new DataObject();
        $checkResult->setData('is_available', true);
        try {
            $infoInstance = $this->getInfoInstance();
            if ($infoInstance !== null) {
                $validator = $this->getValidatorPool()->get('availability');
                $result = $validator->validate(
                    [
                        'payment' => $this->paymentDataObjectFactory->create($infoInstance)
                    ]
                );

                $checkResult->setData('is_available', $result->isValid());
            }
        } catch (\Exception $e) {
            // pass
        }

        // for future use in observers
        $this->eventManager->dispatch(
            'payment_method_is_active',
            [
                'result' => $checkResult,
                'method_instance' => $this,
                'quote' => $quote
            ]
        );

        return $checkResult->getData('is_available');
    }

isGateway()

isGateway

(

)

Retrieve payment system relation flag

Returns

bool

Implements MethodInterface.

Definition at line 255 of file Adapter.php.

    {
        return (bool)$this->getConfiguredValue('is_gateway');
    }

isInitializeNeeded()

isInitializeNeeded

(

)

Flag if we need to run payment initialize while order place

Returns

bool

Implements MethodInterface.

Definition at line 271 of file Adapter.php.

    {
        return (bool)(int)$this->getConfiguredValue('can_initialize');
    }

isOffline()

isOffline

(

)

Retrieve payment method online/offline flag

Returns

bool

Implements MethodInterface.

Definition at line 263 of file Adapter.php.

    {
        return (bool)$this->getConfiguredValue('is_offline');
    }

order()

order	(	InfoInterface	$payment,
			$amount
	)

Definition at line 432 of file Adapter.php.

    {
        $this->executeCommand(
            'order',
            ['payment' => $payment, 'amount' => $amount]
        );

        return $this;
    }

refund()

refund	(	InfoInterface	$payment,
			$amount
	)

Definition at line 471 of file Adapter.php.

    {
        $this->executeCommand(
            'refund',
            ['payment' => $payment, 'amount' => $amount]
        );

        return $this;
    }

setInfoInstance()

setInfoInstance

(

InfoInterface

$info

)

Retrieve payment information model object

Parameters

InfoInterface

$info

Returns

void

Deprecated:

100.0.2

Implements MethodInterface.

Definition at line 609 of file Adapter.php.

    {
        $this->infoInstance = $info;
    }

setStore()

setStore

(

$storeId

)

Store id setter

Parameters

int

$storeId

Returns

void

Implements MethodInterface.

Definition at line 569 of file Adapter.php.

    {
        $this->storeId = (int)$storeId;
    }

validate()

validate

(

)

Validate payment method information object

Returns

$this

Exceptions

Implements MethodInterface.

Definition at line 397 of file Adapter.php.

    {
        try {
            $validator = $this->getValidatorPool()->get('global');
        } catch (\Exception $e) {
            return $this;
        }

        $result = $validator->validate(
            ['payment' => $this->getInfoInstance(), 'storeId' => $this->getStore()]
        );

        if (!$result->isValid()) {
            throw new LocalizedException(
                __(implode("\n", $result->getFailsDescription()))
            );
        }

        return $this;
    }

void()

void

(

InfoInterface

$payment

)

Definition at line 494 of file Adapter.php.

    {
        $this->executeCommand('void', ['payment' => $payment]);

        return $this;
    }

---

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

• vendor/magento/module-payment/Model/Method/Adapter.php