Class Mage_Paypal_Model_Config

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

Direct known subclasses

Mage_XmlConnect_Model_Payment_Method_Paypal_Config

Package: Mage\Paypal
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Located at code/core/Mage/Paypal/Model/Config.php

Methods summary
`public`	# `__construct( array $params = array() )` Set method and store id, if specified Set method and store id, if specified Parameters `$params` `array` $params
`public Mage_Paypal_Model_Config`	# `setMethod( string\|Mage_Payment_Model_Method_Abstract $method )` Method code setter Method code setter Parameters `$method` `string\|Mage_Payment_Model_Method_Abstract` $method Returns `Mage_Paypal_Model_Config`
`public string`	# `getMethodCode( )` Payment method instance code getter Payment method instance code getter Returns `string`
`public Mage_Paypal_Model_Config`	# `setStoreId( integer $storeId )` Store ID setter Store ID setter Parameters `$storeId` `integer` $storeId Returns `Mage_Paypal_Model_Config`
`public boolean`	# `isMethodActive( string $method )` Check whether method active in configuration and supported for merchant country or not Check whether method active in configuration and supported for merchant country or not Parameters `$method` `string` $method Method code Returns `boolean`
`public boolean`	# `isMethodAvailable( string $methodCode = null )` Check whether method available for checkout or not Logic based on merchant country, methods dependence Check whether method available for checkout or not Logic based on merchant country, methods dependence Parameters `$methodCode` `string` $method Method code Returns `boolean`
`public string\|null`	# `__get( string $key )` Config field magic getter The specified key can be either in camelCase or under_score format Tries to map specified value according to set payment method code, into the configuration value Sets the values into public class parameters, to avoid redundant calls of this method Config field magic getter The specified key can be either in camelCase or under_score format Tries to map specified value according to set payment method code, into the configuration value Sets the values into public class parameters, to avoid redundant calls of this method Parameters `$key` `string` $key Returns `string\|null`
`protected string`	# `_prepareValue( string $key, string $value )` Perform additional config value preparation and return new value if needed Perform additional config value preparation and return new value if needed Parameters `$key` `string` $key Underscored key `$value` `string` $value Old value Returns `string` Modified value or old value
`public array`	# `getSupportedMerchantCountryCodes( )` Return merchant country codes supported by PayPal Return merchant country codes supported by PayPal Returns `array`
`public array`	# `getSupportedBuyerCountryCodes( )` Return buyer country codes supported by PayPal Return buyer country codes supported by PayPal Returns `array`
`public string`	# `getMerchantCountry( )` Return merchant country code, use default country if it not specified in General settings Return merchant country code, use default country if it not specified in General settings Returns `string`
`public boolean`	# `isMethodSupportedForCountry( mixed $method = null, mixed $countryCode = null )` Check whether method supported for specified country or not Use $_methodCode and merchant country by default Check whether method supported for specified country or not Use $_methodCode and merchant country by default Returns `boolean`
`public array`	# `getCountryMethods( string $countryCode = null )` Return list of allowed methods for specified country iso code Return list of allowed methods for specified country iso code Parameters `$countryCode` `string` $countryCode 2-letters iso code Returns `array`
`public string`	# `getExpressCheckoutStartUrl( string $token )` Get url for dispatching customer to express checkout start Get url for dispatching customer to express checkout start Parameters `$token` `string` $token Returns `string`
`public string`	# `getExpressCheckoutEditUrl( mixed $token )` Get url that allows to edit checkout details on paypal side Get url that allows to edit checkout details on paypal side Parameters `$token` `mixed` $token Returns `string`
`public string`	# `getExpressCheckoutCompleteUrl( string $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. 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 `$token` `string` $token Returns `string`
`public string`	# `getStartBillingAgreementUrl( string $token )` Retrieve url for initialization of billing agreement Retrieve url for initialization of billing agreement Parameters `$token` `string` $token Returns `string`
`public string`	# `getPaypalUrl( array $params = array() )` PayPal web URL generic getter PayPal web URL generic getter Parameters `$params` `array` $params Returns `string`
`public boolean`	# `areButtonsDynamic( )` Whether Express Checkout button should be rendered dynamically Whether Express Checkout button should be rendered dynamically Returns `boolean`
`public`	# `getExpressCheckoutShortcutImageUrl( string $localeCode, float $orderTotal = null, string $pal = null )` Express checkout shortcut pic URL getter PayPal will ignore "pal", if there is no total amount specified Express checkout shortcut pic URL getter PayPal will ignore "pal", if there is no total amount specified Parameters `$localeCode` `string` $localeCode `$orderTotal` `float` $orderTotal `$pal` `string` $pal encrypted summary about merchant See Paypal_Model_Api_Nvp::callGetPalDetails()
`public`	# `getPaymentMarkImageUrl( string $localeCode, float $orderTotal = null, string $pal = null, string $staticSize = null )` Get PayPal "mark" image URL Supposed to be used on payment methods selection $staticSize is applicable for static images only Get PayPal "mark" image URL Supposed to be used on payment methods selection $staticSize is applicable for static images only Parameters `$localeCode` `string` $localeCode `$orderTotal` `float` $orderTotal `$pal` `string` $pal `$staticSize` `string` $staticSize
`public`	# `getPaymentMarkWhatIsPaypalUrl( Mage_Core_Model_Locale $locale = null )` Get "What Is PayPal" localized URL Supposed to be used with "mark" as popup window Get "What Is PayPal" localized URL Supposed to be used with "mark" as popup window Parameters `$locale` `Mage_Core_Model_Locale` $locale
`public`	# `getSolutionImageUrl( string $localeCode, boolean $isVertical = false, boolean $isEcheck = false )` Getter for Solution banner images Getter for Solution banner images Parameters `$localeCode` `string` $localeCode `$isVertical` `boolean` $isVertical `$isEcheck` `boolean` $isEcheck
`public`	# `getPaymentFormLogoUrl( string $localeCode )` Getter for Payment form logo images Getter for Payment form logo images Parameters `$localeCode` `string` $localeCode
`public array`	# `getAdditionalOptionsLogoTypes( )` Return supported types for PayPal logo Return supported types for PayPal logo Returns `array`
`public string\|boolean`	# `getAdditionalOptionsLogoUrl( string $localeCode, string $type = false )` Return PayPal logo URL with additional options Return PayPal logo URL with additional options Parameters `$localeCode` `string` $localeCode Supported locale code `$type` `string` $type One of supported logo types Returns `string\|boolean` Logo Image URL or false if logo disabled in configuration
`public`	# `getBuildNotationCode( string $countryCode = null )` BN code getter BN code getter Parameters `$countryCode` `string` $countryCode ISO 3166-1
`public array`	# `getExpressCheckoutButtonFlavors( )` Express Checkout button "flavors" source getter Express Checkout button "flavors" source getter Returns `array`
`public array`	# `getExpressCheckoutButtonTypes( )` Express Checkout button types source getter Express Checkout button types source getter Returns `array`
`public array`	# `getPaymentActions( )` Payment actions source getter Payment actions source getter Returns `array`
`public array`	# `getRequireBillingAddressOptions( )` Require Billing Address source getter Require Billing Address source getter Returns `array`
`public string\|null`	# `getPaymentAction( )` Mapper from PayPal-specific payment actions to Magento payment actions Mapper from PayPal-specific payment actions to Magento payment actions Returns `string\|null`
`public array`	# `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 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`
`public array`	# `getExpressCheckoutBASignupOptions( )` Retrieve express checkout billing agreement signup options Retrieve express checkout billing agreement signup options Returns `array`
`public boolean`	# `shouldAskToCreateBillingAgreement( )` Whether to ask customer to create billing agreements Unilateral payments are incompatible with the billing agreements Whether to ask customer to create billing agreements Unilateral payments are incompatible with the billing agreements Returns `boolean`
`public boolean`	# `shouldUseUnilateralPayments( )` Check whether only Unilateral payments (Accelerated Boarding) possible for Express method or not Check whether only Unilateral payments (Accelerated Boarding) possible for Express method or not Returns `boolean`
`public boolean`	# `isWppApiAvailabe( )` Check whether WPP API credentials are available for this method Check whether WPP API credentials are available for this method Returns `boolean`
`public array`	# `getWpsPaymentDeliveryMethods( )` Payment data delivery methods getter for PayPal Standard Payment data delivery methods getter for PayPal Standard Returns `array`
`public array`	# `getWppCcTypesAsOptionArray( )` Return list of supported credit card types by Paypal Direct gateway Return list of supported credit card types by Paypal Direct gateway Returns `array`
`public array`	# `getWppPeCcTypesAsOptionArray( )` Return list of supported credit card types by Paypal Direct (Payflow Edition) gateway Return list of supported credit card types by Paypal Direct (Payflow Edition) gateway Returns `array`
`public array`	# `getPayflowproCcTypesAsOptionArray( )` Return list of supported credit card types by Payflow Pro gateway Return list of supported credit card types by Payflow Pro gateway Returns `array`
`public static boolean`	# `getIsCreditCardMethod( string $code )` Check whether the specified payment method is a CC-based one Check whether the specified payment method is a CC-based one Parameters `$code` `string` $code Returns `boolean`
`public boolean`	# `isCurrencyCodeSupported( string $code )` Check whether specified currency code is supported Check whether specified currency code is supported Parameters `$code` `string` $code Returns `boolean`
`public`	# `exportExpressCheckoutStyleSettings( Varien_Object $to )` Export page style current settings to specified object Export page style current settings to specified object Parameters `$to` `Varien_Object` $to
`protected`	# `_getDynamicImageUrl( string $type, string $localeCode, float $orderTotal, string $pal )` Dynamic PayPal image URL getter Also can render dynamic Acceptance Mark Dynamic PayPal image URL getter Also can render dynamic Acceptance Mark Parameters `$type` `string` $type `$localeCode` `string` $localeCode `$orderTotal` `float` $orderTotal `$pal` `string` $pal
`protected string`	# `_getSupportedLocaleCode( string $localeCode = null )` Check whether specified locale code is supported. Fallback to en_US Check whether specified locale code is supported. Fallback to en_US Parameters `$localeCode` `string` $localeCode Returns `string`
`protected string\|null`	# `_getSpecificConfigPath( string $fieldName )` Map any supported payment method into a config path by specified field name Map any supported payment method into a config path by specified field name Parameters `$fieldName` `string` $fieldName Returns `string\|null`
`private string\|null`	# `_matchBnCountryCode( mixed $code )` Check wheter specified country code is supported by build notation codes for specific countries Check wheter specified country code is supported by build notation codes for specific countries Parameters `$code` `mixed` $code Returns `string\|null`
`protected string\|null`	# `_mapStandardFieldset( string $fieldName )` Map PayPal Standard config fields Map PayPal Standard config fields Parameters `$fieldName` `string` $fieldName Returns `string\|null`
`protected string\|null`	# `_mapExpressFieldset( string $fieldName )` Map PayPal Express config fields Map PayPal Express config fields Parameters `$fieldName` `string` $fieldName Returns `string\|null`
`protected string\|null`	# `_mapDirectFieldset( string $fieldName )` Map PayPal Direct config fields Map PayPal Direct config fields Parameters `$fieldName` `string` $fieldName Returns `string\|null`
`protected string\|null`	# `_mapWppFieldset( string $fieldName )` Map PayPal Website Payments Pro common config fields Map PayPal Website Payments Pro common config fields Parameters `$fieldName` `string` $fieldName Returns `string\|null`
`protected string\|null`	# `_mapWpukFieldset( string $fieldName )` Map PayPal Website Payments Pro common config fields Map PayPal Website Payments Pro common config fields Parameters `$fieldName` `string` $fieldName Returns `string\|null`
`protected string\|null`	# `_mapGenericStyleFieldset( string $fieldName )` Map PayPal common style config fields Map PayPal common style config fields Parameters `$fieldName` `string` $fieldName Returns `string\|null`
`protected string\|null`	# `_mapGeneralFieldset( string $fieldName )` Map PayPal General Settings Map PayPal General Settings Parameters `$fieldName` `string` $fieldName Returns `string\|null`
`protected string\|null`	# `_mapMethodFieldset( string $fieldName )` Map PayPal General Settings Map PayPal General Settings Parameters `$fieldName` `string` $fieldName Returns `string\|null`
`public array`	# `getApiAuthenticationMethods( )` Payment API authentication methods source getter Payment API authentication methods source getter Returns `array`
`public string`	# `getApiCertificate( )` Api certificate getter Api certificate getter Returns `string`

