Class CallerServices

Description

Interface class that wraps all WSDL ports into a unified API for the user. Also handles PayPal-specific details like type handling, error handling, etc.

Located in /PayPal/CallerServices.php (line 37)

SOAP_Client
   |
   --CallerServices
Variable Summary
Method Summary
CallerServices CallerServices (APIProfile $profile)
void &AddressVerify ( $AddressVerifyReq)
void &BillAgreementUpdate ( $BillAgreementUpdateReq)
void &BillOutstandingAmount ( $BillOutstandingAmountReq)
void &BillUser ( $BillUserReq)
void &BMButtonSearch ( $BMButtonSearchReq)
void &BMCreateButton ( $BMCreateButtonReq)
void &BMGetButtonDetails ( $BMGetButtonDetailsReq)
void &BMGetInventory ( $BMGetInventoryReq)
void &BMManageButtonStatus ( $BMManageButtonStatusReq)
void &BMSetInventory ( $BMSetInventoryReq)
void &BMUpdateButton ( $BMUpdateButtonReq)
void buildAuthString ( $auth_token,  $auth_signature,  $auth_timestamp)
void &call ( $method,  &$params, [ $namespace = false], [ $soapAction = false])
void &CreateBillingAgreement ( $CreateBillingAgreementReq)
void &CreateMobilePayment ( $CreateMobilePaymentReq)
void &CreateRecurringPaymentsProfile ( $CreateRecurringPaymentsProfileReq)
void &DoAuthorization ( $DoAuthorizationReq)
void &DoCapture ( $DoCaptureReq)
void &DoDirectPayment ( $DoDirectPaymentReq)
void &DoExpressCheckoutPayment ( $DoExpressCheckoutPaymentReq)
void &DoMobileCheckoutPayment ( $DoMobileCheckoutPaymentReq)
void &DoNonReferencedCredit ( $DoNonReferencedCreditReq)
void &DoReauthorization ( $DoReauthorizationReq)
void &DoReferenceTransaction ( $DoReferenceTransactionReq)
void &DoUATPAuthorization ( $DoUATPAuthorizationReq)
void &DoUATPExpressCheckoutPayment ( $DoUATPExpressCheckoutPaymentReq)
void &DoVoid ( $DoVoidReq)
void &EnterBoarding ( $EnterBoardingReq)
void &GetAccessPermissionDetails ( $GetAccessPermissionDetailsReq)
void &GetAuthDetails ( $GetAuthDetailsReq)
void &GetBalance ( $GetBalanceReq)
void &GetBillingAgreementCustomerDetails ( $GetBillingAgreementCustomerDetailsReq)
void &GetBoardingDetails ( $GetBoardingDetailsReq)
void &GetExpressCheckoutDetails ( $GetExpressCheckoutDetailsReq)
void &GetIncentiveEvaluation ( $GetIncentiveEvaluationReq)
Log &getLogger ()
void &GetMobileStatus ( $GetMobileStatusReq)
void &GetPalDetails ( $GetPalDetailsReq)
void &GetRecurringPaymentsProfileDetails ( $GetRecurringPaymentsProfileDetailsReq)
AbstractResponseType &getResponseObject (array $values, string $type)
void &GetTransactionDetails ( $GetTransactionDetailsReq)
void &ManagePendingTransactionStatus ( $ManagePendingTransactionStatusReq)
void &ManageRecurringPaymentsProfileStatus ( $ManageRecurringPaymentsProfileStatusReq)
void &MassPay ( $MassPayReq)
void &RefundTransaction ( $RefundTransactionReq)
void &ReverseTransaction ( $ReverseTransactionReq)
void &SetAccessPermissions ( $SetAccessPermissionsReq)
void setAPIProfile ( &$profile, APIProfile $profile)
void &SetAuthFlowParam ( $SetAuthFlowParamReq)
void &SetCustomerBillingAgreement ( $SetCustomerBillingAgreementReq)
boolean setEndpoint (string $portType, string $version)
void &SetExpressCheckout ( $SetExpressCheckoutReq)
void setLogger (Log &$logger)
void &SetMobileCheckout ( $SetMobileCheckoutReq)
void &TransactionSearch ( $TransactionSearchReq)
void &UpdateAccessPermissions ( $UpdateAccessPermissionsReq)
void &UpdateRecurringPaymentsProfile ( $UpdateRecurringPaymentsProfileReq)
void &_decode ( &$soapval)
integer _getElapsed (integer $start)
integer _getMicroseconds ()
void _logTransaction (string $operation, integer $elapsed, object $response)
string _sanitizeLog (string $xml)
Variables
array $_endpointMap (line 55)

