Inheritance diagram for AbstractConfig:

Public Member Functions
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig)

	setMethodInstance ($method)

	setMethod ($method)

	getMethodCode ()

	setStoreId ($storeId)

	getValue ($key, $storeId=null)

	setMethodCode ($methodCode)

	setPathPattern ($pathPattern)

	shouldUseUnilateralPayments ()

	isWppApiAvailabe ()

	isMethodAvailable ($methodCode=null)

	isMethodActive ($method)

	isMethodSupportedForCountry ($method=null, $countryCode=null)

	getBuildNotationCode ()

Data Fields
const	PAYMENT_ACTION_SALE = 'Sale'

const	PAYMENT_ACTION_AUTH = 'Authorization'

const	PAYMENT_ACTION_ORDER = 'Order'

const	METHOD_WPP_EXPRESS = 'paypal_express'

Protected Member Functions
	_getSpecificConfigPath ($fieldName)

	_prepareValue ($key, $value)

	getProductMetadata ()

Protected Attributes
	$_methodCode

	$_storeId

	$pathPattern

	$productMetadata

	$_scopeConfig

	$methodInstance

Detailed Description

Class AbstractConfig

Definition at line 18 of file AbstractConfig.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig )

Parameters

\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig

Definition at line 72 of file AbstractConfig.php.

       {
         $this->_scopeConfig = $scopeConfig;
     }

Member Function Documentation

◆ _getSpecificConfigPath()

_getSpecificConfigPath ( $fieldName )

protected

Map any supported payment method into a config path by specified field name

Parameters

string $fieldName

Returns: string|null

Definition at line 191 of file AbstractConfig.php.

     {
         if ($this->pathPattern) {
             return sprintf($this->pathPattern, $this->_methodCode, $fieldName);
         }
 
         return "payment/{$this->_methodCode}/{$fieldName}";
     }

◆ _prepareValue()

_prepareValue	(	$key,
		$value
	)

protected

Perform additional config value preparation and return new value if needed

Parameters

string	$key	Underscored key
string	$value	Old value

Returns: string Modified value or old value

Definition at line 207 of file AbstractConfig.php.

     {
         // Always set payment action as "Sale" for Unilateral payments in EC
         if ($key == 'payment_action' &&
             $value != self::PAYMENT_ACTION_SALE &&
             $this->_methodCode == self::METHOD_WPP_EXPRESS &&
             $this->shouldUseUnilateralPayments()
         ) {
             return self::PAYMENT_ACTION_SALE;
         }
         return $value;
     }

◆ getBuildNotationCode()

getBuildNotationCode ( )

BN code getter

Returns: string

Definition at line 341 of file AbstractConfig.php.

     {
         $notationCode = $this->_scopeConfig->getValue('paypal/notation_code', ScopeInterface::SCOPE_STORES);
         return $notationCode ?: sprintf(self::$bnCode, $this->getProductMetadata()->getEdition());
     }

◆ getMethodCode()

getMethodCode ( )

Payment method instance code getter

Returns: string

Definition at line 116 of file AbstractConfig.php.

     {
         return $this->_methodCode;
     }

◆ getProductMetadata()

getProductMetadata ( )

protected

The getter function to get the ProductMetadata

Returns: ProductMetadataInterface

Deprecated:: 100.1.0

Definition at line 353 of file AbstractConfig.php.

     {
         if ($this->productMetadata === null) {
             $this->productMetadata = ObjectManager::getInstance()->get(ProductMetadataInterface::class);
         }
         return $this->productMetadata;
     }

◆ getValue()

getValue	(	$key,
		$storeId = `null`
	)

Returns payment configuration value

Parameters

string	$key
null	$storeId

Returns: null|string

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements ConfigInterface.

Definition at line 142 of file AbstractConfig.php.

     {
         switch ($key) {
             case 'getDebugReplacePrivateDataKeys':
                 return $this->methodInstance->getDebugReplacePrivateDataKeys();
             default:
                 $underscored = strtolower(preg_replace('/(.)([A-Z])/', "$1_$2", $key));
                 $path = $this->_getSpecificConfigPath($underscored);
                 if ($path !== null) {
                     $value = $this->_scopeConfig->getValue(
                         $path,
                         ScopeInterface::SCOPE_STORE,
                         $this->_storeId
                     );
                     $value = $this->_prepareValue($underscored, $value);
                     return $value;
                 }
         }
         return null;
     }

◆ isMethodActive()

isMethodActive ( $method )

Check whether method active in configuration and supported for merchant country or not

Parameters

string $method Method code

Returns: bool

Todo:: : refactor this @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 266 of file AbstractConfig.php.

     {
         switch ($method) {
             case Config::METHOD_WPS_EXPRESS:
             case Config::METHOD_WPP_EXPRESS:
                 $isEnabled = $this->_scopeConfig->isSetFlag(
                     'payment/' . Config::METHOD_WPS_EXPRESS .'/active',
                     ScopeInterface::SCOPE_STORE,
                     $this->_storeId
                 )
                 || $this->_scopeConfig->isSetFlag(
                     'payment/' . Config::METHOD_WPP_EXPRESS .'/active',
                     ScopeInterface::SCOPE_STORE,
                     $this->_storeId
                 );
                 $method = Config::METHOD_WPP_EXPRESS;
                 break;
             case Config::METHOD_WPS_BML:
             case Config::METHOD_WPP_BML:
                 $isEnabled = $this->_scopeConfig->isSetFlag(
                     'payment/' . Config::METHOD_WPS_BML .'/active',
                     ScopeInterface::SCOPE_STORE,
                     $this->_storeId
                 )
                 || $this->_scopeConfig->isSetFlag(
                     'payment/' . Config::METHOD_WPP_BML .'/active',
                     ScopeInterface::SCOPE_STORE,
                     $this->_storeId
                 );
                 $method = Config::METHOD_WPP_BML;
                 break;
             case Config::METHOD_PAYMENT_PRO:
             case Config::METHOD_PAYFLOWPRO:
                 $isEnabled = $this->_scopeConfig->isSetFlag(
                     'payment/' . Config::METHOD_PAYMENT_PRO .'/active',
                     ScopeInterface::SCOPE_STORE,
                     $this->_storeId
                 )
                 || $this->_scopeConfig->isSetFlag(
                     'payment/' . Config::METHOD_PAYFLOWPRO .'/active',
                     ScopeInterface::SCOPE_STORE,
                     $this->_storeId
                 );
                 $method = Config::METHOD_PAYFLOWPRO;
                 break;
             default:
                 $isEnabled = $this->_scopeConfig->isSetFlag(
                     "payment/{$method}/active",
                     ScopeInterface::SCOPE_STORE,
                     $this->_storeId
                 );
         }
 
         return $this->isMethodSupportedForCountry($method) && $isEnabled;
     }

◆ isMethodAvailable()

isMethodAvailable ( $methodCode = null )

Check whether method available for checkout or not

Parameters

null $methodCode

Returns: bool

Definition at line 250 of file AbstractConfig.php.

     {
         $methodCode = $methodCode ?: $this->_methodCode;
 
         return $this->isMethodActive($methodCode);
     }

◆ isMethodSupportedForCountry()

isMethodSupportedForCountry	(	$method = `null`,
		$countryCode = `null`
	)

Check whether method supported for specified country or not

Parameters

string \| null	$method
string \| null	$countryCode

Returns: bool

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 331 of file AbstractConfig.php.

     {
         return true;
     }

◆ isWppApiAvailabe()

isWppApiAvailabe ( )

Check whether WPP API credentials are available for this method

Returns: bool

Definition at line 235 of file AbstractConfig.php.

     {
         return $this->getValue('api_username')
         && $this->getValue('api_password')
         && ($this->getValue('api_signature')
             || $this->getValue('api_cert'));
     }

