Inheritance diagram for BxPaymentModule:

Public Member Functions
	__construct ($aModule)

	actionGetClients ()

	actionGetItems ($sType, $iModuleId)

	actionGetFilterValuesItem ($iSellerId, $iModuleId)

	serviceGetSafeServices ()

	serviceGetModulesWithPayments ()

	serviceIsCreditsOnly ()

	serviceIsAcceptingPayments ($iVendorId, $sPaymentType='')

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

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

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

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

	serviceGetOptionsDefaultCurrencyCode ()

	serviceGetOptionsPersonalCurrencyCode ()

	serviceGetOptionsSiteAdmin ()

	serviceGetMenuAddonManageTools ()

	serviceGetBlockCheckoutOffline ()

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

	actionDeleteFromCart ($iSellerId, $iModuleId, $iItemId)

	actionEmptyCart ($iSellerId)

	actionSubscribe ()

	actionSubscribeJson ()

	actionSubscriptionGetDetails ($iId)

	actionSubscriptionChangeDetails ($iId)

	actionSubscriptionGetBilling ($iId)

	actionSubscriptionChangeBilling ($iId)

	actionSubscriptionCancelation ($iId)

	actionSubscriptionCancel ($iId, $mixedGridObject=false)

	actionAuthorizeCheckout ($sType)

	actionCaptureAuthorizedCheckout ($sType)

	actionInitializeCheckout ($sType)

	actionInitializeCheckoutJson ($sType)

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

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

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

	serviceInitializeCheckoutApi ($sType, $iSellerId, $sProvider, $aItems=[], $sRedirect='', $aCustoms=[])

	actionFinalizeCheckout ($sProvider, $mixedVendorId="")

	serviceFinalizeCheckout ($sProvider, $mixedVendorId="", $aData=[])

	actionFinalizedCheckout ($sProvider, $mixedVendorId="")

	actionNotify ($sProvider, $mixedVendorId="")

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

	onProfileJoin ($iProfileId)

	onProfileDelete ($iProfileId)

	isAllowedPurchase ($aItem, $bPerform=false)

	isAllowedSell ($aItem, $bPerform=false)

	isAllowedManage ($aPending, $bPerform=false)

	isAllowedManageInvoices ($bPerform=false)

	checkData ($iClientId, $iSellerId, $iModuleId, $iItemId, $iItemCount, $aCustom=array())

	authorizePayment ($mixedPending)

	registerPayment ($mixedPending)

	refundPayment ($mixedPending)

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

	cancelSubscription ($mixedPending)

	processCommissions ()

	processTimeTracker ()

	onPaymentRegisterBefore ($aPending, $aResult=[])

	onPaymentAuthorize ($aPending, $aResult=[])

	onPaymentRegister ($aPending, $aResult=[])

	onPaymentRefund ($aPending, $aResult=[])

	onSubscriptionCreate ($aPending, $aSubscription, $aResult=[])

	onSubscriptionProlong ($aPending, $aSubscription, $aResult=[])

	onSubscriptionOverdue ($aPending, $aSubscription, $aResult=[])

	onSubscriptionCancel ($aPending, $aSubscription, $aResult=[])

	setSiteSubmenu ($sSubmenu, $sSelModule, $sSelName)

	getProviderButtonJs ($aCartItem, $aProvider, $sRedirect='', $aCustom=array())

	serviceGetPaymentData ()

	serviceGetCartItem ($mixedItemId)

	serviceGetCartItems ($iCommissionaireId)

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

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

	serviceStripeV3CreateSessionApi ($mixedParams)

	serviceConvert ($fAmount, $sCurrencyFrom, $sCurrencyTo, $fRate=false)

	updateCurrencyExchangeRates ()

Public Member Functions inherited from BxBaseModPaymentModule
	serviceUpdateDependentModules ($sModule='all', $bInstall=true)

	serviceGenerateLicense ()

	serviceGetCurrencyInfo ($iVendorId=0)

	serviceGetCurrencyCode ($iVendorId=0)

	serviceGetCurrencySign ($iVendorId=0)

	serviceGetOption ($sOption)

	serviceGetProvider ($sProvider, $mixedVendorId=BX_PAYMENT_EMPTY_ID)

	serviceGetProvidersCart ($iVendorId)

	isSingleSeller ()

	getVendorInfo ($iUserId)

	getVendorCurrencyCode ($iUserId)

	getVendorCurrencySign ($iUserId)

	getObjectJoin ()

	getObjectCart ()

	getObjectOrders ()

	getObjectDetails ()

	getObjectSubscriptions ()

	getObjectProvider ($sProvider, $mixedVendorId=BX_PAYMENT_EMPTY_ID)

	alert ($sAction, $iObjectId, $iSender=false, $aExtras=array())

	callGetPaymentData ($mixedModule)

	callGetCartItem ($mixedModule, $aParams)

	callGetCartItems ($mixedModule, $aParams)

	callAuthorizeCartItem ($mixedModule, $aParams)

	callRegisterCartItem ($mixedModule, $aParams)

	callReregisterCartItem ($mixedModule, $aParams)

	callAuthorizeSubscriptionItem ($mixedModule, $aParams)

	callRegisterSubscriptionItem ($mixedModule, $aParams)

	callReregisterSubscriptionItem ($mixedModule, $aParams)

	callUnregisterCartItem ($mixedModule, $aParams)

	callUnregisterSubscriptionItem ($mixedModule, $aParams)

	callCancelSubscriptionItem ($mixedModule, $aParams)

	log ($mixedContents, $sSection='', $sTitle='')

