UNA
Loading...
Searching...
No Matches
BxCreditsModule Class Reference
Inheritance diagram for BxCreditsModule:
BxBaseModGeneralModule BxDolModule BxDol

Public Member Functions

 __construct (&$aModule)
 actionGetProfiles ()
 actionCheckBundleName ()
 actionCheckout ()
 actionSubscribe ()
 serviceGetSafeServices ()
 serviceGetCheckoutUrl ()
 serviceConvertMoneyToCredits ($fMoney, $fRate=false, $iPrecision=false)
 serviceConvertCreditsToMoney ($fCredits, $fRate=false, $iPrecision=false)
 serviceValidateCheckout ($iSeller, $iBuyer, $fAmount, $sOrder)
 serviceGetBlockCheckout ()
 serviceGetPopupSubscribe ($aData)
 serviceGetMenuItemAddonAmount ()
 serviceGetBlockBundles ()
 serviceGetBlockOrdersNote ()
 serviceGetBlockOrders ($sType='common')
 serviceGetBlockHistory ($sType='common')
 serviceGetBlockWithdrawals ($sType='common')
 serviceGetBlockProfiles ($sType='common')
 serviceGetPaymentData ()
 serviceGetCartItem ($iItemId)
 serviceGetCartItems ($iSellerId)
 serviceRegisterCartItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
 serviceRegisterSubscriptionItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
 serviceReregisterCartItem ($iClientId, $iSellerId, $iItemIdOld, $iItemIdNew, $sOrder)
 serviceReregisterSubscriptionItem ($iClientId, $iSellerId, $iItemIdOld, $iItemIdNew, $sOrder)
 serviceUnregisterCartItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
 serviceUnregisterSubscriptionItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
 serviceCancelSubscriptionItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder)
 serviceGetProfileBalance ($iProfileId=0)
 serviceUpdateProfileBalance ($iFirstPid, $fAmount, $iSecondPid=0, $sOrder='', $sInfo='')
 serviceMakePayment ($iBuyerPid, $fAmount, $iSellerPid, $sOrder='')
 serviceDeleteEntitiesByAuthor ($iProfileId)
 convertC2S ($fCredits, $bWithUnit=true)
 getProfileLimits ($iProfileId=0)
 getProfileBalance ($iProfileId=0)
 getProfileBalanceCleared ($iProfileId=0)
 updateProfileBalance ($iFirstPid, $iSecondPid, $fAmount, $sType, $sOrder='', $sInfo='', $sData='')
 processGrant ($iUserId, $iProfileId, $fAmount, $sMessage='')
 processSend ($iUserId, $iProfileId, $fAmount, $sMessage='')
 processWithdrawRequest ($iUserId, $iProfileId, $fAmount, $sMessage='')
 processWithdrawCancel ($iId)
 processWithdrawConfirm ($iUserId, $iWithdrawalId)
 processClearing ()
Public Member Functions inherited from BxBaseModGeneralModule
 isEntryActive ($aContentInfo)
 isEntryAuthor ($aContentInfo, $iProfileId=0)
 actionUpdateImage ($sFiledName, $iContentId, $sValue)
 actionUpdateImagePosition ($iContentId, $sFiledName, $sH, $sV)
 actionApprove ()
 serviceSetStatus ($iId, $sValue, $sStatus='')
 actionRss ()
 actionGetAttachLinkForm ()
 actionSubmitAttachLinkForm ()
 actionAddAttachLink ()
 actionDeleteAttachLink ()
 actionEmbedPoll ($iPollId=0)
 actionEmbedPolls ($iId=0)
 actionGetPoll ()
 actionDeletePoll ()
 actionGetPollForm ()
 actionSubmitPollForm ()
 serviceGetPollForm ()
 serviceSubmitPollForm ()
 serviceDeletePoll ($iId)
 getPollForm ($iParentCid=0)
 actionGetCreatePostForm ()
 actionGetNotes ()
 actionNested ()
 actionEmbed ($iContentId, $sUnitTemplate='', $sAddCode='')
 subactionDelete ()
 actionAjaxGetProfiles ()
 serviceGetProfiles ($sParams)
 actionGetBrowsingFilters ()
 actionApplyBrowsingFilters ()
 serviceIsActive ($iContentId)
 serviceIsAllowedAddContentToContext ($iContextPid)
 serviceIsBadgesAvaliable ()
 serviceModuleIcon ()
 serviceGetAuthor ($iContentId)
 serviceGetPrivacyView ($iContentId)
 serviceGetDateAdded ($iContentId)
 serviceGetDateChanged ($iContentId)
 serviceGetLinkAdd ()
 serviceGetLinkEdit ($iContentId)
 serviceGetLink ($iContentId)
 serviceGetTitle ($iContentId)
 serviceGetText ($iContentId)
 serviceGetLocation ($iContentId)
 serviceGetEmbed ($iContentId)
 serviceGetInfo ($iContentId, $bSearchableFieldsOnly=true)
 serviceGetInfoApi ($iContentId, $bExtendedUnits=false)
 serviceGetSearchResultUnit ($iContentId, $sUnitTemplate='')
 serviceGetView ($iContentId)
 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')
 serviceGetMenuAddonManageTools ()
 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=[])
 serviceBrowseMultiCategory ($sUnitView=false, $bEmptyMessage=true, $bAjaxPaginate=true, $aParams=[])
 serviceFavoritesListActions ()
 serviceFavoritesListInfo ($aParams=array())
 serviceBrowseContext ($iProfileId=0, $aParams=array())
 _serviceBrowseWithParam ($sParamName, $sParamGet, $sParamVal, $aParams=array())
 getFormsHelper ()
 serviceFormsHelper ()
 serviceEntityAdd ($iProfile, $aValues, $sDisplay=false)
 serviceEntityAddForcedly ($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)
 serviceEntityPolls ($iContentId=0)
 serviceDeleteEntity ($iContentId, $sFuncDelete='deleteData')
 serviceEditEntity ($iContentId, $aValues)
 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)
 serviceGetBlockPollAnswers ($iPollId, $bForceDisplay=false)
 serviceGetBlockPollResults ($iPollId)
 serviceGetNotificationsData ()
 serviceGetNotificationsPost ($aEvent)
 serviceGetNotificationsPostPendingApproval ($aEvent)
 serviceGetNotificationsPostApproved ($aEvent)
 serviceGetNotificationsPostPublishFailed ($aEvent)
 serviceGetNotificationsPostPublishSucceeded ($aEvent)
 serviceGetNotificationsComment ($aEvent)
 serviceGetNotificationsReply ($aEvent)
 serviceGetNotificationsVote ($aEvent)
 serviceGetNotificationsReaction ($aEvent)
 serviceGetNotificationsScoreUp ($aEvent)
 serviceGetNotificationsScoreDown ($aEvent)
 serviceGetReputationData ()
 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 ($bAsArray=false)
 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')
 isPollPerformed ($iObjectId, $iAuthorId=0, $iAuthorIp=0)
 getPollPerformedValue ($iObjectId, $iAuthorId=0)
 onPublished ($iContentId)
 onFailed ($iContentId)
 onApprove ($mixedContent)
 onUpdateImage ($iContentId, $sFiledName, $sFiledValue, $iProfileId=0)
 alertAfterAdd ($aContentInfo)
 alertAfterEdit ($aContentInfo)
 alertAfterApprove ($aContentInfo)
 processMetasAdd ($iContentId)
 processMetasEdit ($iContentId, $oForm)
 addAttachLink ($aValues, $sDisplay=false)
 getFormAttachLink ($iContentId=0)
 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
 __construct ($aModule)
 isEnabled ()
 getName ()
 isLogged ()
 getUserPassword ()
 serviceIsSafeService ($s)
 serviceIsPublicService ($s)
 serviceGetPublicServices ()

Protected Member Functions

 _serviceRegisterItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense, $sType)
 _serviceUnregisterItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense, $sType)
 _getBlockOrders ($sType)
 _getBlockHistory ($sType)
 _getBlockWithdrawals ($sType)
 _getBlockProfiles ($sType)
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)
 _addLink (&$oForm)
 _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())

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
Protected Attributes inherited from BxBaseModGeneralModule
 $_bIsApi
 $_iProfileId
 $_aSearchableNamesExcept
 $_aFormParams
 $_aBrowsingFiltersKeys

Constructor & Destructor Documentation

◆ __construct()

BxCreditsModule::__construct ( & $aModule)

Reimplemented from BxBaseModGeneralModule.

Member Function Documentation

◆ _serviceRegisterItem()

BxCreditsModule::_serviceRegisterItem ( $iClientId,
$iSellerId,
$iItemId,
$iItemCount,
$sOrder,
$sLicense,
$sType )
protected

Hooks:

'bx_credits', 'order_register' - hook after the payment for a bundle of credits was processed with payment processing module

  • $unit_name - equals bx_credits
  • $action - equals order_register
  • $object_id - not used
  • $sender_id - not used
  • $extra_params - array of additional params with the following array keys:

Hooks:

'bx_credits', 'order_prolong' - hook isn't currently used because 'single' type payments for bundles are only supported

It's equivalent to 'bx_credits', 'order_register' - hook after the payment for a bundle of credits was processed with payment processing module

HOOKS
'bx_credits', 'order_prolong' - hook isn't currently used because 'single' type payments for bundles are only supported

◆ _serviceUnregisterItem()

BxCreditsModule::_serviceUnregisterItem ( $iClientId,
$iSellerId,
$iItemId,
$iItemCount,
$sOrder,
$sLicense,
$sType )
protected

Hooks:

'bx_credits', 'order_unregister' - hook after the payment for a bundle of credits was refunded with payment processing module

  • $unit_name - equals bx_credits
  • $action - equals order_unregister
  • $object_id - not used
  • $sender_id - not used
  • $extra_params - array of additional params with the following array keys:

