BxPaymentProviderStripeBasic Class Reference

Inheritance diagram for BxPaymentProviderStripeBasic:

Public Member Functions
	__construct ($aConfig)
	initOptions ($aOptions)
	addJsCss ()
	getJsObject ($aParams=array())
	notify ()
	getButtonSingle ($iClientId, $iVendorId, $aParams=array())
	getButtonSingleJs ($iClientId, $iVendorId, $aParams=array())
	getButtonRecurring ($iClientId, $iVendorId, $aParams=array())
	getButtonRecurringJs ($iClientId, $iVendorId, $aParams=array())
	getMenuItemsActionsRecurring ($iClientId, $iVendorId, $aParams=array())
	getDetailsRecurring ($iPendingId, $sCustomerId, $sSubscriptionId)
	changeDetailsRecurring ($iPendingId, $sCustomerId, $sSubscriptionId)
	getBillingRecurring ($iPendingId, $sCustomerId, $sSubscriptionId)
	changeBillingRecurring ($iPendingId, $sCustomerId, $sSubscriptionId)
	cancelRecurring ($iPendingId, $sCustomerId, $sSubscriptionId)
	getSubscription ($iPendingId, $sCustomerId, $sSubscriptionId)
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')

Protected Member Functions
	_getPublicKey ()
	_getSecretKey ()
	_retrieveCustomer ($sType, $sId)
	_retrieveCharge ($sId)
	_retrieveSubscription ($sCustomerId, $sSubscriptionId)
	_cancelSubscription ($sCustomerId, $sSubscriptionId)
	_retrievePaymentMethod ($sPaymentMethodId)
	_retrieveProduct ($sId)
	_listPlans ($iLimit=100)
	_retrieveEvent ($sId)
	_processEvent ()
	_processEventInvoicePaymentSucceeded (&$aEvent)
	_processEventChargeRefunded (&$aEvent)
	_processEventCustomerSubscriptionDeleted (&$aEvent)
	_processException ($sMessage, &$oException)
	_getData (&$aEvent, $bRetrieve=true)
	_getDataInvoicePaymentSucceeded (&$aEvent, $bRetrieve=true)
	_getDataChangeDetailsRecurring ($iPendingId)
	_getButton ($sType, $iClientId, $iVendorId, $aParams=array())
Protected Member Functions inherited from BxBaseModPaymentProvider
	getOptionsByPending ($iPendingId)
	getOptionsByVendor ($iVendorId)
	log ($mixedContents, $sTitle='')

Protected Attributes
	$_sFormDetails
	$_sFormDisplayDetailsEdit
	$_sFormCard
	$_sFormDisplayCardAdd
	$_iMode
	$_bCheckAmount
	$_bProrate
	$_oCustomer
Protected Attributes inherited from BxBaseModPaymentProvider
	$MODULE
	$_oModule
	$_sLangsPrefix
	$_iId
	$_sName
	$_sCaption
	$_sPrefix
	$_iVendor
	$_aOptions
	$_bUseSsl
	$_bRedirectOnResult
	$_aSbsStatuses
	$_aIncludeJs
	$_aIncludeCss

Constructor & Destructor Documentation

__construct()

BxPaymentProviderStripeBasic::__construct

(

$aConfig

)

Reimplemented from BxBaseModPaymentProvider.

Member Function Documentation

_cancelSubscription()

BxPaymentProviderStripeBasic::_cancelSubscription ( $sCustomerId, $sSubscriptionId )

protected

Hooks:

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

• $unit_name - equals bx_payment
• $action - equals stripe_cancel_subscription
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • subscription_id - [string] unique subscription id
  • subscription_object - [object] an instance of subscription, redurned by payment provider

    HOOKS

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

Hooks:

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

It's equivalent to 'bx_payment', 'stripe_cancel_subscription' - hook after a subscription was canceled

HOOKS

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

_getDataInvoicePaymentSucceeded()

BxPaymentProviderStripeBasic::_getDataInvoicePaymentSucceeded ( & $aEvent, $bRetrieve = true )

protected

Note. $oEvent->data->object->subscription and $oEvent->data->object->charge are checked for backward compatibility.

_retrieveCharge()

BxPaymentProviderStripeBasic::_retrieveCharge ( $sId )

protected

Hooks:

'bx_payment', 'stripe_retrieve_charge' - hook to override charge data retrieved from payment provider

• $unit_name - equals bx_payment
• $action - equals stripe_retrieve_charge
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • type - [string] payment type: single or recurring
  • charge_id - [string] by ref, unique charge id, can be overridden in hook processing
  • charge_object - [object] by ref, an instance of charge, redurned by payment provider, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_retrieve_charge' - hook to override charge data retrieved from payment provider

Hooks:

'bx_payment', 'stripe_v3_retrieve_charge' - hook to override charge data retrieved from payment provider

It's equivalent to 'bx_payment', 'stripe_retrieve_charge' - hook to override charge data retrieved from payment provider

HOOKS

'bx_payment', 'stripe_v3_retrieve_charge' - hook to override charge data retrieved from payment provider

_retrieveCustomer()

BxPaymentProviderStripeBasic::_retrieveCustomer ( $sType, $sId )

protected

Hooks:

'bx_payment', 'stripe_retrieve_customer' - hook to override customer data retrieved from payment provider

• $unit_name - equals bx_payment
• $action - equals stripe_retrieve_customer
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • type - [string] payment type: single or recurring
  • customer_id - [string] by ref, unique customer id, can be overridden in hook processing
  • customer_object - [object] by ref, an instance of customer, redurned by payment provider, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_retrieve_customer' - hook to override customer data retrieved from payment provider

Reimplemented in BxPaymentProviderStripeConnect, and BxPaymentProviderStripeV3.

_retrieveProduct()

BxPaymentProviderStripeBasic::_retrieveProduct ( $sId )

protected

Hooks:

'bx_payment', 'stripe_retrieve_product' - hook to override product data retrieved from payment provider

• $unit_name - equals bx_payment
• $action - equals stripe_retrieve_product
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • product_id - [string] by ref, unique product id, can be overridden in hook processing
  • product_object - [object] by ref, an instance of product, redurned by payment provider, can be overridden in hook processing

    HOOKS

    'bx_payment', 'stripe_retrieve_product' - hook to override product data retrieved from payment provider

Hooks:

'bx_payment', 'stripe_v3_retrieve_product' - hook to override product data retrieved from payment provider

It's equivalent to 'bx_payment', 'stripe_retrieve_product' - hook to override product data retrieved from payment provider

HOOKS

'bx_payment', 'stripe_v3_retrieve_product' - hook to override product data retrieved from payment provider

_retrieveSubscription()

BxPaymentProviderStripeBasic::_retrieveSubscription ( $sCustomerId, $sSubscriptionId )

protected

Reimplemented in BxPaymentProviderStripeConnect, and BxPaymentProviderStripeV3.

addJsCss()

BxPaymentProviderStripeBasic::addJsCss

(

)

Reimplemented from BxBaseModPaymentProvider.

getSubscription()

BxPaymentProviderStripeBasic::getSubscription	(		$iPendingId,
			$sCustomerId,
			$sSubscriptionId )

Reimplemented from BxBaseModPaymentProvider.

initOptions()

BxPaymentProviderStripeBasic::initOptions

(

$aOptions

)

Reimplemented from BxBaseModPaymentProvider.

---

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

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