Inheritance diagram for Config:

Public Member Functions
	__construct (\Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Directory\Helper\Data $directoryHelper, \Magento\Store\Model\StoreManagerInterface $storeManager, \Magento\Payment\Model\Source\CctypeFactory $cctypeFactory, \Magento\Paypal\Model\CertFactory $certFactory, $params=[])

	isMethodAvailable ($methodCode=null)

	getSupportedMerchantCountryCodes ()

	getSupportedBuyerCountryCodes ()

	getMerchantCountry ()

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

	getCountryMethods ($countryCode=null)

	getPayPalBasicStartUrl ($token)

	isOrderReviewStepDisabled ()

	getExpressCheckoutStartUrl ($token)

	getExpressCheckoutOrderUrl ($orderId)

	getExpressCheckoutEditUrl ($token)

	getExpressCheckoutCompleteUrl ($token)

	getStartBillingAgreementUrl ($token)

	getPaypalUrl (array $params=[])

	getPayPalIpnUrl ()

	areButtonsDynamic ()

	getExpressCheckoutShortcutImageUrl ($localeCode, $orderTotal=null, $pal=null)

	getExpressCheckoutInContextImageUrl ($localeCode)

	getPaymentMarkImageUrl ($localeCode, $orderTotal=null, $pal=null, $staticSize=null)

	getPaymentMarkWhatIsPaypalUrl (\Magento\Framework\Locale\ResolverInterface $localeResolver=null)

	getSolutionImageUrl ($localeCode, $isVertical=false, $isEcheck=false)

	getPaymentFormLogoUrl ($localeCode)

	getAdditionalOptionsLogoTypes ()

	getAdditionalOptionsLogoUrl ($localeCode, $type=false)

	getExpressCheckoutButtonFlavors ()

	getExpressCheckoutButtonTypes ()

	getPaymentActions ()

	getRequireBillingAddressOptions ()

	getPaymentAction ()

	getExpressCheckoutSolutionTypes ()

	getExpressCheckoutBASignupOptions ()

	shouldAskToCreateBillingAgreement ()

	getWpsPaymentDeliveryMethods ()

	getWppCcTypesAsOptionArray ()

	getWppPeCcTypesAsOptionArray ()

	getPayflowproCcTypesAsOptionArray ()

	isCurrencyCodeSupported ($code)

	exportExpressCheckoutStyleSettings (\Magento\Framework\DataObject $to)

	getApiAuthenticationMethods ()

	getApiCertificate ()

	getBmlPublisherId ()

	getBmlDisplay ($section)

	getBmlPosition ($section)

	getBmlSize ($section)

Public Member Functions inherited from AbstractConfig
	__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 ()

Static Public Member Functions
static	getIsCreditCardMethod ($code)

Data Fields
const	METHOD_EXPRESS = 'paypal_express'

const	METHOD_WPS_EXPRESS = 'wps_express'

const	METHOD_WPS_BML = 'wps_express_bml'

const	METHOD_WPP_BML = 'paypal_express_bml'

const	METHOD_WPP_DIRECT = 'paypal_direct'

const	METHOD_PAYMENT_PRO = 'paypal_payment_pro'

const	METHOD_WPP_PE_EXPRESS = 'payflow_express'

const	METHOD_WPP_PE_BML = 'payflow_express_bml'

const	METHOD_PAYFLOWPRO = 'payflowpro'

const	METHOD_PAYFLOWLINK = 'payflow_link'

const	METHOD_PAYFLOWADVANCED = 'payflow_advanced'

const	METHOD_HOSTEDPRO = 'hosted_pro'

const	METHOD_BILLING_AGREEMENT = 'paypal_billing_agreement'

const	EC_FLAVOR_DYNAMIC = 'dynamic'

const	EC_FLAVOR_STATIC = 'static'

const	EC_BUTTON_TYPE_SHORTCUT = 'ecshortcut'

const	EC_BUTTON_TYPE_MARK = 'ecmark'

const	PAYMENT_MARK_SMALL = 'small'

const	PAYMENT_MARK_MEDIUM = 'medium'

const	PAYMENT_MARK_LARGE = 'large'

const	DEFAULT_LOGO_TYPE = 'wePrefer_150x60'

const	AUTHORIZATION_AMOUNT_ONE = 1

const	AUTHORIZATION_AMOUNT_FULL = 2

const	REQUIRE_BILLING_ADDRESS_NO = 0

const	REQUIRE_BILLING_ADDRESS_ALL = 1

const	REQUIRE_BILLING_ADDRESS_VIRTUAL = 2

const	FRAUD_ACTION_ACCEPT = 'Acept'

const	FRAUD_ACTION_DENY = 'Deny'

const	REFUND_TYPE_FULL = 'Full'

const	REFUND_TYPE_PARTIAL = 'Partial'

const	EC_SOLUTION_TYPE_SOLE = 'Sole'

const	EC_SOLUTION_TYPE_MARK = 'Mark'

const	WPS_TRANSPORT_IPN = 'ipn'

const	WPS_TRANSPORT_PDT = 'pdt'

const	WPS_TRANSPORT_IPN_PDT = 'ipn_n_pdt'

const	EC_BA_SIGNUP_AUTO = 'auto'

const	EC_BA_SIGNUP_ASK = 'ask'

const	EC_BA_SIGNUP_NEVER = 'never'

const	TRANSFER_CART_LINE_ITEMS = 'lineItemsEnabled'

const	TRANSFER_SHIPPING_OPTIONS = 'transferShippingOptions'

const	XML_PATH_PAYPAL_EXPRESS_SKIP_ORDER_REVIEW_STEP_FLAG = 'payment/paypal_express/skip_order_review_step'

Data Fields inherited from AbstractConfig
const	PAYMENT_ACTION_SALE = 'Sale'

const	PAYMENT_ACTION_AUTH = 'Authorization'

const	PAYMENT_ACTION_ORDER = 'Order'

const	METHOD_WPP_EXPRESS = 'paypal_express'

Protected Member Functions
	_getDynamicImageUrl ($type, $localeCode, $orderTotal, $pal)

	_getSupportedLocaleCode ($localeCode=null)

	_getSpecificConfigPath ($fieldName)

	_mapExpressFieldset ($fieldName)

	_mapBmlFieldset ($fieldName)

	_mapBmlPayflowFieldset ($fieldName)

	_mapDirectFieldset ($fieldName)

	_mapWppFieldset ($fieldName)

	_mapWpukFieldset ($fieldName)

	_mapGenericStyleFieldset ($fieldName)

	_mapGeneralFieldset ($fieldName)

	_mapMethodFieldset ($fieldName)

Protected Member Functions inherited from AbstractConfig
	_getSpecificConfigPath ($fieldName)

	_prepareValue ($key, $value)

	getProductMetadata ()

Protected Attributes
	$_buildNotationPPMap

	$_ecStyleConfigMap

	$_supportedCurrencyCodes

	$_supportedCountryCodes

	$_supportedBuyerCountryCodes

	$_supportedImageLocales

	$directoryHelper

	$_storeManager

	$_cctypeFactory

	$_certFactory

Protected Attributes inherited from AbstractConfig
	$_methodCode

	$_storeId

	$pathPattern

	$productMetadata

	$_scopeConfig

	$methodInstance

Detailed Description

Config model that is aware of all \Magento\Paypal payment methods Works with PayPal-specific system configuration

@SuppressWarnings(PHPMD.ExcessivePublicCount) @SuppressWarnings(PHPMD.ExcessiveClassComplexity)

Definition at line 18 of file Config.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Directory\Helper\Data	$directoryHelper,
		\Magento\Store\Model\StoreManagerInterface	$storeManager,
		\Magento\Payment\Model\Source\CctypeFactory	$cctypeFactory,
		\Magento\Paypal\Model\CertFactory	$certFactory,
			$params = `[]`
	)

Parameters

\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Directory\Helper\Data	$directoryHelper
\Magento\Store\Model\StoreManagerInterface	$storeManager
\Magento\Payment\Model\Source\CctypeFactory	$cctypeFactory
CertFactory	$certFactory
array	$params

Definition at line 610 of file Config.php.

       {
         parent::__construct($scopeConfig);
         $this->directoryHelper = $directoryHelper;
         $this->_storeManager = $storeManager;
         $this->_cctypeFactory = $cctypeFactory;
         $this->_certFactory = $certFactory;
         if ($params) {
             $method = array_shift($params);
             $this->setMethod($method);
             if ($params) {
                 $storeId = array_shift($params);
                 $this->setStoreId($storeId);
             }
         }
     }

Member Function Documentation

◆ _getDynamicImageUrl()

_getDynamicImageUrl	(	$type,
		$localeCode,
		$orderTotal,
		$pal
	)

protected

Dynamic PayPal image URL getter Also can render dynamic Acceptance Mark

Parameters

string	$type
string	$localeCode
float	$orderTotal
string	$pal

Returns: string

Definition at line 1387 of file Config.php.

     {
         $params = [
             'cmd' => '_dynamic-image',
             'buttontype' => $type,
             'locale' => $this->_getSupportedLocaleCode($localeCode),
         ];
         if ($orderTotal) {
             $params['ordertotal'] = $this->formatPrice($orderTotal);
             if ($pal) {
                 $params['pal'] = $pal;
             }
         }
         if ($params['locale'] == 'en_US') {
             switch ($type) {
                 case self::EC_BUTTON_TYPE_MARK:
                     return 'https://www.paypalobjects.com/webstatic/en_US/i/buttons/ppcredit-logo-medium.png';
                 case self::EC_BUTTON_TYPE_SHORTCUT:
                 default:
                     return 'https://www.paypalobjects.com/webstatic/en_US/i/buttons/checkout-logo-medium.png';
             }
         }
         return sprintf(
             'https://fpdbs%s.paypal.com/dynamicimageweb?%s',
             $this->getValue('sandboxFlag') ? '.sandbox' : '',
             http_build_query($params)
         );
     }

◆ _getSpecificConfigPath()

_getSpecificConfigPath ( $fieldName )

protected

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

Parameters

string $fieldName

Returns: string|null @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 1438 of file Config.php.

     {
         $path = null;
         switch ($this->_methodCode) {
             case self::METHOD_WPP_BML:
                 $path = $this->_mapBmlFieldset($fieldName);
                 break;
             case self::METHOD_WPP_PE_BML:
                 $path = $this->_mapBmlPayflowFieldset($fieldName);
                 break;
             case self::METHOD_WPP_EXPRESS:
             case self::METHOD_WPP_PE_EXPRESS:
             case self::METHOD_EXPRESS:
                 $path = $this->_mapExpressFieldset($fieldName);
                 break;
             case self::METHOD_BILLING_AGREEMENT:
             case self::METHOD_HOSTEDPRO:
                 $path = $this->_mapMethodFieldset($fieldName);
                 break;
         }
 
         if ($path === null) {
             switch ($this->_methodCode) {
                 case self::METHOD_WPP_EXPRESS:
                 case self::METHOD_WPP_BML:
                 case self::METHOD_BILLING_AGREEMENT:
                 case self::METHOD_HOSTEDPRO:
                     $path = $this->_mapWppFieldset($fieldName);
                     break;
                 case self::METHOD_WPP_PE_EXPRESS:
                 case self::METHOD_PAYFLOWADVANCED:
                 case self::METHOD_PAYFLOWLINK:
                     $path = $this->_mapWpukFieldset($fieldName);
                     break;
             }
         }
 
         if ($path === null) {
             $path = $this->_mapGeneralFieldset($fieldName);
         }
         if ($path === null) {
             $path = $this->_mapGenericStyleFieldset($fieldName);
         }
         return $path;
     }

◆ _getSupportedLocaleCode()

_getSupportedLocaleCode ( $localeCode = null )

protected

Check whether specified locale code is supported. Fallback to en_US

Parameters

string | null $localeCode

Returns: string

Definition at line 1422 of file Config.php.

     {
         if (!$localeCode || !in_array($localeCode, $this->_supportedImageLocales)) {
             return 'en_US';
         }
         return $localeCode;
     }

◆ _mapBmlFieldset()

_mapBmlFieldset ( $fieldName )

protected

Map PayPal Express Bill Me Later config fields

Parameters

string $fieldName

Returns: string|null

Definition at line 1517 of file Config.php.

     {
         switch ($fieldName) {
             case 'allow_ba_signup':
                 return "payment/" . self::METHOD_WPP_EXPRESS . "/{$fieldName}";
             default:
                 return $this->_mapExpressFieldset($fieldName);
         }
     }

◆ _mapBmlPayflowFieldset()

_mapBmlPayflowFieldset ( $fieldName )

protected

Map PayPal Express Bill Me Later config fields (Payflow Edition)

Parameters

string $fieldName

Returns: string|null

Definition at line 1533 of file Config.php.

     {
         switch ($fieldName) {
             case 'allow_ba_signup':
                 return "payment/" . self::METHOD_WPP_PE_EXPRESS . "/{$fieldName}";
             default:
                 return $this->_mapExpressFieldset($fieldName);
         }
     }

◆ _mapDirectFieldset()

_mapDirectFieldset ( $fieldName )

protected

Map PayPal Direct config fields

Parameters

string $fieldName

Returns: string|null

Definition at line 1549 of file Config.php.

     {
         switch ($fieldName) {
             case 'useccv':
                 return "payment/{$this->_methodCode}/{$fieldName}";
             default:
                 return $this->_mapMethodFieldset($fieldName);
         }
     }

◆ _mapExpressFieldset()

_mapExpressFieldset ( $fieldName )

protected

Map PayPal Express config fields

Parameters

string $fieldName

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

Definition at line 1491 of file Config.php.

     {
         switch ($fieldName) {
             case 'transfer_shipping_options':
             case 'solution_type':
             case 'visible_on_cart':
             case 'visible_on_product':
             case 'require_billing_address':
             case 'authorization_honor_period':
             case 'order_valid_period':
             case 'child_authorization_number':
             case 'allow_ba_signup':
             case 'in_context':
             case 'merchant_id':
                 return "payment/{$this->_methodCode}/{$fieldName}";
             default:
                 return $this->_mapMethodFieldset($fieldName);
         }
     }

◆ _mapGeneralFieldset()

_mapGeneralFieldset ( $fieldName )

protected

Map PayPal General Settings

Parameters

string $fieldName

Returns: string|null

Definition at line 1651 of file Config.php.

     {
         switch ($fieldName) {
             case 'business_account':
             case 'merchant_country':
                 return "paypal/general/{$fieldName}";
             default:
                 return null;
         }
     }