Constants summary
`string`	`METHOD_WPS`	`'paypal_standard'`	# PayPal Standard PayPal Standard
`string`	`METHOD_WPP_EXPRESS`	`'paypal_express'`	# PayPal Website Payments Pro - Express Checkout PayPal Website Payments Pro - Express Checkout
`string`	`METHOD_WPP_DIRECT`	`'paypal_direct'`	# PayPal Website Payments Pro - Direct Payments PayPal Website Payments Pro - Direct Payments
`string`	`METHOD_WPP_PE_DIRECT`	`'paypaluk_direct'`	# Direct Payments (Payflow Edition) Direct Payments (Payflow Edition)
`string`	`METHOD_WPP_PE_EXPRESS`	`'paypaluk_express'`	# Express Checkout (Payflow Edition) Express Checkout (Payflow Edition)
`string`	`METHOD_PAYFLOWPRO`	`'verisign'`	# Payflow Pro Gateway Payflow Pro Gateway
`string`	`METHOD_PAYFLOWLINK`	`'payflow_link'`	#
`string`	`METHOD_PAYFLOWADVANCED`	`'payflow_advanced'`	#
`string`	`METHOD_HOSTEDPRO`	`'hosted_pro'`	#
`string`	`METHOD_BILLING_AGREEMENT`	`'paypal_billing_agreement'`	#
`string`	`EC_FLAVOR_DYNAMIC`	`'dynamic'`	# Buttons and images Buttons and images
`string`	`EC_FLAVOR_STATIC`	`'static'`	#
`string`	`EC_BUTTON_TYPE_SHORTCUT`	`'ecshortcut'`	#
`string`	`EC_BUTTON_TYPE_MARK`	`'ecmark'`	#
`string`	`PAYMENT_MARK_37x23`	`'37x23'`	#
`string`	`PAYMENT_MARK_50x34`	`'50x34'`	#
`string`	`PAYMENT_MARK_60x38`	`'60x38'`	#
`string`	`PAYMENT_MARK_180x113`	`'180x113'`	#
`string`	`DEFAULT_LOGO_TYPE`	`'wePrefer_150x60'`	#
`string`	`PAYMENT_ACTION_SALE`	`'Sale'`	# Payment actions Payment actions
`string`	`PAYMENT_ACTION_ORDER`	`'Order'`	#
`string`	`PAYMENT_ACTION_AUTH`	`'Authorization'`	#
`integer`	`AUTHORIZATION_AMOUNT_ONE`	`1`	#
`integer`	`AUTHORIZATION_AMOUNT_FULL`	`2`	#
`integer`	`REQUIRE_BILLING_ADDRESS_NO`	`0`	# Require Billing Address Require Billing Address
`integer`	`REQUIRE_BILLING_ADDRESS_ALL`	`1`	#
`integer`	`REQUIRE_BILLING_ADDRESS_VIRTUAL`	`2`	#
`string`	`FRAUD_ACTION_ACCEPT`	`'Acept'`	# Fraud management actions Fraud management actions
`string`	`FRAUD_ACTION_DENY`	`'Deny'`	#
`string`	`REFUND_TYPE_FULL`	`'Full'`	# Refund types Refund types
`string`	`REFUND_TYPE_PARTIAL`	`'Partial'`	#
`string`	`EC_SOLUTION_TYPE_SOLE`	`'Sole'`	# Express Checkout flows Express Checkout flows
`string`	`EC_SOLUTION_TYPE_MARK`	`'Mark'`	#
`string`	`WPS_TRANSPORT_IPN`	`'ipn'`	# Payment data transfer methods (Standard) Payment data transfer methods (Standard)
`string`	`WPS_TRANSPORT_PDT`	`'pdt'`	#
`string`	`WPS_TRANSPORT_IPN_PDT`	`'ipn_n_pdt'`	#
`string`	`EC_BA_SIGNUP_AUTO`	`'auto'`	# Billing Agreement Signup Billing Agreement Signup
`string`	`EC_BA_SIGNUP_ASK`	`'ask'`	#
`string`	`EC_BA_SIGNUP_NEVER`	`'never'`	#

Properties summary
`public string`	`$centinelDefaultApiUrl`	`'https://paypal.cardinalcommerce.com/maps/txns.asp'`	# Default URL for centinel API (PayPal Direct) Default URL for centinel API (PayPal Direct)
`protected string`	`$_methodCode`	`null`	# Current payment method code Current payment method code
`protected integer`	`$_storeId`	`null`	# Current store id Current store id
`protected array`	`$_buildNotationPPMap`	`array( 'paypal_standard' => 'WPS', 'paypal_express' => 'EC', 'paypal_direct' => 'DP', 'paypaluk_express' => 'EC', 'paypaluk_direct' => 'DP', )`	# Instructions for generating proper BN code Instructions for generating proper BN code
`protected array`	`$_ecStyleConfigMap`	`array( 'page_style' => 'page_style', 'paypal_hdrimg' => 'hdrimg', 'paypal_hdrbordercolor' => 'hdrbordercolor', 'paypal_hdrbackcolor' => 'hdrbackcolor', 'paypal_payflowcolor' => 'payflowcolor', )`	# Style system config map (Express Checkout) Style system config map (Express Checkout)
`protected array`	`$_supportedCurrencyCodes`	`array('AUD', 'CAD', 'CZK', 'DKK', 'EUR', 'HKD', 'HUF', 'ILS', 'JPY', 'MXN', 'NOK', 'NZD', 'PLN', 'GBP', 'SGD', 'SEK', 'CHF', 'USD', 'TWD', 'THB')`	# Currency codes supported by PayPal methods Currency codes supported by PayPal methods
`protected array`	`$_supportedCountryCodes`	`array( 'AE','AR','AT','AU','BE','BG','BR','CA','CH','CL','CR','CY','CZ','DE','DK','DO','EC','EE','ES','FI','FR','GB', 'GF','GI','GP','GR','HK','HU','ID','IE','IL','IN','IS','IT','JM','JP','KR','LI','LT','LU','LV','MQ','MT','MX', 'MY','NL','NO','NZ','PH','PL','PT','RE','RO','SE','SG','SI','SK','SM','TH','TR','TW','US','UY','VE','VN','ZA')`	# Merchant country supported by PayPal Merchant country supported by PayPal
`protected array`	`$_supportedBuyerCountryCodes`	array( 'AF ', 'AX ', 'AL ', 'DZ ', 'AS ', 'AD ', 'AO ', 'AI ', 'AQ ', 'AG ', 'AR ', 'AM ', 'AW ', 'AU ', 'AT ', 'AZ ', 'BS ', 'BH ', 'BD ', 'BB ', 'BY ', 'BE ', 'BZ ', 'BJ ', 'BM ', 'BT ', 'BO ', 'BA ', 'BW ', 'BV ', 'BR ', 'IO ', 'BN ', 'BG ', 'BF ', 'BI ', 'KH ', 'CM ', 'CA ', 'CV ', 'KY ', 'CF ', 'TD ', 'CL ', 'CN ', 'CX ', 'CC ', 'CO ', 'KM ', 'CG ', 'CD ', 'CK ', 'CR ', 'CI ', 'HR ', 'CU ', 'CY ', 'CZ ', 'DK ', 'DJ ', 'DM ', 'DO ', 'EC ', 'EG ', 'SV ', 'GQ ', 'ER ', 'EE ', 'ET ', 'FK ', 'FO ', 'FJ ', 'FI ', 'FR ', 'GF ', 'PF ', 'TF ', 'GA ', 'GM ', 'GE ', 'DE ', 'GH ', 'GI ', 'GR ', 'GL ', 'GD ', 'GP ', 'GU ', 'GT ', 'GG ', 'GN ', 'GW ', 'GY ', 'HT ', 'HM ', 'VA ', 'HN ', 'HK ', 'HU ', 'IS ', 'IN ', 'ID ', 'IR ', 'IQ ', 'IE ', 'IM ', 'IL ', 'IT ', 'JM ', 'JP ', 'JE ', 'JO ', 'KZ ', 'KE ', 'KI ', 'KP ', 'KR ', 'KW ', 'KG ', 'LA ', 'LV ', 'LB ', 'LS ', 'LR ', 'LY ', 'LI ', 'LT ', 'LU ', 'MO ', 'MK ', 'MG ', 'MW ', 'MY ', 'MV ', 'ML ', 'MT ', 'MH ', 'MQ ', 'MR ', 'MU ', 'YT ', 'MX ', 'FM ', 'MD ', 'MC ', 'MN ', 'MS ', 'MA ', 'MZ ', 'MM ', 'NA ', 'NR ', 'NP ', 'NL ', 'AN ', 'NC ', 'NZ ', 'NI ', 'NE ', 'NG ', 'NU ', 'NF ', 'MP ', 'NO ', 'OM ', 'PK ', 'PW ', 'PS ', 'PA ', 'PG ', 'PY ', 'PE ', 'PH ', 'PN ', 'PL ', 'PT ', 'PR ', 'QA ', 'RE ', 'RO ', 'RU ', 'RW ', 'SH ', 'KN ', 'LC ', 'PM ', 'VC ', 'WS ', 'SM ', 'ST ', 'SA ', 'SN ', 'CS ', 'SC ', 'SL ', 'SG ', 'SK ', 'SI ', 'SB ', 'SO ', 'ZA ', 'GS ', 'ES ', 'LK ', 'SD ', 'SR ', 'SJ ', 'SZ ', 'SE ', 'CH ', 'SY ', 'TW ', 'TJ ', 'TZ ', 'TH ', 'TL ', 'TG ', 'TK ', 'TO ', 'TT ', 'TN ', 'TR ', 'TM ', 'TC ', 'TV ', 'UG ', 'UA ', 'AE ', 'GB ', 'US ', 'UM ', 'UY ', 'UZ ', 'VU ', 'VE ', 'VN ', 'VG ', 'VI ', 'WF ', 'EH ', 'YE ', 'ZM ', 'ZW' )	# Buyer country supported by PayPal Buyer country supported by PayPal
`protected array`	`$_supportedImageLocales`	`array('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', )`	# Locale codes supported by misc images (marks, shortcuts etc) Locale codes supported by misc images (marks, shortcuts etc) Link https://cms.paypal.com/us/cgi-bin/?cmd=_render-content&content_ID=developer/e_howto_api_ECButtonIntegration#id089QD0O0TX4__id08AH904I0YK

Packages

Classes

Exceptions

Class Mage_Paypal_Model_Config

Direct known subclasses

Parameters

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

See

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns