Class Mage_Paypal_Model_Api_Abstract

Description
Description | Descendents | Vars (details) | Methods (details)

Abstract class for Paypal API wrappers

Located in /Paypal/Model/Api/Abstract.php (line 32) 

Varien_Object
   |
   --Mage_Paypal_Model_Api_Abstract
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
Mage_Paypal_Model_Api_Standard PayPal Standard checkout request API
Mage_Paypal_Model_Api_Nvp NVP API wrappers model
Variable Summary
Description | Descendents | Vars (details) | Methods (details)
Mage_Paypal_Model_Cart $_cart
Mage_Paypal_Model_Config $_config
array $_debugReplacePrivateDataKeys
array $_exportToRequestFilters
array $_globalMap
array $_importFromRequestFilters
mixed $_lineItemExportItemsFilters
array $_lineItemExportItemsFormat
mixed $_lineItemTotalExportMap
array $_recurringPaymentProfiles
array $_shippingOptionsExportItemsFormat
Method Summary
Description | Descendents | Vars (details) | Methods (details)
Mage_Paypal_Model_Api_Abstract addRecurringPaymentProfiles ( $items)
Mage_Paypal_Model_Api_Abstract export (array|Varien_Object $from, [ $publicMap = array()])
string getApiCertificate ()
string getApiPassword ()
string getApiSignature ()
string getApiUsername ()
string getBuildNotationCode ()
void getBusinessAccount ()
bool getDebug ()
bool getDebugFlag ()
void getFraudManagementFiltersEnabled ()
string getHdrbackcolor ()
string getHdrbordercolor ()
string getHdrimg ()
string getLocaleCode ()
string getPageStyle ()
string getPayflowcolor ()
string getPaymentAction ()
string getProxyHost ()
string getProxyPort ()
bool getUseCertAuthentication ()
bool getUseProxy ()
array|Varien_Object &import (array|Varien_Object $to, [ $publicMap = array()])
Mage_Paypal_Model_Api_Abstract setConfigObject (Mage_Paypal_Model_Config $config)
Mage_Paypal_Model_Api_Abstract setPaypalCart (Mage_Paypal_Model_Cart $cart)
string _buildQuery (array $request)
void _debug (mixed $debugData)
true|bool _exportLineItems ( &$request, [int $i = 0])
bool _exportShippingOptions ( &$request, [int $i = 0])
array &_exportToRequest ( $privateRequestMap, [ $request = array()], array $internalRequestMap)
string _filterAmount (float|string $value)
string _filterBool (mixed $value)
int _filterInt (mixed $value)
string _filterQty (float|string|int $value)
mixed _getDataOrConfig (string $key, [mixed $default = null])
void _importFromResponse ( $privateResponseMap,  $response)
void _importStreetFromAddress ( $address,  &$to, array $request)
string _lookupRegionCodeFromAddress ( $address)
Variables
Description | Descendents | Vars (details) | Methods (details)
Mage_Paypal_Model_Cart $_cart = null (line 73)

PayPal shopping cart instance

  • access: protected
Mage_Paypal_Model_Config $_config = null (line 38)

Config instance

  • access: protected
array $_debugReplacePrivateDataKeys = array() (line 93)

Fields that should be replaced in debug with '***'

  • access: protected
Redefined in descendants as:
array $_exportToRequestFilters = array() (line 51)

Filter callbacks for exporting $this data to API call

  • access: protected
Redefined in descendants as:
array $_globalMap = array() (line 44)

Global private to public interface map

  • access: protected
Redefined in descendants as:
array $_importFromRequestFilters = array() (line 58)

Filter callbacks for importing API result to $this data

  • access: protected
Redefined in descendants as:
mixed $_lineItemExportItemsFilters = array() (line 65)
  • access: protected
Redefined in descendants as:
array $_lineItemExportItemsFormat = array() (line 64)

Line items export to request mapping settings

  • access: protected
Redefined in descendants as:
mixed $_lineItemTotalExportMap = array() (line 66)
  • access: protected
Redefined in descendants as:
array $_recurringPaymentProfiles = array() (line 86)

Imported recurring profiles array

  • access: protected
array $_shippingOptionsExportItemsFormat = array() (line 79)

Shipping options export to request mapping settings

  • access: protected
Redefined in descendants as:
Methods
Description | Descendents | Vars (details) Methods (details)
addRecurringPaymentProfiles (line 325)

Set recurring profiles

  • access: public
Mage_Paypal_Model_Api_Abstract addRecurringPaymentProfiles ( $items)
  • array $items
export (line 272)

Export $this public data from specified object or array

  • access: public
Mage_Paypal_Model_Api_Abstract export (array|Varien_Object $from, [ $publicMap = array()])
  • array|Varien_Object $from
  • array $publicMap
getApiCertificate (line 130)

Return Paypal Api certificate based on config data

  • access: public
string getApiCertificate ()
getApiPassword (line 110)

Return Paypal Api password based on config data

  • access: public
string getApiPassword ()
getApiSignature (line 120)

Return Paypal Api signature based on config data

  • access: public