◆ _mapGenericStyleFieldset()

_mapGenericStyleFieldset ( $fieldName )

protected

Map PayPal common style config fields

Parameters

string $fieldName

Returns: string|null

Definition at line 1630 of file Config.php.

     {
         switch ($fieldName) {
             case 'logo':
             case 'page_style':
             case 'paypal_hdrimg':
             case 'paypal_hdrbackcolor':
             case 'paypal_hdrbordercolor':
             case 'paypal_payflowcolor':
                 return "paypal/style/{$fieldName}";
             default:
                 return null;
         }
     }

◆ _mapMethodFieldset()

_mapMethodFieldset ( $fieldName )

protected

Map PayPal General Settings

Parameters

string $fieldName

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

Definition at line 1669 of file Config.php.

     {
         if (!$this->_methodCode) {
             return null;
         }
         switch ($fieldName) {
             case 'active':
             case 'title':
             case 'payment_action':
             case 'allowspecific':
             case 'specificcountry':
             case 'line_items_enabled':
             case 'cctypes':
             case 'sort_order':
             case 'debug':
             case 'verify_peer':
                 return "payment/{$this->_methodCode}/{$fieldName}";
             default:
                 return null;
         }
     }

◆ _mapWppFieldset()

_mapWppFieldset ( $fieldName )

protected

Map PayPal Website Payments Pro common config fields

Parameters

string $fieldName

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

Definition at line 1566 of file Config.php.

     {
         switch ($fieldName) {
             case 'api_authentication':
             case 'api_username':
             case 'api_password':
             case 'api_signature':
             case 'api_cert':
             case 'sandbox_flag':
             case 'use_proxy':
             case 'proxy_host':
             case 'proxy_port':
             case 'button_flavor':
             case 'button_type':
                 return "paypal/wpp/{$fieldName}";
             default:
                 return null;
         }
     }

◆ _mapWpukFieldset()

_mapWpukFieldset ( $fieldName )

protected

Map PayPal Website Payments Pro common config fields

Parameters

string $fieldName

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

Definition at line 1593 of file Config.php.

     {
         $pathPrefix = 'paypal/wpuk';
         if ($this->_methodCode == self::METHOD_WPP_PE_EXPRESS && $this->isMethodAvailable(self::METHOD_PAYFLOWLINK)) {
             $pathPrefix = 'payment/payflow_link';
         } elseif ($this->_methodCode == self::METHOD_WPP_PE_EXPRESS && $this->isMethodAvailable(
             self::METHOD_PAYFLOWADVANCED
         )
         ) {
             $pathPrefix = 'payment/payflow_advanced';
         } elseif ($this->_methodCode == self::METHOD_WPP_PE_EXPRESS) {
             $pathPrefix = 'payment/payflowpro';
         } elseif ($this->_methodCode == self::METHOD_PAYFLOWADVANCED || $this->_methodCode == self::METHOD_PAYFLOWLINK
         ) {
             return 'payment/' . $this->_methodCode . '/' . $fieldName;
         }
         switch ($fieldName) {
             case 'partner':
             case 'user':
             case 'vendor':
             case 'pwd':
             case 'sandbox_flag':
             case 'use_proxy':
             case 'proxy_host':
             case 'proxy_port':
                 return $pathPrefix . '/' . $fieldName;
             default:
                 return null;
         }
     }

◆ areButtonsDynamic()

areButtonsDynamic ( )

Whether Express Checkout button should be rendered dynamically

Returns: bool

Definition at line 953 of file Config.php.

     {
         return $this->getValue('buttonFlavor') === self::EC_FLAVOR_DYNAMIC;
     }

◆ exportExpressCheckoutStyleSettings()

exportExpressCheckoutStyleSettings ( \Magento\Framework\DataObject $to )

Export page style current settings to specified object

Parameters

\Magento\Framework\DataObject $to

Returns: void

Definition at line 1367 of file Config.php.

     {
         foreach ($this->_ecStyleConfigMap as $key => $exportKey) {
             $configValue = $this->getValue($key);
             if ($configValue) {
                 $to->setData($exportKey, $configValue);
             }
         }
     }

◆ getAdditionalOptionsLogoTypes()

getAdditionalOptionsLogoTypes ( )

Return supported types for PayPal logo

Returns: array

Definition at line 1125 of file Config.php.

     {
         return [
             'wePrefer_150x60' => __('We prefer PayPal (150 X 60)'),
             'wePrefer_150x40' => __('We prefer PayPal (150 X 40)'),
             'nowAccepting_150x60' => __('Now accepting PayPal (150 X 60)'),
             'nowAccepting_150x40' => __('Now accepting PayPal (150 X 40)'),
             'paymentsBy_150x60' => __('Payments by PayPal (150 X 60)'),
             'paymentsBy_150x40' => __('Payments by PayPal (150 X 40)'),
             'shopNowUsing_150x60' => __('Shop now using (150 X 60)'),
             'shopNowUsing_150x40' => __('Shop now using (150 X 40)')
         ];
     }

◆ getAdditionalOptionsLogoUrl()

getAdditionalOptionsLogoUrl	(	$localeCode,
		$type = `false`
	)

Return PayPal logo URL with additional options

Parameters

string	$localeCode	Supported locale code
bool \| string	$type	One of supported logo types

Returns: string|bool Logo Image URL or false if logo disabled in configuration

Definition at line 1146 of file Config.php.

     {
         $configType = $this->_scopeConfig->getValue(
             $this->_mapGenericStyleFieldset('logo'),
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $this->_storeId
         );
         if (!$configType) {
             return false;
         }
         $type = $type ? $type : $configType;
         $locale = $this->_getSupportedLocaleCode($localeCode);
         $supportedTypes = array_keys($this->getAdditionalOptionsLogoTypes());
         if (!in_array($type, $supportedTypes)) {
             $type = self::DEFAULT_LOGO_TYPE;
         }
         return sprintf('https://www.paypalobjects.com/%s/i/bnr/bnr_%s.gif', $locale, $type);
     }

◆ getApiAuthenticationMethods()

getApiAuthenticationMethods ( )

Payment API authentication methods source getter

Returns: array

Definition at line 1696 of file Config.php.

     {
         return ['0' => __('API Signature'), '1' => __('API Certificate')];
     }

◆ getApiCertificate()

getApiCertificate ( )

Api certificate getter

Returns: string

Definition at line 1706 of file Config.php.

     {
         $websiteId = $this->_storeManager->getStore($this->_storeId)->getWebsiteId();
         return $this->_certFactory->create()->loadByWebsite($websiteId, false)->getCertPath();
     }

◆ getBmlDisplay()

getBmlDisplay ( $section )

Get Display option from stored config

Parameters

string $section

Returns: mixed

Definition at line 1732 of file Config.php.

     {
         $display = $this->_scopeConfig->getValue(
             'payment/' . self::METHOD_WPP_BML . '/' . $section . '_display',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $this->_storeId
         );
         $bmlActive = $this->_scopeConfig->getValue(
             'payment/' . self::METHOD_WPP_BML . '/active',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $this->_storeId
         );
         $bmlUkActive = $this->_scopeConfig->getValue(
             'payment/' . self::METHOD_WPP_PE_BML . '/active',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $this->_storeId
         );
         return (($bmlActive && $this->isMethodActive(self::METHOD_WPP_EXPRESS))
             || ($bmlUkActive && $this->isMethodActive(self::METHOD_WPP_PE_EXPRESS))) ? $display : 0;
     }

