BxDonationsModule Class Reference

Inheritance diagram for BxDonationsModule:

Public Member Functions
	__construct ($aModule)
	actionCheckName ()
	actionMakeOther ()
	serviceGetTypesBy ($aParams)
	serviceIncludeCssJs ()
	serviceGetBlockMake ()
	serviceGetBlockList ()
	serviceGetBlockListAll ()
	serviceGetPaymentData ()
	serviceGetCartItem ($mixedItemId)
	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)
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 ()
	actionGetAttachLinkForm ()
	actionSubmitAttachLinkForm ()
	actionAddAttachLink ()
	actionDeleteAttachLink ()
	actionGetCreatePostForm ()
	actionGetNotes ()
	actionNested ()
	actionEmbed ($iContentId, $sUnitTemplate='', $sAddCode='')
	subactionDelete ()
	actionAjaxGetProfiles ()
	serviceGetProfiles ($sParams)
	actionGetBrowsingFilters ()
	actionApplyBrowsingFilters ()
	serviceIsActive ($iContentId)
	serviceIsAllowedAddContentToContext ($iContextPid)
	serviceIsBadgesAvaliable ()
	serviceGetSafeServices ()
	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=[])
	serviceFavoritesListActions ()
	serviceFavoritesListInfo ($aParams=array())
	serviceBrowseContext ($iProfileId=0, $aParams=array())
	_serviceBrowseWithParam ($sParamName, $sParamGet, $sParamVal, $aParams=array())
	getFormsHelper ()
	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')
	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)
	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 ($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)
	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
	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)
	_getBlockList ($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()

BxDonationsModule::__construct

(

$aModule

)

constructor

Reimplemented from BxDolModule.

Member Function Documentation

_serviceRegisterItem()

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

protected

Hooks:

'bx_donations', 'donation_register' - hook after the donation payment was processed with payment processing module

• $unit_name - equals bx_donations
• $action - equals donation_register
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • donation_id - [int] donation id
  • profile_id - [int] donator profile id
  • order - [string] order number provided with payment processing module
  • type - [string] payment type ('single' or 'recurring')
  • amount - [float] donated amount
  • count - [int] number of items in order

    HOOKS

    'bx_donations', 'donation_register' - hook after the donation payment was processed with payment processing module

_serviceUnregisterItem()

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

protected

Hooks:

'bx_donations', 'donation_unregister' - hook after the donation payment was refunded with payment processing module

It's equivalent to 'bx_donations', 'donation_register' - hook after the donation payment was processed with payment processing module except amount parameter in $extra_params is missing

HOOKS

'bx_donations', 'donation_unregister' - hook after the donation payment was refunded with payment processing module

actionCheckName()

BxDonationsModule::actionCheckName

(

)

ACTION METHODS

serviceGetTypesBy()

BxDonationsModule::serviceGetTypesBy

(

$aParams

)

SERVICE METHODS

---

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

• modules/boonex/donations/classes/BxDonationsModule.php