BxPaymentModule Class Reference

Inheritance diagram for BxPaymentModule:

Public Member Functions
	actionGetClients ()
	serviceGetModulesWithPayments ()
	serviceIsCreditsOnly ()
	serviceIsAcceptingPayments ($iVendorId, $sPaymentType='')
	serviceIsPaymentProvider ($iVendorId, $sVendorProvider, $sPaymentType='')
	serviceGetPaymentProvider ($iVendorId, $sVendorProvider, $sPaymentType='')
	serviceIsProviderOptions ($iVendorId, $sVendorProvider, $sPaymentType='')
	serviceGetProviderOptions ($iVendorId, $sVendorProvider, $sPaymentType='')
	serviceGetOptionsDefaultCurrencyCode ()
	serviceGetOptionsSiteAdmin ()
	actionAddToCart ($iSellerId, $iModuleId, $iItemId, $iItemCount, $sCustom='')
	actionDeleteFromCart ($iSellerId, $iModuleId, $iItemId)
	actionEmptyCart ($iSellerId)
	actionAuthorizeCheckout ($sType)
	serviceAuthorizeCheckout ($sType, $iSellerId, $sProvider, $aItems=[], $sRedirect='')
	serviceCaptureAuthorizedCheckout ($sType, $sOrderAuth, $sRedirect='')
	serviceInitializeCheckout ($sType, $iSellerId, $sProvider, $aItems=array(), $sRedirect='', $aCustoms=array())
	actionCall ($sProvider, $sAction, $mixedVendorId=BX_PAYMENT_EMPTY_ID)
	registerSubscription ($aPending, $aParams=array())
	cancelSubscription ($mixedPending)
	serviceGetPaymentData ()
	serviceGetCartItem ($mixedItemId)
	serviceGetCartItems ($iCommissionaireId)
	serviceRegisterCartItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
	serviceUnregisterCartItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
Public Member Functions inherited from BxBaseModPaymentModule
	serviceUpdateDependentModules ($sModule='all', $bInstall=true)
	serviceGenerateLicense ()
	serviceGetCurrencyInfo ($iVendorId=0)
	serviceGetOption ($sOption)
	serviceGetProvider ($sProvider, $mixedVendorId=BX_PAYMENT_EMPTY_ID)
	serviceGetProvidersCart ($iVendorId)
	alert ($sAction, $iObjectId, $iSender=false, $aExtras=array())
Public Member Functions inherited from BxBaseModGeneralModule
	actionAjaxGetProfiles ()
	serviceModuleIcon ()
	serviceGetLink ($iContentId)
	serviceGetSearchResultUnit ($iContentId, $sUnitTemplate='')
	serviceBrowse ($aParams=array())
	serviceBrowseFeatured ($sUnitView=false, $bEmptyMessage=false, $bAjaxPaginate=true)
	serviceBrowseFavorite ($iProfileId=0, $aParams=array())
	serviceBrowseFavoriteLists ($iProfileId=0, $aParams=array())
	serviceBrowseCategory ($sUnitView=false, $bEmptyMessage=true, $bAjaxPaginate=true, $aParams=[])
	serviceFavoritesListActions ()
	serviceFavoritesListInfo ($aParams=array())
	serviceBrowseContext ($iProfileId=0, $aParams=array())
	serviceEntityAdd ($iProfile, $aValues, $sDisplay=false)
	serviceRedirectAfterAdd ($aContentInfo)
	serviceGetObjectForm ($sType, $aParams=array())
	serviceEntityCreate ($sParams=false)
	serviceGetCreatePostForm ($aParams=[])
	serviceEntityEdit ($iContentId=0, $sDisplay=false)
	serviceEntityDelete ($iContentId=0)
	serviceEntityTextBlock ($iContentId=0)
	serviceEntityInfo ($iContentId=0, $sDisplay=false)
	serviceEntityInfoFull ($iContentId=0)
	serviceEntityInfoExtended ($iContentId=0)
	serviceEntityLocation ($iContentId=0)
	serviceEntityComments ($iContentId=0)
	serviceEntityAttachments ($iContentId=0)
	serviceDeleteEntity ($iContentId, $sFuncDelete='deleteData')
	serviceMyEntriesActions ($iProfileId=0)
	serviceEntityAllActions ($mixedContent=false, $aParams=array())
	serviceEntityActions ($iContentId=0)
	serviceEntityReports ($iContentId=0)
	serviceReportsCountByStatus ($iStatus)
	serviceEntitySocialSharing ($mixedContent=false, $aParams=array())
	serviceEntityContext ($iContentId=0)
	serviceGetLablesTree ()
	serviceGetNotificationsData ()
	serviceGetNotificationsPost ($aEvent)
	serviceGetNotificationsComment ($aEvent)
	serviceGetNotificationsReply ($aEvent)
	serviceGetNotificationsVote ($aEvent)
	serviceGetNotificationsReaction ($aEvent)
	serviceGetNotificationsScoreUp ($aEvent)
	serviceGetNotificationsScoreDown ($aEvent)
	serviceGetTimelineData ()
	serviceGetTimelinePost ($aEvent, $aBrowseParams=array())
	serviceCheckAllowed ($sAction, $isPerformAction=false)
	serviceCheckAllowedWithContent ($sAction, $iContentId, $isPerformAction=false)
	serviceCheckAllowedWithContentForProfile ($sAction, $iContentId, $iProfileId, $isPerformAction=false)
	serviceCategoriesMultiList ($bDisplayEmptyCats=true)
	serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction=false, $iProfileId=false)
	checkAllowedBrowse ()
	checkAllowedView ($aDataEntry, $isPerformAction=false)
	checkAllowedViewForProfile ($aDataEntry, $iProfileId, $isPerformAction=false)
	checkAllowedAdd ($isPerformAction=false)
	checkAllowedApprove ($aDataEntry, $isPerformAction=false)
	checkAllowedEdit ($aDataEntry, $isPerformAction=false)
	checkAllowedDelete (&$aDataEntry, $isPerformAction=false)
	checkAllowedSetMembership (&$aDataEntry, $isPerformAction=false)
	checkAllowedEditAnyEntry ($isPerformAction=false)
	checkAllowedDeleteAnyEntry ($isPerformAction=false)
	checkAllowedEditAnyEntryForProfile ($isPerformAction=false, $iProfileId=false)
	checkAllowedDeleteAnyEntryForProfile ($isPerformAction=false, $iProfileId=false)
	checkAllowedCommentsView ($aContentInfo, $isPerformAction=false)
	checkAllowedCommentsPost ($aContentInfo, $isPerformAction=false)