◆ getBmlPosition()

getBmlPosition ( $section )

Get Position option from stored config

Parameters

string $section

Returns: mixed

Definition at line 1759 of file Config.php.

     {
         return $this->_scopeConfig->getValue(
             'payment/' . self::METHOD_WPP_BML . '/' . $section . '_position',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $this->_storeId
         );
     }

◆ getBmlPublisherId()

getBmlPublisherId ( )

Get PublisherId from stored config

Returns: mixed

Definition at line 1717 of file Config.php.

     {
         return $this->_scopeConfig->getValue(
             'payment/' . self::METHOD_WPP_BML . '/publisher_id',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $this->_storeId
         );
     }

◆ getBmlSize()

getBmlSize ( $section )

Get Size option from stored config

Parameters

string $section

Returns: mixed

Definition at line 1774 of file Config.php.

     {
         return $this->_scopeConfig->getValue(
             'payment/' . self::METHOD_WPP_BML . '/' . $section . '_size',
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $this->_storeId
         );
     }

◆ getCountryMethods()

getCountryMethods ( $countryCode = null )

Return list of allowed methods for specified country iso code

Parameters

string | null $countryCode 2-letters iso code

Returns: array @SuppressWarnings(PHPMD.ExcessiveMethodLength)

Definition at line 750 of file Config.php.

     {
         $countryMethods = [
             'other' => [
                 self::METHOD_WPP_EXPRESS,
                 self::METHOD_BILLING_AGREEMENT,
             ],
             'US' => [
                 self::METHOD_PAYFLOWADVANCED,
                 self::METHOD_PAYFLOWPRO,
                 self::METHOD_PAYFLOWLINK,
                 self::METHOD_WPP_EXPRESS,
                 self::METHOD_WPP_BML,
                 self::METHOD_BILLING_AGREEMENT,
                 self::METHOD_WPP_PE_EXPRESS,
                 self::METHOD_WPP_PE_BML,
             ],
             'CA' => [
                 self::METHOD_PAYFLOWPRO,
                 self::METHOD_PAYFLOWLINK,
                 self::METHOD_WPP_EXPRESS,
                 self::METHOD_BILLING_AGREEMENT,
                 self::METHOD_WPP_PE_EXPRESS,
             ],
             'GB' => [
                 self::METHOD_HOSTEDPRO,
                 self::METHOD_WPP_EXPRESS,
                 self::METHOD_BILLING_AGREEMENT,
             ],
             'AU' => [
                 self::METHOD_PAYFLOWPRO,
                 self::METHOD_HOSTEDPRO,
                 self::METHOD_WPP_EXPRESS,
                 self::METHOD_BILLING_AGREEMENT,
             ],
             'NZ' => [
                 self::METHOD_PAYFLOWPRO,
                 self::METHOD_WPP_EXPRESS,
                 self::METHOD_BILLING_AGREEMENT,
             ],
             'JP' => [
                 self::METHOD_HOSTEDPRO,
                 self::METHOD_WPP_EXPRESS,
                 self::METHOD_BILLING_AGREEMENT,
             ],
             'FR' => [
                 self::METHOD_HOSTEDPRO,
                 self::METHOD_WPP_EXPRESS,
                 self::METHOD_BILLING_AGREEMENT,
             ],
             'IT' => [
                 self::METHOD_HOSTEDPRO,
                 self::METHOD_WPP_EXPRESS,
                 self::METHOD_BILLING_AGREEMENT,
             ],
             'ES' => [
                 self::METHOD_HOSTEDPRO,
                 self::METHOD_WPP_EXPRESS,
                 self::METHOD_BILLING_AGREEMENT,
             ],
             'HK' => [
                 self::METHOD_HOSTEDPRO,
                 self::METHOD_WPP_EXPRESS,
                 self::METHOD_BILLING_AGREEMENT,
             ],
             'DE' => [
                 self::METHOD_WPP_EXPRESS,
                 self::METHOD_BILLING_AGREEMENT,
             ],
         ];
         if ($countryCode === null) {
             return $countryMethods;
         }
         return isset($countryMethods[$countryCode]) ? $countryMethods[$countryCode] : $countryMethods['other'];
     }

◆ getExpressCheckoutBASignupOptions()

getExpressCheckoutBASignupOptions ( )

Retrieve express checkout billing agreement signup options

Returns: array

Definition at line 1254 of file Config.php.

     {
         return [
             self::EC_BA_SIGNUP_AUTO => __('Auto'),
             self::EC_BA_SIGNUP_ASK => __('Ask Customer'),
             self::EC_BA_SIGNUP_NEVER => __('Never')
         ];
     }

◆ getExpressCheckoutButtonFlavors()

getExpressCheckoutButtonFlavors ( )

Express Checkout button "flavors" source getter

Returns: array

Definition at line 1170 of file Config.php.

     {
         return [self::EC_FLAVOR_DYNAMIC => __('Dynamic'), self::EC_FLAVOR_STATIC => __('Static')];
     }

◆ getExpressCheckoutButtonTypes()

getExpressCheckoutButtonTypes ( )

Express Checkout button types source getter

Returns: array

Definition at line 1180 of file Config.php.

     {
         return [
             self::EC_BUTTON_TYPE_SHORTCUT => __('Shortcut'),
             self::EC_BUTTON_TYPE_MARK => __('Acceptance Mark Image')
         ];
     }

◆ getExpressCheckoutCompleteUrl()

getExpressCheckoutCompleteUrl ( $token )

Get url for additional actions that PayPal may require customer to do after placing the order. For instance, redirecting customer to bank for payment confirmation.

Parameters

string $token

Returns: string

Definition at line 904 of file Config.php.

     {
         return $this->getPaypalUrl(['cmd' => '_complete-express-checkout', 'token' => $token]);
     }

◆ getExpressCheckoutEditUrl()

getExpressCheckoutEditUrl ( $token )

Get url that allows to edit checkout details on paypal side

Parameters

\Magento\Paypal\Controller\Express | string $token

Returns: string

Definition at line 892 of file Config.php.

     {
         return $this->getPaypalUrl(['cmd' => '_express-checkout', 'useraction' => 'continue', 'token' => $token]);
     }

◆ getExpressCheckoutInContextImageUrl()

getExpressCheckoutInContextImageUrl ( $localeCode )

Express in context checkout shortcut pic URL getter

Parameters

string $localeCode

Returns: string

Definition at line 986 of file Config.php.

     {
         $localeCode = $this->_getSupportedLocaleCode($localeCode);
 
         if ($localeCode === 'en_US') {
             return 'https://www.paypalobjects.com/webstatic/en_US/i/buttons/checkout-logo-medium.png';
         }
 
         return sprintf('https://www.paypal.com/%s/i/btn/btn_xpressCheckout.gif', $localeCode);
     }

◆ getExpressCheckoutOrderUrl()

getExpressCheckoutOrderUrl ( $orderId )

Get url for dispatching customer to checkout retrial

Parameters

string $orderId

Returns: string