string getApiSignature ()
getApiUsername (line 100)

Return Paypal Api user name based on config data

  • access: public
string getApiUsername ()
getBuildNotationCode (line 140)

BN code getter

  • access: public
string getBuildNotationCode ()
getBusinessAccount (line 248)

PayPal merchant email getter

  • access: public
void getBusinessAccount ()
Redefined in descendants as:
getDebug (line 180)
  • deprecated: after 1.4.1.0
  • access: public
bool getDebug ()
getDebugFlag (line 592)

Define if debugging is enabled

  • access: public
bool getDebugFlag ()
getFraudManagementFiltersEnabled (line 314)

Always take into accoun

  • access: public
void getFraudManagementFiltersEnabled ()
getHdrbackcolor (line 220)

PayPal page header background color getter

  • access: public
string getHdrbackcolor ()
getHdrbordercolor (line 210)

PayPal page header border color getter

  • access: public
string getHdrbordercolor ()
getHdrimg (line 200)

PayPal page header image URL getter

  • access: public
string getHdrimg ()
getLocaleCode (line 306)

Current locale code getter

  • access: public
string getLocaleCode ()
getPageStyle (line 190)

PayPal page CSS getter

  • access: public
string getPageStyle ()
getPayflowcolor (line 230)

PayPal page "payflow color" (?) getter

  • access: public
string getPayflowcolor ()
getPaymentAction (line 240)

Payment action getter

  • access: public
string getPaymentAction ()
Redefined in descendants as:
getProxyHost (line 160)

Return Paypal Api proxy host based on config data

  • access: public
string getProxyHost ()
getProxyPort (line 170)

Return Paypal Api proxy port based on config data

  • access: public
string getProxyPort ()
getUseCertAuthentication (line 602)

Check whether API certificate authentication should be used

  • access: public
bool getUseCertAuthentication ()
getUseProxy (line 150)

Return Paypal Api proxy status based on config data

  • access: public
bool getUseProxy ()
import (line 260)

Import $this public data to specified object or array

  • access: public
array|Varien_Object &import (array|Varien_Object $to, [ $publicMap = array()])
  • array|Varien_Object $to
  • array $publicMap
setConfigObject (line 295)

Config instance setter

  • access: public
Mage_Paypal_Model_Api_Abstract setConfigObject (Mage_Paypal_Model_Config $config)
setPaypalCart (line 284)

Set PayPal cart instance

  • access: public
Mage_Paypal_Model_Api_Abstract setPaypalCart (Mage_Paypal_Model_Cart $cart)
_buildQuery (line 556)

Build query string from request

  • access: protected
string _buildQuery (array $request)
  • array $request
Redefined in descendants as:
_debug (line 578)

Log debug data to file

  • access: protected
void _debug (mixed $debugData)
  • mixed $debugData
_exportLineItems (line 390)

Prepare line items request

Returns true if there were line items added

  • access: protected
true|bool _exportLineItems ( &$request, [int $i = 0])
  • array &$request
  • int $i
Redefined in descendants as:
_exportShippingOptions (line 438)

Prepare shipping options request Returns false if there are no shipping options

  • access: protected
bool _exportShippingOptions ( &$request, [int $i = 0])
  • array &$request
  • int $i
_exportToRequest (line 340)

Export $this public data to private request array

  • access: protected
array &_exportToRequest ( $privateRequestMap, [ $request = array()], array $internalRequestMap)
  • array $internalRequestMap
  • array $request
  • array $privateRequestMap
_filterAmount (line 465)

Filter amounts in API calls

  • access: protected
string _filterAmount (float|string $value)
  • float|string $value
_filterBool (line 476)

Filter boolean values in API calls

  • access: protected
string _filterBool (mixed $value)
  • mixed $value
_filterInt (line 487)

Filter int values in API calls

  • access: protected
int _filterInt (mixed $value)
  • mixed $value
_filterQty (line 568)

Filter qty in API calls Paypal note: The value for quantity must be a positive integer. Null, zero, or negative numbers are not allowed.

  • access: protected
string _filterQty (float|string|int $value)
  • float|string|int $value
_getDataOrConfig (line 499)

Unified getter that looks in data or falls back to config

  • access: protected
mixed _getDataOrConfig (string $key, [mixed $default = null])
  • string $key
  • mixed $default
_importFromResponse (line 366)

Import $this public data from a private response array

  • access: protected
void _importFromResponse ( $privateResponseMap,  $response)
  • array $privateResponseMap
  • array $response
_importStreetFromAddress (line 532)

Street address workaround: divides address lines into parts by specified keys (keys should go as 3rd, 4th[...] parameters)

  • access: protected
void _importStreetFromAddress ( $address,  &$to, array $request)
  • Varien_Object $address
  • array $request
  • array &$to
_lookupRegionCodeFromAddress (line 514)

region_id workaround: PayPal requires state code, try to find one in the address

  • access: protected
string _lookupRegionCodeFromAddress ( $address)
  • Varien_Object $address

Documentation generated on Fri, 11 Feb 2011 16:54:47 +0200 by phpDocumentor 1.4.3