Public Member Functions inherited from BxBaseModGeneralModule
	__construct (&$aModule)

	isEntryActive ($aContentInfo)

	isEntryAuthor ($aContentInfo, $iProfileId=0)

	actionUpdateImage ($sFiledName, $iContentId, $sValue)

	actionUpdateImagePosition ($iContentId, $sFiledName, $sH, $sV)

	actionApprove ()

	serviceSetStatus ($iId, $sValue, $sStatus='')

	actionRss ()

	actionGetCreatePostForm ()

	actionGetNotes ()

	actionNested ()

	actionEmbed ($iContentId, $sUnitTemplate='', $sAddCode='')

	subactionDelete ()

	actionAjaxGetProfiles ()

	serviceGetProfiles ($sParams)

	actionGetBrowsingFilters ()

	actionApplyBrowsingFilters ()

	serviceIsBadgesAvaliable ()

	serviceModuleIcon ()

	serviceGetAuthor ($iContentId)

	serviceGetPrivacyView ($iContentId)

	serviceGetDateAdded ($iContentId)

	serviceGetDateChanged ($iContentId)

	serviceGetLink ($iContentId)

	serviceGetTitle ($iContentId)

	serviceGetText ($iContentId)

	serviceGetLocation ($iContentId)

	serviceGetEmbed ($iContentId)

	serviceGetInfo ($iContentId, $bSearchableFieldsOnly=true)

	serviceGetInfoApi ($iContentId, $bExtendedUnits=false)

	serviceGetSearchResultUnit ($iContentId, $sUnitTemplate='')

	serviceGetAll ($aParams=array())

	serviceGetAllByAuthor ($iProfileId)

	serviceGetSortableFieldsExtended ($aInputsAdd=array())

	serviceGetSearchableFieldsExtended ($aInputsAdd=array())

	serviceGetSearchResultExtended ($aParams, $iStart=0, $iPerPage=0, $bFilterMode=false)

	serviceGetSearchableFields ($aInputsAdd=array())

	serviceUpdateImage ($sFiledName, $iContentId, $sValue)

	serviceUpdateImagePosition ($iContentId, $sFiledName, $sH, $sV)

	serviceManageTools ($sType='common')

	serviceGetMenuAddonManageToolsProfileStats ($iProfileId=0)

	serviceBrowse ($aParams=array())

	serviceBrowseWithCondition ($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())

	_serviceBrowseWithParam ($sParamName, $sParamGet, $sParamVal, $aParams=array())

	serviceFormsHelper ()

	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 ()

	serviceGetLablesBreadcrumbs ()

	serviceBrowseByLabel ()

	serviceBrowseByCategories ($sUnitView, $bEmptyMessage, $bAjaxPaginate, $sMode, $iPerPage)

	serviceGetNotificationsData ()

	serviceGetNotificationsPost ($aEvent)

	serviceGetNotificationsPostPendingApproval ($aEvent)

	serviceGetNotificationsPostApproved ($aEvent)

	serviceGetNotificationsPostPublishFailed ($aEvent)

	serviceGetNotificationsPostPublishSucceeded ($aEvent)

	serviceGetNotificationsComment ($aEvent)

	serviceGetNotificationsReply ($aEvent)

	serviceGetNotificationsVote ($aEvent)

	serviceGetNotificationsReaction ($aEvent)

	serviceGetNotificationsScoreUp ($aEvent)

	serviceGetNotificationsScoreDown ($aEvent)

	serviceGetTimelineData ()

	serviceGetTimelinePost ($aEvent, $aBrowseParams=array())

	serviceGetTimelinePostAllowedView ($aEvent)

	serviceCheckAllowed ($sAction, $isPerformAction=false)

	serviceCheckAllowedWithContent ($sAction, $iContentId, $isPerformAction=false)

	serviceCheckAllowedWithContentForProfile ($sAction, $iContentId, $iProfileId, $isPerformAction=false)

	serviceCheckAllowedCommentsView ($iContentId, $sObjectComments)

	serviceCheckAllowedCommentsPost ($iContentId, $sObjectComments)

	serviceGetContentOwnerProfileId ($iContentId)

	serviceGetBadges ($iContentId, $bIsSingle=false, $bIsCompact=false)

	serviceCategoriesMultiList ($bDisplayEmptyCats=true)

	serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction=false, $iProfileId=false)

	checkAllowedSetThumb ($iContentId=0)

	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)

	_serviceBrowse ($sMode, $aParams=false, $iDesignBox=BX_DB_PADDING_DEF, $bDisplayEmptyMsg=false, $bAjaxPaginate=true, $sClassSearchResult='SearchResult')

	onPublished ($iContentId)

	onFailed ($iContentId)

	onApprove ($mixedContent)

	onUpdateImage ($iContentId, $sFiledName, $sFiledValue, $iProfileId=0)

	alertAfterAdd ($aContentInfo)

	alertAfterEdit ($aContentInfo)

	alertAfterApprove ($aContentInfo)

	processMetasAdd ($iContentId)

	processMetasEdit ($iContentId, $oForm)

	getEntryImageData ($aContentInfo, $sField='FIELD_THUMB', $aTranscoders=array())

	getEntryAllActions ($mixedContent=false, $aParams=[])

	getProfileId ()

	getProfileInfo ($iUserId=false)

	getObjectUser ($iUserId=false)

	getObjectFavorite ($sSystem='', $iId=0)

	getUserId ()

	getUserIp ()

	getUserInfo ($iUserId=0)

	getUserInfoWithBadges ($iUserId=0)

	isMenuItemVisible ($sObject, &$aItem, &$aContentInfo)

	_isModerator ($isPerformAction=false)

	_isModeratorForProfile ($isPerformAction=false, $iProfileId=false)

	_isAdministrator ($isPerformAction=false)

	_isAdministratorForProfile ($isPerformAction=false, $iProfileId=false)

	_prepareAuditParams ($aContentInfo, $bIsSaveData=true, $aOverrideAuditParams=array())

	_getFavoriteListUrl ($iListId, $iProfileId)

	getDataAPI ($aData, $aParams=[])

	decodeDataAPI ($aData, $aParams=[])