Definition at line 881 of file Config.php.

     {
         return $this->getPaypalUrl(['cmd' => '_express-checkout', 'order_id' => $orderId]);
     }

◆ getExpressCheckoutShortcutImageUrl()

getExpressCheckoutShortcutImageUrl	(	$localeCode,
		$orderTotal = `null`,
		$pal = `null`
	)

Express checkout shortcut pic URL getter PayPal will ignore "pal", if there is no total amount specified

Parameters

string	$localeCode
float \| null	$orderTotal
string \| null	$pal	encrypted summary about merchant

Returns: string

See also: Paypal_Model_Api_Nvp::callGetPalDetails()

Definition at line 968 of file Config.php.

     {
         if ($this->areButtonsDynamic()) {
             return $this->_getDynamicImageUrl(self::EC_BUTTON_TYPE_SHORTCUT, $localeCode, $orderTotal, $pal);
         }
         if ($this->getValue('buttonType') === self::EC_BUTTON_TYPE_MARK) {
             return $this->getPaymentMarkImageUrl($localeCode);
         }
 
         return $this->getExpressCheckoutInContextImageUrl($localeCode);
     }

◆ getExpressCheckoutSolutionTypes()

getExpressCheckoutSolutionTypes ( )

Express Checkout "solution types" source getter "sole" = "Express Checkout for Auctions" - PayPal allows guest checkout "mark" = "Normal Express Checkout" - PayPal requires to checkout with PayPal buyer account only

Returns: array

Definition at line 1244 of file Config.php.

     {
         return [self::EC_SOLUTION_TYPE_SOLE => __('Yes'), self::EC_SOLUTION_TYPE_MARK => __('No')];
     }

◆ getExpressCheckoutStartUrl()

getExpressCheckoutStartUrl ( $token )

Get url for dispatching customer to express checkout start

Parameters

string $token

Returns: string

Definition at line 866 of file Config.php.

     {
         return sprintf(
             'https://www.%spaypal.com/checkoutnow%s',
             $this->getValue('sandboxFlag') ? 'sandbox.' : '',
             '?token=' . urlencode($token)
         );
     }

◆ getIsCreditCardMethod()

static getIsCreditCardMethod ( $code )

static

Check whether the specified payment method is a CC-based one

Parameters

string $code

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 1326 of file Config.php.

     {
         switch ($code) {
             case self::METHOD_PAYFLOWPRO:
             case self::METHOD_PAYFLOWLINK:
             case self::METHOD_PAYFLOWADVANCED:
             case self::METHOD_HOSTEDPRO:
                 return true;
         }
         return false;
     }

◆ getMerchantCountry()

getMerchantCountry ( )

Return merchant country code, use default country if it not specified in General settings

Returns: string

Definition at line 711 of file Config.php.

     {
         $countryCode = $this->_scopeConfig->getValue(
             $this->_mapGeneralFieldset('merchant_country'),
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $this->_storeId
         );
         if (!$countryCode) {
             $countryCode = $this->directoryHelper->getDefaultCountry($this->_storeId);
         }
         return $countryCode;
     }

◆ getPayflowproCcTypesAsOptionArray()

getPayflowproCcTypesAsOptionArray ( )

Return list of supported credit card types by Payflow Pro gateway

Returns: array

Definition at line 1314 of file Config.php.

     {
         return $this->_cctypeFactory->create()->setAllowedTypes(['AE', 'VI', 'MC', 'JCB', 'DI', 'DN'])->toOptionArray();
     }

◆ getPaymentAction()

getPaymentAction ( )

Mapper from PayPal-specific payment actions to Magento payment actions

Returns: string|null

Definition at line 1224 of file Config.php.

     {
         switch ($this->getValue('paymentAction')) {
             case self::PAYMENT_ACTION_AUTH:
                 return \Magento\Payment\Model\Method\AbstractMethod::ACTION_AUTHORIZE;
             case self::PAYMENT_ACTION_SALE:
                 return \Magento\Payment\Model\Method\AbstractMethod::ACTION_AUTHORIZE_CAPTURE;
             case self::PAYMENT_ACTION_ORDER:
                 return \Magento\Payment\Model\Method\AbstractMethod::ACTION_ORDER;
         }
         return null;
     }

◆ getPaymentActions()

getPaymentActions ( )

Payment actions source getter

Returns: array

Definition at line 1193 of file Config.php.

     {
         $paymentActions = [
             self::PAYMENT_ACTION_AUTH => __('Authorization'),
             self::PAYMENT_ACTION_SALE => __('Sale'),
         ];
         if ($this->_methodCode !== null && $this->_methodCode == self::METHOD_WPP_EXPRESS) {
             $paymentActions[self::PAYMENT_ACTION_ORDER] = __('Order');
         }
         return $paymentActions;
     }

◆ getPaymentFormLogoUrl()

getPaymentFormLogoUrl ( $localeCode )

Getter for Payment form logo images

Parameters

string $localeCode

Returns: string

Definition at line 1083 of file Config.php.

     {
         $locale = $this->_getSupportedLocaleCode($localeCode);
 
         $imageType = 'logo';
         $domain = 'paypal.com';
         list(, $country) = explode('_', $locale);
         $countryPrefix = $country . '/';
 
         switch ($locale) {
             case 'en_GB':
                 $imageName = 'horizontal_solution_PP';
                 $imageType = 'bnr';
                 $countryPrefix = '';
                 break;
             case 'de_DE':
                 $imageName = 'lockbox_150x47';
                 break;
             case 'fr_FR':
                 $imageName = 'bnr_horizontal_solution_PP_327wx80h';
                 $imageType = 'bnr';
                 $locale = 'en_US';
                 $domain = 'paypalobjects.com';
                 break;
             case 'it_IT':
                 $imageName = 'bnr_horizontal_solution_PP_178wx80h';
                 $imageType = 'bnr';
                 $domain = 'paypalobjects.com';
                 break;
             default:
                 $imageName = 'PayPal_mark_60x38';
                 $countryPrefix = '';
                 break;
         }
         return sprintf('https://www.%s/%s/%si/%s/%s.gif', $domain, $locale, $countryPrefix, $imageType, $imageName);
     }

◆ getPaymentMarkImageUrl()

getPaymentMarkImageUrl	(	$localeCode,
		$orderTotal = `null`,
		$pal = `null`,
		$staticSize = `null`
	)

Get PayPal "mark" image URL Supposed to be used on payment methods selection $staticSize is applicable for static images only

Parameters

string	$localeCode
float \| null	$orderTotal
string \| null	$pal
string \| null	$staticSize

Returns: string

Definition at line 1008 of file Config.php.

     {
         if ($this->areButtonsDynamic()) {
             return $this->_getDynamicImageUrl(self::EC_BUTTON_TYPE_MARK, $localeCode, $orderTotal, $pal);
         }
 
         if (null === $staticSize) {
             $staticSize = $this->getValue('paymentMarkSize');
         }
 
         switch ($staticSize) {
             case self::PAYMENT_MARK_SMALL:
             case self::PAYMENT_MARK_MEDIUM:
             case self::PAYMENT_MARK_LARGE:
                 break;
             default:
                 $staticSize = self::PAYMENT_MARK_MEDIUM;
         }
 
         return sprintf(
             'https://www.paypalobjects.com/webstatic/en_US/i/buttons/pp-acceptance-%s.png',
             $staticSize
         );
     }

