BxPaymentProviderPayPalApi Class Reference

Inheritance diagram for BxPaymentProviderPayPalApi:

Public Member Functions
	__construct ($aConfig)
	authorizeCheckout ($iPendingId, $aCartInfo)
	captureAuthorizedCheckout ($sOrderAuth, $mixedPending, $aInfo)
	initializeCheckout ($iPendingId, $aCartInfo)
	finalizeCheckout (&$aData)
	notify ()
	getClientId ()
	getSecret ()
	getMenuItemsActionsRecurring ($iClientId, $iVendorId, $aParams=array())
	cancelRecurring ($iPendingId, $sCustomerId, $sSubscriptionId)
Public Member Functions inherited from BxBaseModPaymentProvider
	initOptions ($aOptions)
	initOptionsByVendor ($iVendorId)
	isActive ()
	isHidden ()
	getOption ($sName)
	setOption ($sName, $mixedValue, $bSave=false)
	getReturnUrl ($aParams=array())
	getReturnDataUrl ($iVendorId, $aParams=array())
	getNotifyUrl ($iVendorId, $aParams=array())
	needRedirect ()
	addJsCss ()
	getJsObject ()
	finalizedCheckout ()
	isSubscriptionStatus ($sStatus, $aSubscription, $sStatusKey='status')
	getSubscription ($iPendingId, $sCustomerId, $sSubscriptionId)
Public Member Functions inherited from iBxBaseModPaymentProvider
	finalizedCheckout ()

Protected Member Functions
	_finalizeCheckoutSingle (&$aData)
	_finalizeCheckoutRecurring (&$aData)
	_createSubscription ($iPendingId, $aCartInfo, $sReturnType='approve')
	_getSubscription ($sSubscriptionId)
	_cancelSubscription ($sSubscriptionId)
	_createProduct ($aItem)
	_getProduct ($sProductId)
	_createPlan ($sProductId, $aItem)
	_getPlan ($sPlanId)
	_getPlans ($sProductId, $iStart=false, $iPerPage=false)
	_getToken ()
	_apiCallAuthorize ($sEndpoint, $aParams=[], $aBasicAuth=[], $sMethod='post')
	_apiCallAuthorized ($sEndpoint, $aParams=[], $aHeaders=[], $sMethod='post-json', $bRawResponse=false)
	_apiCall ($sEndpoint, $aParams=[], $aHeaders=[], $sMethod='post-json', $aBasicAuth=[], &$sHttpCode=null)
	_getIntervalUnit ($sPeriodUnit)
	_getClient ()
	_createOrder ($iPendingId, $aCartInfo, $aParams=[])
	_getOrder ($sOrderId)
	_authorizeOrder ($sOrderId)
	_captureOrder ($sOrderId)
	_captureAuthorization ($sAuthorizationId)
	_processException ($sMessage, &$oException)
	_processEvent ()
	_processEventPaymentSaleCompleted ($aEvent)
	_processEventPaymentCaptureRefunded ($aEvent)
	_processEventBillingSubscriptionCancelled ($aEvent)
	_getEventData ($aEvent)
	_getMode ()
	_getSessionOrder ()
	_setSessionOrder ($sValue)
	_getSessionSubscription ()
	_setSessionSubscription ($sValue)
	_getClientInfo ($mixedClient)
	_getBillingStatus ($mixedBillingInfo)
Protected Member Functions inherited from BxBaseModPaymentProvider
	getOptionsByPending ($iPendingId)
	getOptionsByVendor ($iVendorId)
	log ($mixedContents, $sTitle='')

Protected Attributes
	$_oSession
	$_sSessionKeyOrder
	$_sSessionKeySubscription
	$_bCheckAmount
	$_iMode
	$_sEndpoint
	$_sToken
Protected Attributes inherited from BxBaseModPaymentProvider
	$MODULE
	$_oModule
	$_sLangsPrefix
	$_iId
	$_sName
	$_sCaption
	$_sPrefix
	$_iVendor
	$_aOptions
	$_bUseSsl
	$_bRedirectOnResult
	$_aSbsStatuses
	$_aIncludeJs
	$_aIncludeCss

Constructor & Destructor Documentation

__construct()

BxPaymentProviderPayPalApi::__construct

(

$aConfig

)

Reimplemented from BxBaseModPaymentProvider.

Member Function Documentation

_createSubscription()

BxPaymentProviderPayPalApi::_createSubscription ( $iPendingId, $aCartInfo, $sReturnType = 'approve' )

protected

Methods which use common HTTPS calls to process Recurring time payments.

_getBillingStatus()

BxPaymentProviderPayPalApi::_getBillingStatus ( $mixedBillingInfo )

protected

Retrieve 'Billing Status' from a 'getSubscription' call's response.

_getClient()

BxPaymentProviderPayPalApi::_getClient ( )

protected

Methods which use 'Checkout SDK' to process Single time payments.

_getClientInfo()

BxPaymentProviderPayPalApi::_getClientInfo ( $mixedClient )

protected

Retrieve 'Client Info' from a 'getSubscription' call's response.

_getMode()

BxPaymentProviderPayPalApi::_getMode ( )

protected

Common methods for internal usage.

_processEvent()

BxPaymentProviderPayPalApi::_processEvent ( )

protected

Methods to process WebHooks

finalizeCheckout()

BxPaymentProviderPayPalApi::finalizeCheckout

(

&

$aData

)

Implements iBxBaseModPaymentProvider.

initializeCheckout()

BxPaymentProviderPayPalApi::initializeCheckout	(		$iPendingId,
			$aCartInfo )

Implements iBxBaseModPaymentProvider.

---

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

• modules/boonex/payment/classes/BxPaymentProviderPayPalApi.php