Public Member Functions inherited from BxDolModule
	__construct ($aModule)
	isEnabled ()
	getName ()
	isLogged ()
	getUserId ()
	getUserPassword ()

Additional Inherited Members
Static Public Member Functions inherited from BxDolModule
static	getInstance ($sName)
Protected Member Functions inherited from BxBaseModGeneralModule
	_serviceBrowseQuick ($aProfiles, $iStart=0, $iLimit=4, $aAdditionalParams=array())
	_alertParams ($aContentInfo)

Detailed Description

Payment module by BoonEx

This module is needed to work with payment providers and organize the process of some item purchasing. Shopping Cart and Orders Manager are included.

Integration notes: To integrate your module with this one, you need:

1. Get 'Add To Cart' button using serviceGetAddToCartLink service.
2. Add info about your module in the 'bx_pmt_modules' table.
3. Realize the following service methods in your Module class. a. serviceGetItems($iSellerId) - Is used in Orders Administration to get all products of the requested seller(vendor). b. serviceGetCartItem($iClientId, $iItemId) - Is used in Shopping Cart to get one product by specified id. c. serviceRegisterCartItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrderId) - Register purchased product. d. serviceUnregisterCartItem($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrderId) - Unregister the product purchased earlier.

   See also

   You may see an example of integration in Membership module.

   Profile's Wall: no spy events

Spy: no spy events

Memberships/ACL: Doesn't depend on user's membership.

Service methods:

Is used to get "Add to cart" link for some item(s) in your module.

See also

BxPmtModule::serviceGetAddToCartLink BxDolService::call('payment', 'get_add_to_cart_link', array($iSellerId, $mixedModuleId, $iItemId, $iItemCount));

Check transaction(s) in database which satisty all conditions.

See also

BxPmtModule::serviceGetOrdersInfo BxDolService::call('payment', 'get_orders_info', array($aConditions), 'Orders');

Get total count of items in Shopping Cart.

See also

BxPmtModule::serviceGetCartItemsCount BxDolService::call('payment', 'get_cart_items_count', array($iUserId, $iOldCount));

Note

is needed for internal usage(integration with member tool bar).

Get Shopping cart content.

See also

BxPmtModule::serviceGetCartItems BxDolService::call('payment', 'get_cart_items');

Note

is needed for internal usage(integration with member tool bar).

Alerts: no alerts available

Member Function Documentation

actionAddToCart()