The portType/environment -> endpoint map.

  • access: protected
string $_logDir = '/tmp' (line 82)

If we're logging, what directory should we create log files in? Note that a log name coincides with a symlink, logging will *not* be done to avoid security problems. File names are <DateStamp>.PayPal.log.

  • access: protected
Log $_logger (line 91)

The PEAR Log object we use for logging.

  • access: protected
integer $_logLevel = PEAR_LOG_INFO (line 70)

What level should we log at? Valid levels are: PEAR_LOG_ERR - Log only severe errors.

PEAR_LOG_INFO - (default) Date/time of operation, operation name, elapsed time, success or failure indication. PEAR_LOG_DEBUG - Full text of SOAP requests and responses and other debugging messages.

See the PayPal SDK User Guide for more details on these log levels.

  • access: protected
APIProfile $_profile (line 46)

The profile to use in API calls.

  • access: protected
Methods
Constructor CallerServices (line 100)

Construct a new CallerServices object.

CallerServices CallerServices (APIProfile $profile)
  • APIProfile $profile: The profile with the username, password, and any other information necessary to use the SDK.
AddressVerify (line 867)
void &AddressVerify ( $AddressVerifyReq)
  • $AddressVerifyReq
BillAgreementUpdate (line 833)
void &BillAgreementUpdate ( $BillAgreementUpdateReq)
  • $BillAgreementUpdateReq
BillOutstandingAmount (line 2023)
void &BillOutstandingAmount ( $BillOutstandingAmountReq)
  • $BillOutstandingAmountReq
BillUser (line 731)
void &BillUser ( $BillUserReq)
  • $BillUserReq
BMButtonSearch (line 697)
void &BMButtonSearch ( $BMButtonSearchReq)
  • $BMButtonSearchReq
BMCreateButton (line 493)
void &BMCreateButton ( $BMCreateButtonReq)
  • $BMCreateButtonReq
BMGetButtonDetails (line 595)
void &BMGetButtonDetails ( $BMGetButtonDetailsReq)
  • $BMGetButtonDetailsReq
BMGetInventory (line 663)
void &BMGetInventory ( $BMGetInventoryReq)
  • $BMGetInventoryReq
BMManageButtonStatus (line 561)
void &BMManageButtonStatus ( $BMManageButtonStatusReq)
  • $BMManageButtonStatusReq
BMSetInventory (line 629)
void &BMSetInventory ( $BMSetInventoryReq)
  • $BMSetInventoryReq
BMUpdateButton (line 527)
void &BMUpdateButton ( $BMUpdateButtonReq)
  • $BMUpdateButtonReq
buildAuthString (line 279)

Override SOAP_Client::call() to always add our security header first.

void buildAuthString ( $auth_token,  $auth_signature,  $auth_timestamp)
  • $auth_token
  • $auth_signature
  • $auth_timestamp
call (line 286)
void &call ( $method,  &$params, [ $namespace = false], [ $soapAction = false])
  • $method
  • &$params
  • $namespace
  • $soapAction
CreateBillingAgreement (line 1785)
void &CreateBillingAgreement ( $CreateBillingAgreementReq)
  • $CreateBillingAgreementReq
CreateMobilePayment (line 969)
void &CreateMobilePayment ( $CreateMobilePaymentReq)
  • $CreateMobilePaymentReq
CreateRecurringPaymentsProfile (line 1921)
void &CreateRecurringPaymentsProfile ( $CreateRecurringPaymentsProfileReq)
  • $CreateRecurringPaymentsProfileReq