◆ actionCheckout()

BxCreditsModule::actionCheckout ( )

Hooks:

'bx_credits', 'checkout' - hook after checkout with creadits was performed

  • $unit_name - equals bx_credits
  • $action - equals checkout
  • $object_id - not used
  • $sender_id - not used
  • $extra_params - array of additional params with the following array keys:

◆ actionSubscribe()

BxCreditsModule::actionSubscribe ( )

Hooks:

'bx_credits', 'subscribe' - hook after subscription was registered

  • $unit_name - equals bx_credits
  • $action - equals subscribe
  • $object_id - not used
  • $sender_id - not used
  • $extra_params - array of additional params with the following array keys:

◆ processGrant()

BxCreditsModule::processGrant ( $iUserId,
$iProfileId,
$fAmount,
$sMessage = '' )

Hooks:

'bx_credits', 'granted' - hook after some amount of credits was granted to a profile

◆ processSend()

BxCreditsModule::processSend ( $iUserId,
$iProfileId,
$fAmount,
$sMessage = '' )

Hooks:

'bx_credits', 'sent' - hook after some amount of credits was sent from one profile to another

◆ processWithdrawCancel()

BxCreditsModule::processWithdrawCancel ( $iId)

Hooks:

'bx_credits', 'withdraw_canceled' - hook after a profile canceled his withdrawal request

◆ processWithdrawConfirm()

BxCreditsModule::processWithdrawConfirm ( $iUserId,
$iWithdrawalId )

Hooks:

'bx_credits', 'withdraw_sent' - hook after the amount of credits requested to withdraw was sent

◆ processWithdrawRequest()

BxCreditsModule::processWithdrawRequest ( $iUserId,
$iProfileId,
$fAmount,
$sMessage = '' )

Hooks:

'bx_credits', 'withdraw_requested' - hook after a profile requested to withdraw some amount of credits from his balance

◆ serviceCancelSubscriptionItem()

BxCreditsModule::serviceCancelSubscriptionItem ( $iClientId,
$iSellerId,
$iItemId,
$iItemCount,
$sOrder )

◆ serviceDeleteEntitiesByAuthor()

BxCreditsModule::serviceDeleteEntitiesByAuthor ( $iProfileId)

Delete all content by profile

Parameters
$iProfileIdprofile id
Returns
number of deleted items

◆ serviceGetBlockBundles()

BxCreditsModule::serviceGetBlockBundles ( )

◆ serviceGetBlockHistory()

BxCreditsModule::serviceGetBlockHistory ( $sType = 'common')

◆ serviceGetBlockOrders()

BxCreditsModule::serviceGetBlockOrders ( $sType = 'common')

◆ serviceGetBlockOrdersNote()

BxCreditsModule::serviceGetBlockOrdersNote ( )

◆ serviceGetBlockProfiles()

BxCreditsModule::serviceGetBlockProfiles ( $sType = 'common')

◆ serviceGetBlockWithdrawals()

BxCreditsModule::serviceGetBlockWithdrawals ( $sType = 'common')

◆ serviceGetCartItem()

BxCreditsModule::serviceGetCartItem ( $iItemId)

◆ serviceGetCartItems()

BxCreditsModule::serviceGetCartItems ( $iSellerId)

◆ serviceGetPaymentData()

BxCreditsModule::serviceGetPaymentData ( )

◆ serviceGetSafeServices()

BxCreditsModule::serviceGetSafeServices ( )

Reimplemented from BxBaseModGeneralModule.

◆ serviceRegisterCartItem()

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

◆ serviceRegisterSubscriptionItem()

BxCreditsModule::serviceRegisterSubscriptionItem ( $iClientId,
$iSellerId,
$iItemId,
$iItemCount,
$sOrder,
$sLicense )

◆ serviceReregisterCartItem()

BxCreditsModule::serviceReregisterCartItem ( $iClientId,
$iSellerId,
$iItemIdOld,
$iItemIdNew,
$sOrder )

◆ serviceReregisterSubscriptionItem()

BxCreditsModule::serviceReregisterSubscriptionItem ( $iClientId,
$iSellerId,
$iItemIdOld,
$iItemIdNew,
$sOrder )

◆ serviceUnregisterCartItem()

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

◆ serviceUnregisterSubscriptionItem()

BxCreditsModule::serviceUnregisterSubscriptionItem ( $iClientId,
$iSellerId,
$iItemId,
$iItemCount,
$sOrder,
$sLicense )

◆ updateProfileBalance()

BxCreditsModule::updateProfileBalance ( $iFirstPid,
$iSecondPid,
$fAmount,
$sType,
$sOrder = '',
$sInfo = '',
$sData = '' )

Hooks:

'bx_credits', 'update_balance' - hook after profile's credits balance was updated (credits were transferred from one profile to another)


The documentation for this class was generated from the following file:
  • modules/boonex/credits/classes/BxCreditsModule.php