Class Mage_Paypal_Model_Api_Abstract

Abstract class for Paypal API wrappers

Varien_Object

Mage_Paypal_Model_Api_Abstract

Direct known subclasses

Mage_Paypal_Model_Api_Nvp, Mage_Paypal_Model_Api_Standard

Indirect known subclasses

Abstract
Package: Mage\Paypal
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Paypal/Model/Api/Abstract.php

Methods summary
`public string`	# `getApiUsername( )` Return Paypal Api user name based on config data Return Paypal Api user name based on config data Returns `string`
`public string`	# `getApiPassword( )` Return Paypal Api password based on config data Return Paypal Api password based on config data Returns `string`
`public string`	# `getApiSignature( )` Return Paypal Api signature based on config data Return Paypal Api signature based on config data Returns `string`
`public string`	# `getApiCertificate( )` Return Paypal Api certificate based on config data Return Paypal Api certificate based on config data Returns `string`
`public string`	# `getBuildNotationCode( )` BN code getter BN code getter Returns `string`
`public boolean`	# `getUseProxy( )` Return Paypal Api proxy status based on config data Return Paypal Api proxy status based on config data Returns `boolean`
`public string`	# `getProxyHost( )` Return Paypal Api proxy host based on config data Return Paypal Api proxy host based on config data Returns `string`
`public string`	# `getProxyPort( )` Return Paypal Api proxy port based on config data Return Paypal Api proxy port based on config data Returns `string`
`public string`	# `getPageStyle( )` PayPal page CSS getter PayPal page CSS getter Returns `string`
`public string`	# `getHdrimg( )` PayPal page header image URL getter PayPal page header image URL getter Returns `string`
`public string`	# `getHdrbordercolor( )` PayPal page header border color getter PayPal page header border color getter Returns `string`
`public string`	# `getHdrbackcolor( )` PayPal page header background color getter PayPal page header background color getter Returns `string`
`public string`	# `getPayflowcolor( )` PayPal page "payflow color" (?) getter PayPal page "payflow color" (?) getter Returns `string`
`public string`	# `getPaymentAction( )` Payment action getter Payment action getter Returns `string`
`public`	# `getBusinessAccount( )` PayPal merchant email getter PayPal merchant email getter
`public array\|Varien_Object &`	# `import( array\|Varien_Object $to, array $publicMap = array() )` Import $this public data to specified object or array Import $this public data to specified object or array Parameters `$to` `array\|Varien_Object` $to `$publicMap` `array` $publicMap Returns `array\|Varien_Object`
`public Mage_Paypal_Model_Api_Abstract`	# `export( array\|Varien_Object $from, array $publicMap = array() )` Export $this public data from specified object or array Export $this public data from specified object or array Parameters `$from` `array\|Varien_Object` $from `$publicMap` `array` $publicMap Returns `Mage_Paypal_Model_Api_Abstract`
`public Mage_Paypal_Model_Api_Abstract`	# `setPaypalCart( Mage_Paypal_Model_Cart $cart )` Set PayPal cart instance Set PayPal cart instance Parameters `$cart` `Mage_Paypal_Model_Cart` $cart Returns `Mage_Paypal_Model_Api_Abstract`
`public Mage_Paypal_Model_Api_Abstract`	# `setConfigObject( Mage_Paypal_Model_Config $config )` Config instance setter Config instance setter Parameters `$config` `Mage_Paypal_Model_Config` $config Returns `Mage_Paypal_Model_Api_Abstract`
`public string`	# `getLocaleCode( )` Current locale code getter Current locale code getter Returns `string`
`public`	# `getFraudManagementFiltersEnabled( )` Always take into accoun Always take into accoun
`public Mage_Paypal_Model_Api_Abstract`	# `addRecurringPaymentProfiles( array $items )` Set recurring profiles Set recurring profiles Parameters `$items` `array` $items Returns `Mage_Paypal_Model_Api_Abstract`
`protected array &`	# `_exportToRequest( array $privateRequestMap, array $request = array() )` Export $this public data to private request array Export $this public data to private request array Parameters `$privateRequestMap` `array` $internalRequestMap `$request` `array` $request Returns `array`
`protected`	# `_importFromResponse( array $privateResponseMap, array $response )` Import $this public data from a private response array Import $this public data from a private response array Parameters `$privateResponseMap` `array` $privateResponseMap `$response` `array` $response
`protected true\|boolean`	# `_exportLineItems( array & $request, integer $i = 0 )` Prepare line items request Prepare line items request Returns true if there were line items added Parameters `$request` `array` &$request `$i` `integer` $i Returns `true\|boolean`
`protected boolean`	# `_exportShippingOptions( array & $request, integer $i = 0 )` Prepare shipping options request Returns false if there are no shipping options Prepare shipping options request Returns false if there are no shipping options Parameters `$request` `array` &$request `$i` `integer` $i Returns `boolean`
`protected string`	# `_filterAmount( float\|string $value )` Filter amounts in API calls Filter amounts in API calls Parameters `$value` `float\|string` $value Returns `string`
`protected string`	# `_filterBool( mixed $value )` Filter boolean values in API calls Filter boolean values in API calls Parameters `$value` `mixed` $value Returns `string`
`protected integer`	# `_filterInt( mixed $value )` Filter int values in API calls Filter int values in API calls Parameters `$value` `mixed` $value Returns `integer`
`protected mixed`	# `_getDataOrConfig( string $key, mixed $default = null )` Unified getter that looks in data or falls back to config Unified getter that looks in data or falls back to config Parameters `$key` `string` $key `$default` `mixed` $default Returns `mixed`
`protected string`	# `_lookupRegionCodeFromAddress( Varien_Object $address )` region_id workaround: PayPal requires state code, try to find one in the address region_id workaround: PayPal requires state code, try to find one in the address Parameters `$address` `Varien_Object` $address Returns `string`
`protected`	# `_importStreetFromAddress( Varien_Object $address, array & $to )` Street address workaround: divides address lines into parts by specified keys (keys should go as 3rd, 4th[...] parameters) Street address workaround: divides address lines into parts by specified keys (keys should go as 3rd, 4th[...] parameters) Parameters `$address` `Varien_Object` $address `$to` `array` $request
`protected string`	# `_buildQuery( array $request )` Build query string from request Build query string from request Parameters `$request` `array` $request Returns `string`
`protected string`	# `_filterQty( float\|string\|integer $value )` Filter qty in API calls Paypal note: The value for quantity must be a positive integer. Null, zero, or negative numbers are not allowed. Filter qty in API calls Paypal note: The value for quantity must be a positive integer. Null, zero, or negative numbers are not allowed. Parameters `$value` `float\|string\|integer` $value Returns `string`
`protected`	# `_debug( mixed $debugData )` Log debug data to file Log debug data to file Parameters `$debugData` `mixed` $debugData
`public boolean`	# `getDebugFlag( )` Define if debugging is enabled Define if debugging is enabled Returns `boolean`
`public boolean`	# `getUseCertAuthentication( )` Check whether API certificate authentication should be used Check whether API certificate authentication should be used Returns `boolean`