BxPaymentModule::actionAddToCart	(		$iSellerId,
			$iModuleId,
			$iItemId,
			$iItemCount,
			$sCustom = ''
	)

Cart Processing Methods

actionAuthorizeCheckout()

BxPaymentModule::actionAuthorizeCheckout

(

$sType

)

Payment Processing Methods

actionCall()

BxPaymentModule::actionCall	(		$sProvider,
			$sAction,
			$mixedVendorId = BX_PAYMENT_EMPTY_ID
	)

The method is needed to pass direct action calls to necessary Payment Provider.

actionDeleteFromCart()

BxPaymentModule::actionDeleteFromCart	(		$iSellerId,
			$iModuleId,
			$iItemId
	)

Isn't used yet.

actionEmptyCart()

BxPaymentModule::actionEmptyCart

(

$iSellerId

)

Isn't used yet.

actionGetClients()

BxPaymentModule::actionGetClients

(

)

Manage Orders Methods

cancelSubscription()

BxPaymentModule::cancelSubscription

(

$mixedPending

)

Deprecated:

since version 12.0.0

BxPaymentSubscriptions::cancelLocal instead.

registerSubscription()

BxPaymentModule::registerSubscription	(		$aPending,
			$aParams = array()
	)

Deprecated:

since version 12.0.0

BxPaymentSubscriptions::register instead.

serviceAuthorizeCheckout()

BxPaymentModule::serviceAuthorizeCheckout	(		$sType,
			$iSellerId,
			$sProvider,
			$aItems = [],
			$sRedirect = ''
	)

authorize_checkout

serviceCaptureAuthorizedCheckout()

BxPaymentModule::serviceCaptureAuthorizedCheckout	(		$sType,
			$sOrderAuth,
			$sRedirect = ''
	)

capture_authorized_checkout

serviceGetCartItem()

BxPaymentModule::serviceGetCartItem

(

$mixedItemId

)

get_cart_item

serviceGetCartItems()

BxPaymentModule::serviceGetCartItems

(

$iCommissionaireId

)

get_cart_items

serviceGetModulesWithPayments()

BxPaymentModule::serviceGetModulesWithPayments

(

)

get_modules_with_payments

serviceGetOptionsDefaultCurrencyCode()

BxPaymentModule::serviceGetOptionsDefaultCurrencyCode

(

)

get_options_default_currency_code

serviceGetOptionsSiteAdmin()

BxPaymentModule::serviceGetOptionsSiteAdmin

(

)

get_options_site_admin

serviceGetPaymentData()

BxPaymentModule::serviceGetPaymentData

(

)

get_payment_data

serviceGetPaymentProvider()

BxPaymentModule::serviceGetPaymentProvider	(		$iVendorId,
			$sVendorProvider,
			$sPaymentType = ''
	)

Deprecated:

since version 11.0.0

See also

BxPaymentModule::serviceGetProviderOptions

serviceGetProviderOptions()

BxPaymentModule::serviceGetProviderOptions	(		$iVendorId,
			$sVendorProvider,
			$sPaymentType = ''
	)

get_provider_options

serviceInitializeCheckout()

BxPaymentModule::serviceInitializeCheckout	(		$sType,
			$iSellerId,
			$sProvider,
			$aItems = array(),
			$sRedirect = '',
			$aCustoms = array()
	)

initialize_checkout

serviceIsAcceptingPayments()

BxPaymentModule::serviceIsAcceptingPayments	(		$iVendorId,
			$sPaymentType = ''
	)

is_accepting_payments

serviceIsCreditsOnly()

BxPaymentModule::serviceIsCreditsOnly

(

)

is_credits_only

serviceIsPaymentProvider()

BxPaymentModule::serviceIsPaymentProvider	(		$iVendorId,
			$sVendorProvider,
			$sPaymentType = ''
	)

Deprecated:

since version 11.0.0

See also

BxPaymentModule::serviceIsProviderOptions

serviceIsProviderOptions()

BxPaymentModule::serviceIsProviderOptions	(		$iVendorId,
			$sVendorProvider,
			$sPaymentType = ''
	)

is_provider_options

serviceRegisterCartItem()

BxPaymentModule::serviceRegisterCartItem	(		$iClientId,
			$iSellerId,
			$iItemId,
			$iItemCount,
			$sOrder,
			$sLicense
	)

register_cart_item

serviceUnregisterCartItem()

BxPaymentModule::serviceUnregisterCartItem	(		$iClientId,
			$iSellerId,
			$iItemId,
			$iItemCount,
			$sOrder,
			$sLicense
	)

unregister_cart_item

---

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

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