◆ setMethod()

setMethod ( $method )

Method code setter

Parameters

string | MethodInterface $method

Returns: $this

Definition at line 101 of file AbstractConfig.php.

     {
         if ($method instanceof MethodInterface) {
             $this->_methodCode = $method->getCode();
         } elseif (is_string($method)) {
             $this->_methodCode = $method;
         }
         return $this;
     }

◆ setMethodCode()

setMethodCode ( $methodCode )

Sets method code

Parameters

string $methodCode

Returns: void

Implements ConfigInterface.

Definition at line 169 of file AbstractConfig.php.

     {
         $this->_methodCode = $methodCode;
     }

◆ setMethodInstance()

setMethodInstance ( $method )

Sets method instance used for retrieving method specific data

Parameters

MethodInterface $method

Returns: $this

Definition at line 89 of file AbstractConfig.php.

     {
         $this->methodInstance = $method;
         return $this;
     }

◆ setPathPattern()

setPathPattern ( $pathPattern )

Sets path pattern

Parameters

string $pathPattern

Returns: void

Implements ConfigInterface.

Definition at line 180 of file AbstractConfig.php.

     {
         $this->pathPattern = $pathPattern;
     }

◆ setStoreId()

setStoreId ( $storeId )

Store ID setter

Parameters

int $storeId

Returns: $this

Definition at line 127 of file AbstractConfig.php.

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

◆ shouldUseUnilateralPayments()

shouldUseUnilateralPayments ( )

Check whether only Unilateral payments (Accelerated Boarding) possible for Express method or not

Returns: bool

Definition at line 225 of file AbstractConfig.php.

     {
         return $this->getValue('business_account') && !$this->isWppApiAvailabe();
     }

Field Documentation

◆ $_methodCode

$_methodCode

protected

Definition at line 40 of file AbstractConfig.php.

◆ $_scopeConfig

$_scopeConfig

protected

Definition at line 67 of file AbstractConfig.php.

◆ $_storeId

$_storeId

protected

Definition at line 47 of file AbstractConfig.php.

◆ $methodInstance

$methodInstance

protected

Definition at line 81 of file AbstractConfig.php.

◆ $pathPattern

$pathPattern

protected

Definition at line 52 of file AbstractConfig.php.

◆ $productMetadata

$productMetadata

protected

Definition at line 57 of file AbstractConfig.php.

◆ METHOD_WPP_EXPRESS

const METHOD_WPP_EXPRESS = 'paypal_express'

#- PayPal Website Payments Pro - Express Checkout

Definition at line 33 of file AbstractConfig.php.

◆ PAYMENT_ACTION_AUTH

const PAYMENT_ACTION_AUTH = 'Authorization'

Definition at line 25 of file AbstractConfig.php.

◆ PAYMENT_ACTION_ORDER

const PAYMENT_ACTION_ORDER = 'Order'

Definition at line 27 of file AbstractConfig.php.

◆ PAYMENT_ACTION_SALE

const PAYMENT_ACTION_SALE = 'Sale'

#+ Payment actions

Definition at line 23 of file AbstractConfig.php.

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getSpecificConfigPath()

◆ _prepareValue()

◆ getBuildNotationCode()

◆ getMethodCode()

◆ getProductMetadata()

◆ getValue()

◆ isMethodActive()

◆ isMethodAvailable()

◆ isMethodSupportedForCountry()

◆ isWppApiAvailabe()

◆ setMethod()

◆ setMethodCode()

◆ setMethodInstance()

◆ setPathPattern()

◆ setStoreId()

◆ shouldUseUnilateralPayments()

Field Documentation

◆ $_methodCode

◆ $_scopeConfig

◆ $_storeId

◆ $methodInstance

◆ $pathPattern

◆ $productMetadata

◆ METHOD_WPP_EXPRESS

◆ PAYMENT_ACTION_AUTH

◆ PAYMENT_ACTION_ORDER

◆ PAYMENT_ACTION_SALE