Properties summary
`protected Mage_Paypal_Model_Config`	`$_config`	`null`	# Config instance Config instance
`protected array`	`$_globalMap`	`array()`	# Global private to public interface map Global private to public interface map
`protected array`	`$_exportToRequestFilters`	`array()`	# Filter callbacks for exporting $this data to API call Filter callbacks for exporting $this data to API call
`protected array`	`$_importFromRequestFilters`	`array()`	# Filter callbacks for importing API result to $this data Filter callbacks for importing API result to $this data
`protected array`	`$_lineItemExportItemsFormat`	`array()`	# Line items export to request mapping settings Line items export to request mapping settings
`protected array`	`$_lineItemExportItemsFilters`	`array()`	#
`protected array`	`$_lineItemTotalExportMap`	`array()`	#
`protected Mage_Paypal_Model_Cart`	`$_cart`	`null`	# PayPal shopping cart instance PayPal shopping cart instance
`protected array`	`$_shippingOptionsExportItemsFormat`	`array()`	# Shipping options export to request mapping settings Shipping options export to request mapping settings
`protected array`	`$_recurringPaymentProfiles`	`array()`	# Imported recurring profiles array Imported recurring profiles array
`protected array`	`$_debugReplacePrivateDataKeys`	`array()`	# Fields that should be replaced in debug with '*' Fields that should be replaced in debug with '*'

Packages

Classes

Exceptions

Class Mage_Paypal_Model_Api_Abstract

Direct known subclasses

Indirect known subclasses

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns