BxPaymentProviderChargebeeV3 Class Reference

Inheritance diagram for BxPaymentProviderChargebeeV3:

Public Member Functions
	__construct ($aConfig)
	actionGetHostedPageSingle ($iClientId, $iVendorId)
	actionGetHostedPageRecurring ($iClientId, $iVendorId, $sItemName)
	actionGetPortal ($iPendingId)
	addJsCss ()
	getJsObject ($aParams=array())
	initializeCheckout ($iPendingId, $aCartInfo, $sRedirect='')
	finalizeCheckout (&$aData)
	getPortal ($sCustomerId, $sSubscriptionId)
	getJsCode ($aParams=array())
	getButtonSingle ($iClientId, $iVendorId, $aParams=[])
	getButtonSingleJs ($iClientId, $iVendorId, $aParams=[])
	getButtonRecurring ($iClientId, $iVendorId, $aParams=array())
	getButtonRecurringJs ($iClientId, $iVendorId, $aParams=array())
	getMenuItemsActionsRecurring ($iClientId, $iVendorId, $aParams=array())
Public Member Functions inherited from BxPaymentProviderChargebee
	initOptions ($aOptions)
	initializeCheckout ($iPendingId, $aCartInfo)
	notify ()
	cancelRecurring ($iPendingId, $sCustomerId, $sSubscriptionId)
	createHostedPageSingle ($aItem, $aClient, $aVendor=array(), $iPendingId=0)
	createHostedPageRecurring ($aItem, $aClient, $aVendor=array(), $iPendingId=0)
	retreiveHostedPage ($sPageId)
	retrieveSubscription ($sSubscriptionId)
	getSubscription ($iPendingId, $sCustomerId, $sSubscriptionId)
	deleteSubscription ($sSubscriptionId)
	retrieveInvoice ($sInvoiceId)
	retrieveAddons ($sStatus='active', $iLimit=0)
	getAddons ($sStatus='active', $iLimit=0)
	retrieveAddon ($sId)
	getAddon ($sId)
	retrieveCustomer ($sCustomerId)
	onDeleteSubscription ($sSubscriptionId, $aSubscription)
Public Member Functions inherited from BxBaseModPaymentProvider
	initOptionsByVendor ($iVendorId)
	isActive ()
	isHidden ()
	getOption ($sName)
	setOption ($sName, $mixedValue, $bSave=false)
	getReturnUrl ($aParams=array())
	getReturnDataUrl ($iVendorId, $aParams=array())
	getNotifyUrl ($iVendorId, $aParams=array())
	needRedirect ()
	getJsObject ()
	finalizedCheckout ()
	isSubscriptionStatus ($sStatus, $aSubscription, $sStatusKey='status')
Public Member Functions inherited from iBxBaseModPaymentProvider
	finalizedCheckout ()

Protected Member Functions
	_getButton ($sType, $iClientId, $iVendorId, $aParams=array())
	_getButtonJs ($sType, $iClientId, $iVendorId, $aParams=array())
Protected Member Functions inherited from BxPaymentProviderChargebee
	_getSite ()
	_getApiKey ()
	_processEvent ()
	_processEventPaymentSucceeded (&$aEvent)
	_processEventPaymentRefunded (&$aEvent)
	_processEventSubscriptionCancelled (&$aEvent)
	_getDataTransaction (&$aEvent, $sWithStatusCheck='')
	_getDataSubscription (&$aEvent, $sWithStatusCheck='')
Protected Member Functions inherited from BxBaseModPaymentProvider
	getOptionsByPending ($iPendingId)
	getOptionsByVendor ($iVendorId)
	log ($mixedContents, $sTitle='')

Additional Inherited Members
Protected Attributes inherited from BxPaymentProviderChargebee
	$_iMode
	$_bCheckAmount
Protected Attributes inherited from BxBaseModPaymentProvider
	$MODULE
	$_oModule
	$_sLangsPrefix
	$_iId
	$_sName
	$_sCaption
	$_sPrefix
	$_iVendor
	$_aOptions
	$_bUseSsl
	$_bRedirectOnResult
	$_aSbsStatuses
	$_aIncludeJs
	$_aIncludeCss

Constructor & Destructor Documentation

__construct()

BxPaymentProviderChargebeeV3::__construct

(

$aConfig

)

Reimplemented from BxPaymentProviderChargebee.

Member Function Documentation

_getButtonJs()

BxPaymentProviderChargebeeV3::_getButtonJs ( $sType, $iClientId, $iVendorId, $aParams = array() )

protected

Hooks:

'bx_payment', 'chargebee_v3_get_button' - hook to override checkout/subscibe button

• $unit_name - equals bx_payment
• $action - equals chargebee_v3_get_button
• $object_id - not used
• $sender_id - client (buyer) profile id
• $extra_params - array of additional params with the following array keys:
  • type - [string] by ref, payment type ('single' or 'recurring'), can be overridden in hook processing
  • site - [string] by ref, site name from ChargeBee account, can be overridden in hook processing
  • params - [array] by ref, params array as key&value pairs, can be overridden in hook processing

    HOOKS

    'bx_payment', 'chargebee_v3_get_button' - hook to override checkout/subscibe button

addJsCss()

BxPaymentProviderChargebeeV3::addJsCss

(

)

Reimplemented from BxBaseModPaymentProvider.

finalizeCheckout()

BxPaymentProviderChargebeeV3::finalizeCheckout

(

&

$aData

)

Reimplemented from BxPaymentProviderChargebee.

getJsCode()

BxPaymentProviderChargebeeV3::getJsCode

(

$aParams = array()

)

Hooks:

'bx_payment', 'chargebee_v3_get_js_code' - hook to override JavaScript code

• $unit_name - equals bx_payment
• $action - equals chargebee_v3_get_js_code
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • site - [string] by ref, site name from ChargeBee account, can be overridden in hook processing
  • params - [array] by ref, params array as key&value pairs, can be overridden in hook processing

    HOOKS

    'bx_payment', 'chargebee_v3_get_js_code' - hook to override JavaScript code

---

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

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