UNA
Loading...
Searching...
No Matches
BxPaymentProviderStripe Class Reference
UNA Modules » Payment
Inheritance diagram for BxPaymentProviderStripe:
BxPaymentProviderStripeBasic iBxBaseModPaymentProvider BxBaseModPaymentProvider BxDol

Public Member Functions

 __construct ($aConfig)
 initializeCheckout ($iPendingId, $aCartInfo, $sRedirect='')
 finalizeCheckout (&$aData)
 getCheckoutParamsSingle ($aParams, &$oGrid)
 getVerificationCodeCharge ($iVendorId, $iCustomerId, $fAmount, $sCurrency)
 checkVerificationCodeCharge ($iVendorId, $iCustomerId, $aResult)
 getVerificationCodeSubscription ($iVendorId, $iCustomerId, $sSubscription, $sCurrency)
 checkVerificationCodeSubscription ($iVendorId, $iCustomerId, $aResult)
Public Member Functions inherited from BxPaymentProviderStripeBasic
 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')
Public Member Functions inherited from iBxBaseModPaymentProvider
 initializeCheckout ($iPendingId, $aCartInfo)
 finalizedCheckout ()

Protected Member Functions

 _createToken ($aCard)
 _createCustomer ($sType, $sToken, $aClient)
 _createCharge ($sToken, $iPendingId, &$aClient, &$aCartInfo)
 _createSubscription ($sToken, $iPendingId, &$aClient, &$aCartInfo)
 _createCard ($sType, $sCustomerId, $sToken)
 _retrieveCard ($sCustomerId, $sCardId='')
 _retrieveCoupon ($sId)
 _getButtonJs ($sType, $iClientId, $iVendorId, $aParams=array())
 _getVerificationCodeCharge ($iVendorId, $iCustomerId, $fAmount, $sCurrency)
 _checkVerificationCodeCharge ($iVendorId, $iCustomerId, $aResult)
 _getVerificationCodeSubscription ($iVendorId, $iCustomerId, $sSubscription, $sCurrency)
 _checkVerificationCodeSubscription ($iVendorId, $iCustomerId, $aResult)
Protected Member Functions inherited from BxPaymentProviderStripeBasic
 _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='', $iLevel=BX_LOG_DEBUG)

Additional Inherited Members

Protected Attributes inherited from BxPaymentProviderStripeBasic
 $_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()

BxPaymentProviderStripe::__construct ( $aConfig)

Reimplemented from BxPaymentProviderStripeBasic.

Member Function Documentation

◆ _createCharge()

BxPaymentProviderStripe::_createCharge ( $sToken,
$iPendingId,
& $aClient,
& $aCartInfo )
protected

Hooks:

'bx_payment', 'stripe_create_charge' - hook to override charge data redurned by payment provider

  • $unit_name - equals bx_payment
  • $action - equals stripe_create_charge
  • $object_id - pending transaction id
  • $sender_id - not used
  • $extra_params - array of additional params with the following array keys:
    • charge_object - [object] by ref, an instance of charge, redurned by payment provider, can be overridden in hook processing
    • charge_params - [array] by ref, array with charge parameters, can be overridden in hook processing
HOOKS
'bx_payment', 'stripe_create_charge' - hook to override charge data redurned by payment provider

◆ _createCustomer()

BxPaymentProviderStripe::_createCustomer ( $sType,
$sToken,
$aClient )
protected

Hooks:

'bx_payment', 'stripe_create_customer' - hook to override customer data redurned by payment provider

  • $unit_name - equals bx_payment
  • $action - equals stripe_create_customer
  • $object_id - not used
  • $sender_id - client (buyer) profile id
  • $extra_params - array of additional params with the following array keys:
    • type - [string] payment type: single or recurring
    • customer_object - [object] by ref, an instance of customer, redurned by payment provider, can be overridden in hook processing
    • customer_params - [array] by ref, array with customer parameters, can be overridden in hook processing
HOOKS
'bx_payment', 'stripe_create_customer' - hook to override customer data redurned by payment provider

◆ _createSubscription()

BxPaymentProviderStripe::_createSubscription ( $sToken,
$iPendingId,
& $aClient,
& $aCartInfo )
protected

Hooks:

'bx_payment', 'stripe_create_subscription' - hook to override subscription data redurned by payment provider

  • $unit_name - equals bx_payment
  • $action - equals stripe_create_subscription
  • $object_id - pending transaction id
  • $sender_id - not used
  • $extra_params - array of additional params with the following array keys:
    • customer - [object] by ref, an instance of customer, can be overridden in hook processing
    • subscription_object - [object] by ref, an instance of subscription, redurned by payment provider, can be overridden in hook processing
    • subscription_params - [array] by ref, array with subscription parameters, can be overridden in hook processing
HOOKS
'bx_payment', 'stripe_create_subscription' - hook to override subscription data redurned by payment provider

◆ _getButtonJs()

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

Hooks:

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

  • $unit_name - equals bx_payment
  • $action - equals stripe_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
    • public_key - [string] by ref, Stripe public key, can be overridden in hook processing
HOOKS
'bx_payment', 'stripe_get_button' - hook to override checkout/subscibe button

◆ checkVerificationCodeCharge()

BxPaymentProviderStripe::checkVerificationCodeCharge ( $iVendorId,
$iCustomerId,
$aResult )

Hooks:

'bx_payment', 'stripe_verify_charge' - hook to override code verification for 'charge' action

  • $unit_name - equals bx_payment
  • $action - equals stripe_verify_charge
  • $object_id - not used
  • $sender_id - not used
  • $extra_params - array of additional params with the following array keys:
    • provider - [object] an instance of provider,
      See also
      BxBaseModPaymentProvider
    • vendor_id - [int] vendor (seller) profile id
    • customer_id - [int] customer (buyer) profile id
    • result - [array] results array received from payment provider
    • override_result - [boolean] by ref, is verification passed or not, can be overridden in hook processing
HOOKS
'bx_payment', 'stripe_verify_charge' - hook to override code verification for 'charge' action

◆ checkVerificationCodeSubscription()

BxPaymentProviderStripe::checkVerificationCodeSubscription ( $iVendorId,
$iCustomerId,
$aResult )

Hooks:

'bx_payment', 'stripe_verify_subscription' - hook to override code verification for 'subscribe' action

It's equivalent to 'bx_payment', 'stripe_verify_charge' - hook to override code verification for 'charge' action

HOOKS
'bx_payment', 'stripe_verify_subscription' - hook to override code verification for 'subscribe' action

◆ finalizeCheckout()

BxPaymentProviderStripe::finalizeCheckout ( & $aData)

Implements iBxBaseModPaymentProvider.

◆ getVerificationCodeCharge()

BxPaymentProviderStripe::getVerificationCodeCharge ( $iVendorId,
$iCustomerId,
$fAmount,
$sCurrency )

Hooks:

'bx_payment', 'stripe_get_code_charge' - hook to override verification code for 'charge' action

  • $unit_name - equals bx_payment
  • $action - equals stripe_get_code_charge
  • $object_id - not used
  • $sender_id - not used
  • $extra_params - array of additional params with the following array keys:
    • provider - [object] an instance of provider,
      See also
      BxBaseModPaymentProvider
    • vendor_id - [int] vendor (seller) profile id
    • customer_id - [int] customer (buyer) profile id
    • amount - [float] charge amount
    • currency - [string] charge currency code
    • override_result - [string] by ref, verification code, can be overridden in hook processing
HOOKS
'bx_payment', 'stripe_get_code_charge' - hook to override verification code for 'charge' action

◆ getVerificationCodeSubscription()

BxPaymentProviderStripe::getVerificationCodeSubscription ( $iVendorId,
$iCustomerId,
$sSubscription,
$sCurrency )

Hooks:

'bx_payment', 'stripe_get_code_subscription' - hook to override verification code for 'subscribe' action

  • $unit_name - equals bx_payment
  • $action - equals stripe_get_code_subscription
  • $object_id - not used
  • $sender_id - not used
  • $extra_params - array of additional params with the following array keys:
    • provider - [object] an instance of provider,
      See also
      BxBaseModPaymentProvider
    • vendor_id - [int] vendor (seller) profile id
    • customer_id - [int] customer (buyer) profile id
    • subscription - [string] unique subscription id
    • currency - [string] charge currency code
    • override_result - [string] by ref, verification code, can be overridden in hook processing
HOOKS
'bx_payment', 'stripe_get_code_subscription' - hook to override verification code for 'subscribe' action
The documentation for this class was generated from the following file:
  • modules/boonex/payment/classes/BxPaymentProviderStripe.php