Public Member Functions inherited from BxDolModule
	isEnabled ()

	getName ()

	isLogged ()

	getUserPassword ()

	serviceIsSafeService ($s)

	serviceIsPublicService ($s)

	serviceGetPublicServices ()

Protected Member Functions
	_invoicesIssue ()

	_invoicesCheck ()

Protected Member Functions inherited from BxBaseModGeneralModule
	_prepareBrowsingFiltersParamsGet ($mParams=false)

	_serviceGetNotificationsScore ($sType, $aEvent)

	_serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId)

	_serviceBrowseQuick ($aProfiles, $iStart=0, $iLimit=4, $aAdditionalParams=array())

	_alertParams ($aContentInfo)

	_serviceEntityForm ($sFormMethod, $iContentId=0, $sDisplay=false, $sCheckFunction=false, $bErrorMsg=true)

	_serviceTemplateFunc ($sFunc, $iContentId, $sFuncGetContent='getContentInfoById')

	_serviceTemplateFuncEx ($sFunc, $iContentId, $aParams=array())

	_getApproveForm ($iContentId, $aContentInfo)

	_sendApproveMessage ($iContentId, $aContentInfo, &$oForm)

	_processModerationNotifications ($aContentInfo)

	_rss ($aArgs, $sClass='SearchResult')

	_getContent ($iContentId=0, $sFuncGetContent=true)

	_getContentForTimelinePost ($aEvent, $aContentInfo, $aBrowseParams=array())

	_getImagesForTimelinePost ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())

	_getImagesForTimelinePostAttach ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())

	_getVideosForTimelinePost ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())

	_getVideosForTimelinePostAttach ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())

	_getFilesForTimelinePost ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())

	_getFilesForTimelinePostAttach ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())

	_entityComments ($sObject, $iId=0)

	_getFields ($iContentId)

	_getFieldValue ($sField, $iContentId)

	_getFieldValueThumb ($sField, $iContentId, $sTranscoder='')

	_prepareResponse ($aResponse, $bAsJson=false, $aAdditional=array())

Protected Attributes
	$_iUserId

	$_aOrderTypes

Protected Attributes inherited from BxBaseModPaymentModule
	$_sLangsPrefix

Protected Attributes inherited from BxBaseModGeneralModule
	$_bIsApi

	$_iProfileId

	$_aSearchableNamesExcept

	$_aFormParams

	$_aBrowsingFiltersKeys

Additional Inherited Members
Static Public Member Functions inherited from BxDolModule
static	getInstance ($sName)

static	getTitle ($sUri)

static	getTitleKey ($sUri)

Public Attributes inherited from BxDolModule
	$_aModule

	$_oDb

	$_oTemplate

	$_oConfig

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:

Get 'Add To Cart' button using serviceGetAddToCartLink service.
Add info about your module in the 'bx_pmt_modules' table.
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.