◆ getPaymentMarkWhatIsPaypalUrl()

getPaymentMarkWhatIsPaypalUrl ( \Magento\Framework\Locale\ResolverInterface $localeResolver = null )

Get "What Is PayPal" localized URL Supposed to be used with "mark" as popup window

Parameters

\Magento\Framework\Locale\ResolverInterface $localeResolver

Returns: string

Definition at line 1040 of file Config.php.

     {
         $countryCode = 'US';
         if (null !== $localeResolver) {
             $shouldEmulate = null !== $this->_storeId && $this->_storeManager->getStore()->getId() != $this->_storeId;
             if ($shouldEmulate) {
                 $localeResolver->emulate($this->_storeId);
             }
             $countryCode = \Locale::getRegion($localeResolver->getLocale());
             if ($shouldEmulate) {
                 $localeResolver->revert();
             }
         }
         return sprintf(
             'https://www.paypal.com/%s/cgi-bin/webscr?cmd=xpt/Marketing/popup/OLCWhatIsPayPal-outside',
             strtolower($countryCode)
         );
     }

◆ getPayPalBasicStartUrl()

getPayPalBasicStartUrl ( $token )

Return start url for PayPal Basic

Parameters

string $token

Returns: string

Definition at line 832 of file Config.php.

     {
         $params = [
             'cmd'   => '_express-checkout',
             'token' => $token,
         ];
 
         if ($this->isOrderReviewStepDisabled()) {
             $params['useraction'] = 'commit';
         }
 
         return $this->getPaypalUrl($params);
     }

◆ getPayPalIpnUrl()

getPayPalIpnUrl ( )

PayPal web URL for IPN

Returns: string

Definition at line 940 of file Config.php.

     {
         return sprintf(
             'https://ipnpb.%spaypal.com/cgi-bin/webscr',
             $this->getValue('sandboxFlag') ? 'sandbox.' : ''
         );
     }

◆ getPaypalUrl()

getPaypalUrl ( array $params = [] )

PayPal web URL generic getter

Parameters

array $params

Returns: string

Definition at line 926 of file Config.php.

     {
         return sprintf(
             'https://www.%spaypal.com/cgi-bin/webscr%s',
             $this->getValue('sandboxFlag') ? 'sandbox.' : '',
             $params ? '?' . http_build_query($params) : ''
         );
     }

◆ getRequireBillingAddressOptions()

getRequireBillingAddressOptions ( )

Require Billing Address source getter

Returns: array

Definition at line 1210 of file Config.php.

     {
         return [
             self::REQUIRE_BILLING_ADDRESS_ALL => __('Yes'),
             self::REQUIRE_BILLING_ADDRESS_NO => __('No'),
             self::REQUIRE_BILLING_ADDRESS_VIRTUAL => __('For Virtual Quotes Only')
         ];
     }

◆ getSolutionImageUrl()

getSolutionImageUrl	(	$localeCode,
		$isVertical = `false`,
		$isEcheck = `false`
	)

Getter for Solution banner images

Parameters

string	$localeCode
bool	$isVertical
bool	$isEcheck

Returns: string

Definition at line 1067 of file Config.php.

     {
         return sprintf(
             'https://www.paypal.com/%s/i/bnr/%s_solution_PP%s.gif',
             $this->_getSupportedLocaleCode($localeCode),
             $isVertical ? 'vertical' : 'horizontal',
             $isEcheck ? 'eCheck' : ''
         );
     }

◆ getStartBillingAgreementUrl()

getStartBillingAgreementUrl ( $token )

Retrieve url for initialization of billing agreement

Parameters

string $token

Returns: string

Definition at line 915 of file Config.php.

     {
         return $this->getPaypalUrl(['cmd' => '_customer-billing-agreement', 'token' => $token]);
     }

◆ getSupportedBuyerCountryCodes()

getSupportedBuyerCountryCodes ( )

Return buyer country codes supported by PayPal

Returns: string[]

Definition at line 701 of file Config.php.

     {
         return $this->_supportedBuyerCountryCodes;
     }

◆ getSupportedMerchantCountryCodes()

getSupportedMerchantCountryCodes ( )

Return merchant country codes supported by PayPal

Returns: string[]

Definition at line 691 of file Config.php.

     {
         return $this->_supportedCountryCodes;
     }

◆ getWppCcTypesAsOptionArray()

getWppCcTypesAsOptionArray ( )

Return list of supported credit card types by Paypal Direct gateway

Returns: array

Definition at line 1290 of file Config.php.

     {
         return $this->_cctypeFactory->create()->setAllowedTypes(
             ['AE', 'VI', 'MC', 'SM', 'SO', 'DI']
         )->toOptionArray();
     }

◆ getWppPeCcTypesAsOptionArray()

getWppPeCcTypesAsOptionArray ( )

Return list of supported credit card types by Paypal Direct (Payflow Edition) gateway

Returns: array

Definition at line 1302 of file Config.php.

     {
         return $this->_cctypeFactory->create()->setAllowedTypes(
             ['VI', 'MC', 'SM', 'SO', 'AE']
         )->toOptionArray();
     }

◆ getWpsPaymentDeliveryMethods()

getWpsPaymentDeliveryMethods ( )

Payment data delivery methods getter for PayPal Standard

Returns: array

Definition at line 1280 of file Config.php.

     {
         return [self::WPS_TRANSPORT_IPN => __('IPN (Instant Payment Notification) Only')];
     }

◆ isCurrencyCodeSupported()

isCurrencyCodeSupported ( $code )

Check whether specified currency code is supported

Parameters

string $code

Returns: bool

Definition at line 1344 of file Config.php.

     {
         if (in_array($code, $this->_supportedCurrencyCodes)) {
             return true;
         }
         if ($this->getMerchantCountry() == 'BR' && $code == 'BRL') {
             return true;
         }
         if ($this->getMerchantCountry() == 'MY' && $code == 'MYR') {
             return true;
         }
         if ($this->getMerchantCountry() == 'TR' && $code == 'TRY') {
             return true;
         }
         return false;
     }

◆ isMethodAvailable()

isMethodAvailable ( $methodCode = null )

Check whether method available for checkout or not Logic based on merchant country, methods dependence

Parameters

string | null $methodCode

Returns: bool @SuppressWarnings(PHPMD.CyclomaticComplexity)

Definition at line 641 of file Config.php.

     {
         $result = parent::isMethodAvailable($methodCode);
 
         switch ($methodCode) {
             case self::METHOD_WPP_EXPRESS:
             case self::METHOD_WPS_EXPRESS:
                 if ($this->isMethodActive(self::METHOD_PAYFLOWPRO)
                     || $this->isMethodActive(self::METHOD_PAYMENT_PRO)
                 ) {
                     $result = true;
                 }
                 break;
             case self::METHOD_WPP_BML:
             case self::METHOD_WPS_BML:
                 // check for express payments dependence
                 if (!$this->isMethodActive(self::METHOD_WPP_EXPRESS)
                     && !$this->isMethodActive(self::METHOD_WPS_EXPRESS)
                 ) {
                     $result = false;
                 }
                 break;
             case self::METHOD_WPP_PE_EXPRESS:
                 // check for direct payments dependence
                 if ($this->isMethodActive(self::METHOD_PAYFLOWLINK)
                     || $this->isMethodActive(self::METHOD_PAYFLOWADVANCED)
                 ) {
                     $result = true;
                 } elseif (!$this->isMethodActive(self::METHOD_PAYFLOWPRO)) {
                     $result = false;
                 }
                 break;
             case self::METHOD_WPP_PE_BML:
                 // check for express payments dependence
                 if (!$this->isMethodActive(self::METHOD_WPP_PE_EXPRESS)) {
                     $result = false;
                 }
                 break;
             case self::METHOD_BILLING_AGREEMENT:
                 $result = $this->isWppApiAvailabe();
                 break;
         }
         return $result;
     }

◆ isMethodSupportedForCountry()

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

Check whether method supported for specified country or not Use $_methodCode and merchant country by default

Parameters

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

Returns: bool

Definition at line 732 of file Config.php.

     {
         if ($method === null) {
             $method = $this->getMethodCode();
         }
         if ($countryCode === null) {
             $countryCode = $this->getMerchantCountry();
         }
         return in_array($method, $this->getCountryMethods($countryCode));
     }

◆ isOrderReviewStepDisabled()

isOrderReviewStepDisabled ( )

Check whether order review step enabled in configuration

Returns: bool

Definition at line 851 of file Config.php.

     {
         return $this->_scopeConfig->getValue(
             self::XML_PATH_PAYPAL_EXPRESS_SKIP_ORDER_REVIEW_STEP_FLAG,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $this->_storeId
         );
     }

◆ shouldAskToCreateBillingAgreement()

shouldAskToCreateBillingAgreement ( )

Whether to ask customer to create billing agreements Unilateral payments are incompatible with the billing agreements

Returns: bool

Definition at line 1269 of file Config.php.

     {
         return $this->getValue('allow_ba_signup') === self::EC_BA_SIGNUP_ASK
             && !$this->shouldUseUnilateralPayments();
     }

Field Documentation

◆ $_buildNotationPPMap

$_buildNotationPPMap

protected

Initial value:

= [
        'paypal_express' => 'EC',
        'paypal_direct' => 'DP',
        'payflow_express' => 'EC',
    ]

Definition at line 181 of file Config.php.

◆ $_cctypeFactory

$_cctypeFactory

protected

Definition at line 595 of file Config.php.

◆ $_certFactory

$_certFactory

protected

Definition at line 600 of file Config.php.

◆ $_ecStyleConfigMap

$_ecStyleConfigMap

protected

Initial value:

= [
        'page_style' => 'page_style',
        'paypal_hdrimg' => 'hdrimg',
        'paypal_hdrbordercolor' => 'hdrbordercolor',
        'paypal_hdrbackcolor' => 'hdrbackcolor',
        'paypal_payflowcolor' => 'payflowcolor',
    ]

Definition at line 192 of file Config.php.

◆ $_storeManager

$_storeManager

protected

Definition at line 590 of file Config.php.

◆ $_supportedBuyerCountryCodes

$_supportedBuyerCountryCodes

protected

Definition at line 311 of file Config.php.

◆ $_supportedCountryCodes

$_supportedCountryCodes

protected

Definition at line 235 of file Config.php.

◆ $_supportedCurrencyCodes

$_supportedCurrencyCodes

protected

Initial value:

= [
        'AUD',
        'CAD',
        'CZK',
        'DKK',
        'EUR',
        'HKD',
        'HUF',
        'ILS',
        'JPY',
        'MXN',
        'NOK',
        'NZD',
        'PLN',
        'GBP',
        'RUB',
        'SGD',
        'SEK',
        'CHF',
        'TWD',
        'THB',
        'USD',
        'INR',
    ]

Definition at line 205 of file Config.php.

◆ $_supportedImageLocales

$_supportedImageLocales

protected

Initial value:

= [
        'de_DE',
        'en_AU',
        'en_GB',
        'en_US',
        'es_ES',
        'es_XC',
        'fr_FR',
        'fr_XC',
        'it_IT',
        'ja_JP',
        'nl_NL',
        'pl_PL',
        'zh_CN',
        'zh_XC',
    ]

Definition at line 563 of file Config.php.

◆ $directoryHelper

$directoryHelper

protected

Definition at line 585 of file Config.php.

◆ AUTHORIZATION_AMOUNT_FULL

const AUTHORIZATION_AMOUNT_FULL = 2

Definition at line 101 of file Config.php.

◆ AUTHORIZATION_AMOUNT_ONE

const AUTHORIZATION_AMOUNT_ONE = 1

#+ Payment actions

Definition at line 99 of file Config.php.

◆ DEFAULT_LOGO_TYPE

const DEFAULT_LOGO_TYPE = 'wePrefer_150x60'

#-

Definition at line 94 of file Config.php.

◆ EC_BA_SIGNUP_ASK

const EC_BA_SIGNUP_ASK = 'ask'

Definition at line 159 of file Config.php.

◆ EC_BA_SIGNUP_AUTO

const EC_BA_SIGNUP_AUTO = 'auto'

#- #+ Billing Agreement Signup type

Definition at line 157 of file Config.php.

◆ EC_BA_SIGNUP_NEVER

const EC_BA_SIGNUP_NEVER = 'never'

Definition at line 161 of file Config.php.

◆ EC_BUTTON_TYPE_MARK

const EC_BUTTON_TYPE_MARK = 'ecmark'

Definition at line 85 of file Config.php.

◆ EC_BUTTON_TYPE_SHORTCUT

const EC_BUTTON_TYPE_SHORTCUT = 'ecshortcut'

Definition at line 83 of file Config.php.

◆ EC_FLAVOR_DYNAMIC

const EC_FLAVOR_DYNAMIC = 'dynamic'

#+ Buttons and images

Definition at line 79 of file Config.php.

◆ EC_FLAVOR_STATIC

const EC_FLAVOR_STATIC = 'static'

Definition at line 81 of file Config.php.

◆ EC_SOLUTION_TYPE_MARK

const EC_SOLUTION_TYPE_MARK = 'Mark'

Definition at line 139 of file Config.php.

◆ EC_SOLUTION_TYPE_SOLE

const EC_SOLUTION_TYPE_SOLE = 'Sole'

#- #+ Express Checkout flows

Definition at line 137 of file Config.php.

◆ FRAUD_ACTION_ACCEPT

const FRAUD_ACTION_ACCEPT = 'Acept'

#- #+ Fraud management actions

Definition at line 119 of file Config.php.

◆ FRAUD_ACTION_DENY

const FRAUD_ACTION_DENY = 'Deny'

Definition at line 121 of file Config.php.

◆ METHOD_BILLING_AGREEMENT

const METHOD_BILLING_AGREEMENT = 'paypal_billing_agreement'

Definition at line 74 of file Config.php.

◆ METHOD_EXPRESS

const METHOD_EXPRESS = 'paypal_express'

PayPal Express

Definition at line 26 of file Config.php.

◆ METHOD_HOSTEDPRO

const METHOD_HOSTEDPRO = 'hosted_pro'

Definition at line 72 of file Config.php.

◆ METHOD_PAYFLOWADVANCED

const METHOD_PAYFLOWADVANCED = 'payflow_advanced'

Definition at line 70 of file Config.php.

◆ METHOD_PAYFLOWLINK

const METHOD_PAYFLOWLINK = 'payflow_link'

Definition at line 68 of file Config.php.

◆ METHOD_PAYFLOWPRO

const METHOD_PAYFLOWPRO = 'payflowpro'

Payflow Pro Gateway

Definition at line 66 of file Config.php.

◆ METHOD_PAYMENT_PRO

const METHOD_PAYMENT_PRO = 'paypal_payment_pro'

PayPal Website Payments Pro - Direct Payments - alias METHOD_PAYFLOWPRO

Definition at line 51 of file Config.php.

◆ METHOD_WPP_BML

const METHOD_WPP_BML = 'paypal_express_bml'

PayPal Bill Me Later - Express Checkout

Definition at line 41 of file Config.php.

◆ METHOD_WPP_DIRECT

const METHOD_WPP_DIRECT = 'paypal_direct'

PayPal Website Payments Pro - Direct Payments

Definition at line 46 of file Config.php.

◆ METHOD_WPP_PE_BML

const METHOD_WPP_PE_BML = 'payflow_express_bml'

PayPal Bill Me Later - Express Checkout (Payflow Edition)

Definition at line 61 of file Config.php.

◆ METHOD_WPP_PE_EXPRESS

const METHOD_WPP_PE_EXPRESS = 'payflow_express'

Express Checkout (Payflow Edition)

Definition at line 56 of file Config.php.

◆ METHOD_WPS_BML

const METHOD_WPS_BML = 'wps_express_bml'

PayPal Standard Bml - alias METHOD_WPP_BML

Definition at line 36 of file Config.php.

◆ METHOD_WPS_EXPRESS

const METHOD_WPS_EXPRESS = 'wps_express'

PayPal Standard - alias METHOD_WPP_EXPRESS

Definition at line 31 of file Config.php.

◆ PAYMENT_MARK_LARGE

const PAYMENT_MARK_LARGE = 'large'

Definition at line 91 of file Config.php.

◆ PAYMENT_MARK_MEDIUM

const PAYMENT_MARK_MEDIUM = 'medium'

Definition at line 89 of file Config.php.

◆ PAYMENT_MARK_SMALL

const PAYMENT_MARK_SMALL = 'small'

Definition at line 87 of file Config.php.

◆ REFUND_TYPE_FULL

const REFUND_TYPE_FULL = 'Full'

#- #+ Refund types

Definition at line 128 of file Config.php.

◆ REFUND_TYPE_PARTIAL

const REFUND_TYPE_PARTIAL = 'Partial'

Definition at line 130 of file Config.php.

◆ REQUIRE_BILLING_ADDRESS_ALL

const REQUIRE_BILLING_ADDRESS_ALL = 1

Definition at line 110 of file Config.php.

◆ REQUIRE_BILLING_ADDRESS_NO

const REQUIRE_BILLING_ADDRESS_NO = 0

#- #+ Require Billing Address

Definition at line 108 of file Config.php.

◆ REQUIRE_BILLING_ADDRESS_VIRTUAL

const REQUIRE_BILLING_ADDRESS_VIRTUAL = 2

Definition at line 112 of file Config.php.

◆ TRANSFER_CART_LINE_ITEMS

const TRANSFER_CART_LINE_ITEMS = 'lineItemsEnabled'

Paypal setting

Definition at line 166 of file Config.php.

◆ TRANSFER_SHIPPING_OPTIONS

const TRANSFER_SHIPPING_OPTIONS = 'transferShippingOptions'

Definition at line 167 of file Config.php.

◆ WPS_TRANSPORT_IPN

const WPS_TRANSPORT_IPN = 'ipn'

#- #+ Payment data transfer methods (Standard)

Definition at line 146 of file Config.php.

◆ WPS_TRANSPORT_IPN_PDT

const WPS_TRANSPORT_IPN_PDT = 'ipn_n_pdt'

Definition at line 150 of file Config.php.

◆ WPS_TRANSPORT_PDT

const WPS_TRANSPORT_PDT = 'pdt'

Definition at line 148 of file Config.php.

◆ XML_PATH_PAYPAL_EXPRESS_SKIP_ORDER_REVIEW_STEP_FLAG

const XML_PATH_PAYPAL_EXPRESS_SKIP_ORDER_REVIEW_STEP_FLAG = 'payment/paypal_express/skip_order_review_step'

#- Config path for enabling/disabling order review step in express checkout

Definition at line 174 of file Config.php.

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getDynamicImageUrl()

◆ _getSpecificConfigPath()

◆ _getSupportedLocaleCode()

◆ _mapBmlFieldset()

◆ _mapBmlPayflowFieldset()

◆ _mapDirectFieldset()

◆ _mapExpressFieldset()

◆ _mapGeneralFieldset()

◆ _mapGenericStyleFieldset()

◆ _mapMethodFieldset()

◆ _mapWppFieldset()

◆ _mapWpukFieldset()

◆ areButtonsDynamic()

◆ exportExpressCheckoutStyleSettings()

◆ getAdditionalOptionsLogoTypes()

◆ getAdditionalOptionsLogoUrl()

◆ getApiAuthenticationMethods()

◆ getApiCertificate()

◆ getBmlDisplay()

◆ getBmlPosition()

◆ getBmlPublisherId()

◆ getBmlSize()

◆ getCountryMethods()

◆ getExpressCheckoutBASignupOptions()

◆ getExpressCheckoutButtonFlavors()

◆ getExpressCheckoutButtonTypes()

◆ getExpressCheckoutCompleteUrl()

◆ getExpressCheckoutEditUrl()

◆ getExpressCheckoutInContextImageUrl()

◆ getExpressCheckoutOrderUrl()

◆ getExpressCheckoutShortcutImageUrl()

◆ getExpressCheckoutSolutionTypes()

◆ getExpressCheckoutStartUrl()

◆ getIsCreditCardMethod()

◆ getMerchantCountry()

◆ getPayflowproCcTypesAsOptionArray()

◆ getPaymentAction()

◆ getPaymentActions()

◆ getPaymentFormLogoUrl()

◆ getPaymentMarkImageUrl()

◆ getPaymentMarkWhatIsPaypalUrl()

◆ getPayPalBasicStartUrl()

◆ getPayPalIpnUrl()

◆ getPaypalUrl()

◆ getRequireBillingAddressOptions()

◆ getSolutionImageUrl()

◆ getStartBillingAgreementUrl()

◆ getSupportedBuyerCountryCodes()

◆ getSupportedMerchantCountryCodes()

◆ getWppCcTypesAsOptionArray()

◆ getWppPeCcTypesAsOptionArray()

◆ getWpsPaymentDeliveryMethods()

◆ isCurrencyCodeSupported()

◆ isMethodAvailable()

◆ isMethodSupportedForCountry()

◆ isOrderReviewStepDisabled()

◆ shouldAskToCreateBillingAgreement()

Field Documentation

◆ $_buildNotationPPMap

◆ $_cctypeFactory

◆ $_certFactory

◆ $_ecStyleConfigMap

◆ $_storeManager

◆ $_supportedBuyerCountryCodes

◆ $_supportedCountryCodes

◆ $_supportedCurrencyCodes

◆ $_supportedImageLocales

◆ $directoryHelper

◆ AUTHORIZATION_AMOUNT_FULL

◆ AUTHORIZATION_AMOUNT_ONE

◆ DEFAULT_LOGO_TYPE