DoAuthorization (line 1683)
void &DoAuthorization ( $DoAuthorizationReq)
  • $DoAuthorizationReq
DoCapture (line 1581)
void &DoCapture ( $DoCaptureReq)
  • $DoCaptureReq
DoDirectPayment (line 1513)
void &DoDirectPayment ( $DoDirectPaymentReq)
  • $DoDirectPaymentReq
DoExpressCheckoutPayment (line 1173)
void &DoExpressCheckoutPayment ( $DoExpressCheckoutPaymentReq)
  • $DoExpressCheckoutPaymentReq
DoMobileCheckoutPayment (line 1071)
void &DoMobileCheckoutPayment ( $DoMobileCheckoutPaymentReq)
  • $DoMobileCheckoutPaymentReq
DoNonReferencedCredit (line 1853)
void &DoNonReferencedCredit ( $DoNonReferencedCreditReq)
  • $DoNonReferencedCreditReq
DoReauthorization (line 1615)
void &DoReauthorization ( $DoReauthorizationReq)
  • $DoReauthorizationReq
DoReferenceTransaction (line 1819)
void &DoReferenceTransaction ( $DoReferenceTransactionReq)
  • $DoReferenceTransactionReq
DoUATPAuthorization (line 1887)
void &DoUATPAuthorization ( $DoUATPAuthorizationReq)
  • $DoUATPAuthorizationReq
DoUATPExpressCheckoutPayment (line 1207)
void &DoUATPExpressCheckoutPayment ( $DoUATPExpressCheckoutPaymentReq)
  • $DoUATPExpressCheckoutPaymentReq
DoVoid (line 1649)
void &DoVoid ( $DoVoidReq)
  • $DoVoidReq
EnterBoarding (line 901)
void &EnterBoarding ( $EnterBoardingReq)
  • $EnterBoardingReq
GetAccessPermissionDetails (line 1377)
void &GetAccessPermissionDetails ( $GetAccessPermissionDetailsReq)
  • $GetAccessPermissionDetailsReq
getAPIProfile (line 237)

Get the current profile.

  • return: The current profile.
APIProfile &getAPIProfile ()
GetAuthDetails (line 1275)
void &GetAuthDetails ( $GetAuthDetailsReq)
  • $GetAuthDetailsReq
GetBalance (line 1105)
void &GetBalance ( $GetBalanceReq)
  • $GetBalanceReq
GetBillingAgreementCustomerDetails (line 1751)
void &GetBillingAgreementCustomerDetails ( $GetBillingAgreementCustomerDetailsReq)
  • $GetBillingAgreementCustomerDetailsReq
GetBoardingDetails (line 935)
void &GetBoardingDetails ( $GetBoardingDetailsReq)
  • $GetBoardingDetailsReq
GetExpressCheckoutDetails (line 1479)
void &GetExpressCheckoutDetails ( $GetExpressCheckoutDetailsReq)
  • $GetExpressCheckoutDetailsReq
GetIncentiveEvaluation (line 1411)
void &GetIncentiveEvaluation ( $GetIncentiveEvaluationReq)
  • $GetIncentiveEvaluationReq
getLogger (line 248)

Gets the PEAR Log object to use.

  • return: A Log object, either provided by the user or created by this function.
Log &getLogger ()
GetMobileStatus (line 1003)
void &GetMobileStatus ( $GetMobileStatusReq)
  • $GetMobileStatusReq
GetPalDetails (line 1139)
void &GetPalDetails ( $GetPalDetailsReq)
  • $GetPalDetailsReq
GetRecurringPaymentsProfileDetails (line 1955)
void &GetRecurringPaymentsProfileDetails ( $GetRecurringPaymentsProfileDetailsReq)
  • $GetRecurringPaymentsProfileDetailsReq
getResponseObject (line 183)

Take the decoded array from SOAP_Client::__call() and turn it into an object of the appropriate AbstractResponseType subclass.

  • return: The response object.
AbstractResponseType &getResponseObject (array $values, string $type)
  • array $values: The decoded SOAP response.
  • string $type: The type of the response object.
GetTransactionDetails (line 459)
void &GetTransactionDetails ( $GetTransactionDetailsReq)
  • $GetTransactionDetailsReq
ManagePendingTransactionStatus (line 1547)
void &ManagePendingTransactionStatus ( $ManagePendingTransactionStatusReq)
  • $ManagePendingTransactionStatusReq
ManageRecurringPaymentsProfileStatus (line 1989)
void &ManageRecurringPaymentsProfileStatus ( $ManageRecurringPaymentsProfileStatusReq)
  • $ManageRecurringPaymentsProfileStatusReq
MassPay (line 799)
void &MassPay ( $MassPayReq)
  • $MassPayReq
RefundTransaction (line 425)
void &RefundTransaction ( $RefundTransactionReq)
  • $RefundTransactionReq
ReverseTransaction (line 2091)
void &ReverseTransaction ( $ReverseTransactionReq)
  • $ReverseTransactionReq
SetAccessPermissions (line 1309)
void &SetAccessPermissions ( $SetAccessPermissionsReq)
  • $SetAccessPermissionsReq
setAPIProfile (line 227)

Use a given profile.

void setAPIProfile ( &$profile, APIProfile $profile)
  • APIProfile $profile: The profile with the username, password, and any other information necessary to use the SDK.
  • &$profile
SetAuthFlowParam (line 1241)
void &SetAuthFlowParam ( $SetAuthFlowParamReq)
  • $SetAuthFlowParamReq
SetCustomerBillingAgreement (line 1717)
void &SetCustomerBillingAgreement ( $SetCustomerBillingAgreementReq)
  • $SetCustomerBillingAgreementReq
setEndpoint (line 147)

Sets the WSDL endpoint based on $portType and on the environment set in the user's profile.

  • return: | PayPal_Error An error if mapping can't be done, else true.
boolean setEndpoint (string $portType, string $version)
  • string $portType: The portType the current operation is part of.
  • string $version: The WSDL version being used.
SetExpressCheckout (line 1445)
void &SetExpressCheckout ( $SetExpressCheckoutReq)
  • $SetExpressCheckoutReq
setLogger (line 268)

Sets a custom PEAR Log object to use in logging.

void setLogger (Log &$logger)
  • Log &$logger: A PEAR Log instance.
SetMobileCheckout (line 1037)
void &SetMobileCheckout ( $SetMobileCheckoutReq)
  • $SetMobileCheckoutReq
TransactionSearch (line 765)
void &TransactionSearch ( $TransactionSearchReq)
  • $TransactionSearchReq
UpdateAccessPermissions (line 1343)
void &UpdateAccessPermissions ( $UpdateAccessPermissionsReq)
  • $UpdateAccessPermissionsReq
UpdateRecurringPaymentsProfile (line 2057)
void &UpdateRecurringPaymentsProfile ( $UpdateRecurringPaymentsProfileReq)
  • $UpdateRecurringPaymentsProfileReq
_decode (line 320)

Override some of the default SOAP:: package _decode behavior to handle simpleTypes and complexTypes with simpleContent.

void &_decode ( &$soapval)
  • &$soapval
_getElapsed (line 420)

Return the difference between now and $start in microseconds.

  • return: Number of microseconds elapsed since $start
  • access: protected
integer _getElapsed (integer $start)
  • integer $start: Start time including microseconds.
_getMicroseconds (line 405)

Return the current time including microseconds.

  • return: Current time with microseconds.
  • access: protected
integer _getMicroseconds ()
_logTransaction (line 356)

Log the current transaction depending on the current log level.

  • access: protected
void _logTransaction (string $operation, integer $elapsed, object $response)
  • string $operation: The operation called.
  • integer $elapsed: Microseconds taken.
  • object $response: The response object.
_sanitizeLog (line 389)

Strip sensitive information (API passwords and credit card numbers) from raw XML requests/responses.

  • return: The sanitized XML.
  • access: protected
string _sanitizeLog (string $xml)
  • string $xml: The XML to sanitize.

Documentation generated on Fri, 15 Oct 2010 06:20:59 +0000 by phpDocumentor 1.4.3