BxPaymentProviderCredits Class Reference

Inheritance diagram for BxPaymentProviderCredits:

Public Member Functions
	__construct ($aConfig)
	initializeCheckout ($iPendingId, $aCartInfo, $sRedirect='')
	finalizeCheckout (&$aData)
	makePayment ($mixedPending)
	cancelRecurring ($iPendingId, $sCustomerId, $sSubscriptionId)
	getMenuItemsActionsRecurring ($iClientId, $iVendorId, $aParams=array())
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
	initializeCheckout ($iPendingId, $aCartInfo)
	finalizedCheckout ()

Protected Member Functions
	_finalizeCheckout (&$aData)
	_constructCustomData ()
	_deconstructCustomData ($data)
	_getAmountByPending ($aPending)
Protected Member Functions inherited from BxBaseModPaymentProvider
	getOptionsByPending ($iPendingId)
	getOptionsByVendor ($iVendorId)
	log ($mixedContents, $sTitle='')

Protected Attributes
	$_sModuleCredits
Protected Attributes inherited from BxBaseModPaymentProvider
	$MODULE
	$_oModule
	$_sLangsPrefix
	$_iId
	$_sName
	$_sCaption
	$_sPrefix
	$_iVendor
	$_aOptions
	$_bUseSsl
	$_bRedirectOnResult
	$_aSbsStatuses
	$_aIncludeJs
	$_aIncludeCss

Detailed Description

Credits payment provider can be used when Credits module is installed and active.

Constructor & Destructor Documentation

__construct()

BxPaymentProviderCredits::__construct

(

$aConfig

)

Reimplemented from BxBaseModPaymentProvider.

Member Function Documentation

cancelRecurring()

BxPaymentProviderCredits::cancelRecurring	(		$iPendingId,
			$sCustomerId,
			$sSubscriptionId )

Hooks:

'bx_payment', 'credits_cancel_subscription' - hook after a subscription was canceled

• $unit_name - equals bx_payment
• $action - equals credits_cancel_subscription
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • pending_id - [string] pending transaction id
  • subscription_id - [string] unique subscription id

    HOOKS

    'bx_payment', 'credits_cancel_subscription' - hook after a subscription was canceled

finalizeCheckout()

BxPaymentProviderCredits::finalizeCheckout

(

&

$aData

)

Implements iBxBaseModPaymentProvider.

---

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

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