BxAdsModule Class Reference

Inheritance diagram for BxAdsModule:

Public Member Functions
	__construct (&$aModule)
	decodeDataApi ($aData, $bExtended=false)
	actionGetSource ()
	serviceGetSourceData ()
	actionLoadEntryFromSource ()
	actionGetCategoryForm ()
	actionCheckName ()
	actionInterested ()
	actionShow ()
	actionHide ()
	actionMakeOffer ()
	actionViewOffer ()
	actionAcceptOffer ()
	actionDeclineOffer ()
	actionCancelOffer ()
	actionPayOffer ()
	actionShipped ()
	actionReceived ()
	actionRegisterImpression ($iId)
	actionRegisterClick ($iId)
	serviceGetSafeServices ()
	serviceRegisterImpression ($iId)
	serviceRegisterClick ($iId)
	serviceCheckName ($sTitle, $iId=0)
	serviceUpdateCategoriesStats ($mixedContentInfo=false)
	serviceUpdateCategoriesStatsByCategory ($iCategoryId=0)
	serviceGetCategoryOptions ($iParentId, $bPleaseSelect=false)
	serviceGetSearchableFields ($aInputsAdd=array())
	serviceGetSearchableFieldsExtended ($aInputsAdd=array())
	serviceMarkAs ($sAction, $iContentId, $iProfileSrc=0, $iProfileDst=0)
	serviceEntityCreate ($sParams=false)
	serviceEntityEditBudget ($iContentId=0, $sDisplay=false)
	serviceEntityReviews ($iContentId=0)
	serviceEntityReviewsRating ($iContentId=0)
	serviceEntityPromotionGrowth ($iContentId=0)
	serviceEntityPromotionSummary ($iContentId=0)
	serviceEntityPromotionRoi ($iContentId=0)
	serviceCategoriesList ($aParams=array())
	serviceBrowseCategory ($sUnitView=false, $bEmptyMessage=true, $bAjaxPaginate=true, $aParams=[])
	serviceGetTimelinePost ($aEvent, $aBrowseParams=[])
	serviceGetNotificationsData ()
	serviceGetNotificationsInsertData ($oAlert, $aHandler, $aDataItems)
	serviceGetNotificationsInterest ($aEvent)
	serviceGetNotificationsLicenseRegister ($aEvent)
	serviceGetNotificationsShipped ($aEvent)
	serviceGetNotificationsReceived ($aEvent)
	serviceGetNotificationsOfferAdded ($aEvent)
	serviceGetNotificationsOfferAccepted ($aEvent)
	serviceGetNotificationsOfferDeclined ($aEvent)
	serviceGetNotificationsOfferCanceled ($aEvent)
	serviceBlockLicenses ()
	serviceBlockLicensesAdministration ()
	serviceBlockLicensesNote ()
	serviceGetPaymentData ()
	serviceGetCartItem ($mixedItemId, $iClientId=0)
	serviceGetCartItems ($iSellerId)
	serviceAuthorizeCartItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder)
	serviceRegisterCartItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder, $sLicense)
	serviceAuthorizeSubscriptionItem ($iClientId, $iSellerId, $iItemId, $iItemCount, $sOrder)
	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)
	serviceGetOffersCount ($sStatus='')
	serviceGetLiveUpdates ($sStatus, $aMenuItemParent, $aMenuItemChild, $iCount=0)
	serviceOffers ()
	serviceEntityOffers ($iContentId=0)
	serviceEntityOfferAccepted ($iContentId=0)
	serviceIsSourcesAvaliable ()
	serviceGetSources ($iAuthorId)
	serviceGetSource ($iAuthorId, $sAuthorSource='')
	serviceLoadEntriesFromSourceByTerm ($sSourceType, $sTerm)
	serviceLoadEntryFromSource ($sSourceType, $sSource)
	serviceBlockSourcesDetails ($iProfileId=0)
	isEntryActive ($aContentInfo)
	isAuction ($aContentInfo)
	isAllowedMakeOffer ($mixedContent, $isPerformAction=false)
	checkAllowedMakeOffer ($mixedContent, $isPerformAction=false)
	isAllowedViewOffers ($mixedContent, $isPerformAction=false)
	checkAllowedViewOffers ($mixedContent, $isPerformAction=false)
	isAllowedMarkShipped ($mixedContent, $isPerformAction=false)
	checkAllowedMarkShipped ($mixedContent, $isPerformAction=false)
	checkAllowedMarkShippedForProfile ($mixedContent, $isPerformAction=false, $iProfileId=false)
	isAllowedMarkReceived ($mixedContent, $isPerformAction=false)
	checkAllowedMarkReceived ($mixedContent, $isPerformAction=false)
	checkAllowedMarkReceivedForProfile ($mixedContent, $isPerformAction=false, $iProfileId=false)
	onPublished ($iContentId)
	onOfferAdded ($iOfferId, &$aResult)
	onOfferAccepted ($iOfferId)
	onOfferDeclined ($iOfferId)
	onOfferCanceled ($iOfferId)
	onShipped ($mixedContent, $iProfileSrc=0, $iProfileDst=0)
	onReceived ($mixedContent, $iProfileSrc=0, $iProfileDst=0)
	getObjectSource ($sSource, $iProfileId=0)
	offerAccept ($iId)
	offerDecline ($iId)
	offerCancel ($iId)
	offerPay ($iId)
	processMetasAdd ($iContentId)
	processMetasEdit ($iContentId, $oForm)
	getCategoryDisplay ($sDisplayType, $iCategory=0)
	isSingle ($mixedContent)
	getAvailableQuantity ($mixedContent)
Public Member Functions inherited from BxBaseModTextModule
	actionFileEmbedVideo ($iFileId)
	actionFileEmbedSound ($iFileId)
	serviceManageTools ($sType='common')
	serviceCategoriesMultiListContext ($iProfileId=0, $bDisplayEmptyCats=true)
	serviceMediaExif ($iMediaId=0)
	serviceGetThumb ($iContentId, $sTranscoder='')
	serviceGetMenuAddonManageTools ()
	serviceGetMenuAddonManageToolsProfileStats ($iProfileId=0)
	serviceBrowsePublic ($sUnitView=false, $bEmptyMessage=true, $bAjaxPaginate=true)
	serviceBrowsePopular ($sUnitView=false, $bEmptyMessage=true, $bAjaxPaginate=true)
	serviceBrowseTop ($sUnitView=false, $bEmptyMessage=true, $bAjaxPaginate=true)
	serviceBrowseUpdated ($sUnitView=false, $bEmptyMessage=true, $bAjaxPaginate=true)
	serviceBrowseAuthor ($iProfileId=0, $aParams=array())
	serviceEntityAuthor ($iContentId=0)
	serviceEntityBreadcrumb ($iContentId=0)
	serviceDeleteEntitiesByAuthor ($iProfileId)
	checkAllowedSetThumb ($iContentId=0)
	isAllowedApprove ($mixedContent, $isPerformAction=false)
	checkAllowedApprove ($mixedContent, $isPerformAction=false)
	deleteAttachLinks ($iId)
	deleteAttachLinksUnused ($iProfileId)
	onApprove ($mixedContent)
	alertAfterAdd ($aContentInfo)
	alertAfterEdit ($aContentInfo)
	getEntryImageData ($aContentInfo, $sField='FIELD_THUMB', $aTranscoders=array())
	decodeDataAPI ($aData, $aParams=[])
	serviceIsAllowedPostInContext ()
Public Member Functions inherited from BxBaseModGeneralModule
	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())
	serviceGetSearchResultExtended ($aParams, $iStart=0, $iPerPage=0, $bFilterMode=false)
	serviceUpdateImage ($sFiledName, $iContentId, $sValue)
	serviceUpdateImagePosition ($iContentId, $sFiledName, $sH, $sV)
	serviceBrowse ($aParams=array())
	serviceBrowseWithCondition ($aParams=array())
	serviceBrowseFeatured ($sUnitView=false, $bEmptyMessage=false, $bAjaxPaginate=true)
	serviceBrowseFavorite ($iProfileId=0, $aParams=array())
	serviceBrowseFavoriteLists ($iProfileId=0, $aParams=array())
	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())
	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)
	serviceGetNotificationsPost ($aEvent)
	serviceGetNotificationsPostPendingApproval ($aEvent)
	serviceGetNotificationsPostApproved ($aEvent)
	serviceGetNotificationsPostPublishFailed ($aEvent)
	serviceGetNotificationsPostPublishSucceeded ($aEvent)
	serviceGetNotificationsComment ($aEvent)
	serviceGetNotificationsReply ($aEvent)
	serviceGetNotificationsVote ($aEvent)
	serviceGetNotificationsReaction ($aEvent)
	serviceGetNotificationsScoreUp ($aEvent)
	serviceGetNotificationsScoreDown ($aEvent)
	serviceGetReputationData ()
	serviceGetTimelineData ()
	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)
	checkAllowedBrowse ()
	checkAllowedView ($aDataEntry, $isPerformAction=false)
	checkAllowedViewForProfile ($aDataEntry, $iProfileId, $isPerformAction=false)
	checkAllowedAdd ($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)
	onFailed ($iContentId)
	onUpdateImage ($iContentId, $sFiledName, $sFiledValue, $iProfileId=0)
	alertAfterApprove ($aContentInfo)
	addAttachLink ($aValues, $sDisplay=false)
	getFormAttachLink ($iContentId=0)
	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=[])
Public Member Functions inherited from BxDolModule
	__construct ($aModule)
	isEnabled ()
	getName ()
	isLogged ()
	getUserPassword ()
	serviceIsSafeService ($s)
	serviceIsPublicService ($s)
	serviceGetPublicServices ()
Public Member Functions inherited from iBxDolContentInfoService
	serviceGetAuthor ($iContentId)
	serviceGetDateAdded ($iContentId)
	serviceGetDateChanged ($iContentId)
	serviceGetLink ($iContentId)
	serviceGetTitle ($iContentId)
	serviceGetText ($iContentId)
	serviceGetThumb ($iContentId)
	serviceGetInfo ($iContentId, $bSearchableFieldsOnly=true)
	serviceGetSearchResultUnit ($iContentId, $sUnitTemplate='')
	serviceGetAll ($aParams=array())
	serviceGetSearchResultExtended ($aParams, $iStart=0, $iPerPage=0, $bFilterMode=false)

Protected Member Functions
	_serviceGetNotificationsByEntryAndAction ($aEvent, $sAction)
	_serviceGetNotificationsByOfferAndAction ($aEvent, $sAction)
	_registerCartItemProduct ($iClientId, $iSellerId, $aCommodity, $iItemCount, $sOrder, $sLicense)
	_registerCartItemPromotion ($iClientId, $iSellerId, $aCommodity, $iItemCount, $sOrder, $sLicense)
	_unregisterCartItemProduct ($iClientId, $iSellerId, $aCommodity, $iItemCount, $sOrder, $sLicense)
	_unregisterCartItemPromotion ($iClientId, $iSellerId, $aCommodity, $iItemCount, $sOrder, $sLicense)
	_actionMarkAs ($sAction)
	_actionChangeStatus ($sStatus)
	_serviceEntityForm ($sFormMethod, $iContentId=0, $sDisplay=false, $sCheckFunction=false, $bErrorMsg=true)
	_getCategoryOptions ($iParentId, &$aValues)
	_getSearchableFields ($mixedDisplayType='')
	_getContentForTimelinePost ($aEvent, $aContentInfo, $aBrowseParams=array())
	_getBlockLicenses ($sType='')
	_alertParamsOffer ($aContentInfo, $aOfferInfo)
Protected Member Functions inherited from BxBaseModTextModule
	_alertParams ($aContentInfo)
	_alertParamsAdd ($aContentInfo)
	_alertParamsEdit ($aContentInfo)
	_getAlertParamTimelineGroup ($aContentInfo)
	_getImagesForTimelinePost ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())
	_getImagesForTimelinePostAttach ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())
	_getImagesForTimelinePostAttachInner ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())
	_getVideosForTimelinePostAttach ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())
	_getFilesForTimelinePostAttach ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())
	_buildRssParams ($sMode, $aArgs)
Protected Member Functions inherited from BxBaseModGeneralModule
	_prepareBrowsingFiltersParamsGet ($mParams=false)
	_serviceGetNotificationsScore ($sType, $aEvent)
	_serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId)
	_serviceBrowseQuick ($aProfiles, $iStart=0, $iLimit=4, $aAdditionalParams=array())
	_addLink (&$oForm)
	_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)
	_getVideosForTimelinePost ($aEvent, $aContentInfo, $sUrl, $aBrowseParams=array())
	_getFilesForTimelinePost ($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
	$_aOfferStatuses
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

Ads module

Constructor & Destructor Documentation

__construct()

BxAdsModule::__construct

(

&

$aModule

)

Reimplemented from BxBaseModTextModule.

Member Function Documentation

_actionMarkAs()

BxAdsModule::_actionMarkAs ( $sAction )

protected

Internal methods.

_getContentForTimelinePost()

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

protected

Reimplemented from BxBaseModTextModule.

_registerCartItemProduct()

BxAdsModule::_registerCartItemProduct ( $iClientId, $iSellerId, $aCommodity, $iItemCount, $sOrder, $sLicense )

protected

Hooks:

'bx_ads', 'license_register' - hook after the payment for an ad was processed with payment processing module

• $unit_name - equals bx_ads
• $action - equals license_register
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • id - [int] commodity id
  • type - [string] commodity type, 'product' or 'promotion'
  • product_id - [int] ad (entry) id the commodity is associated with
  • profile_id - [int] client (buyer) profile id
  • order - [string] order number provided with payment processing module
  • license - [string] license number generated for the order
  • count - [int] number of items in order

    HOOKS

    'bx_ads', 'license_register' - hook after the payment for an ad was processed with payment processing module

Hooks:

'bx_ads', 'sold' - hook after the payment was processed with payment processing module and there is no the ad (entry) for selling anymore

• $unit_name - equals bx_ads
• $action - equals sold
• $object_id - ad (entry) id
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • status - [string] content status
  • status_admin - [string] content admin status
  • privacy_view - [int] or [string] privacy for view content action,

    See also

    BxDolPrivacy

  • cf - [int] content's audience filter value

    HOOKS

    'bx_ads', 'sold' - hook after the payment was processed with payment processing module and there is no the ad (entry) for selling anymore

Hooks:

'bx_ads', 'license_register_notif' - hook before sending a notification about new license. Allows to override a notification message or cancel the notification

• $unit_name - equals bx_ads
• $action - equals license_register_notif
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • entry_id - [int] ad (entry) id
  • order - [string] order number
  • recipient_id - [int] by ref, client (buyer) profile id, can be overridden in hook processing
  • email_template - [string] by ref, email template name, can be overridden in hook processing
  • email_params - [array] by ref, email params array as key&value pairs, which will be parsed in email subject/body, can be overridden in hook processing
  • cancel - [boolean] by ref, if email sending should be canceled or not, can be overridden in hook processing

    HOOKS

    'bx_ads', 'license_register_notif' - hook before sending a notification about new license. Allows to override a notification message or cancel the notification

_registerCartItemPromotion()

BxAdsModule::_registerCartItemPromotion ( $iClientId, $iSellerId, $aCommodity, $iItemCount, $sOrder, $sLicense )

protected

Hooks:

'bx_ads', 'promotion_register' - hook after the payment for promotion was processed with payment processing module

• $unit_name - equals bx_ads
• $action - equals promotion_register
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • id - [int] commodity id
  • type - [string] commodity type, 'product' or 'promotion'
  • product_id - [int] ad (entry) id the commodity is associated with
  • profile_id - [int] client (buyer) profile id
  • amount - [float] amount paid for the promotion
  • order - [string] order number provided with payment processing module
  • license - [string] license number generated for the order

    HOOKS

    'bx_ads', 'promotion_register' - hook after the payment for promotion was processed with payment processing module

_serviceEntityForm()

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

protected

Reimplemented from BxBaseModGeneralModule.

_unregisterCartItemProduct()

BxAdsModule::_unregisterCartItemProduct ( $iClientId, $iSellerId, $aCommodity, $iItemCount, $sOrder, $sLicense )

protected

Hooks:

'bx_ads', 'license_unregister' - hook after the payment for ad was refunded with payment processing module

It's equivalent to 'bx_ads', 'license_register' - hook after the payment for an ad was processed with payment processing module

HOOKS

'bx_ads', 'license_unregister' - hook after the payment for ad was refunded with payment processing module

_unregisterCartItemPromotion()

BxAdsModule::_unregisterCartItemPromotion ( $iClientId, $iSellerId, $aCommodity, $iItemCount, $sOrder, $sLicense )

protected

Hooks:

'bx_ads', 'promotion_unregister' - hook after the payment for promotion was refunded with payment processing module

It's equivalent to 'bx_ads', 'promotion_register' - hook after the payment for promotion was processed with payment processing module

HOOKS

'bx_ads', 'promotion_unregister' - hook after the payment for promotion was refunded with payment processing module

actionInterested()

BxAdsModule::actionInterested

(

)

Hooks:

'bx_ads', 'doInterest' - hook after 'interested' action was performed

• $unit_name - equals bx_ads
• $action - equals doInterest
• $object_id - content id
• $sender_id - profile id who performed the action
• $extra_params - array of additional params with the following array keys:
  • subobject_id - [int] id of a database table record, created during the action
  • subobject_author_id - [int] profile id who performed the action
  • object_author_id - [int] content author profile id

    HOOKS

    'bx_ads', 'doInterest' - hook after 'interested' action was performed

isEntryActive()

BxAdsModule::isEntryActive

(

$aContentInfo

)

Hooks:

'bx_ads', 'is_entry_active' - hook to override whether an ad (entry) active or not

It's equivalent to '{module_name}', 'is_entry_active' - hook to override whether an entry (content) active or not

HOOKS

'bx_ads', 'is_entry_active' - hook to override whether an ad (entry) active or not

Reimplemented from BxBaseModGeneralModule.

onOfferAccepted()

BxAdsModule::onOfferAccepted

(

$iOfferId

)

Hooks:

'bx_ads', 'offer_accepted' - hook after an offer was accepted.

It's equivalent to 'bx_ads', 'offer_added' - hook after an offer was added. Allows to override action results. except content author profile id is passed to $sender_id and override_result parameter in $extra_params is missing

HOOKS

'bx_ads', 'offer_accepted' - hook after an offer was accepted.

onOfferAdded()

BxAdsModule::onOfferAdded	(		$iOfferId,
		&	$aResult )

Hooks:

'bx_ads', 'offer_added' - hook after an offer was added. Allows to override action results.

• $unit_name - equals bx_ads
• $action - equals offer_added
• $object_id - offer id
• $sender_id - offer author profile id
• $extra_params - array of additional params with the following array keys:
  • object_id - [int] content id
  • object_author_id - [int] content author profile id
  • offer_id - [int] offer id
  • offer_author_id - [int] offer author profile id
  • privacy_view - [int] privacy for view action, equals to BX_DOL_PG_ALL,

    See also

    BxDolPrivacy

  • override_result - [array] by ref, results array as key&value pairs, can be overridden in hook processing

    HOOKS

    'bx_ads', 'offer_added' - hook after an offer was added. Allows to override action results.

onOfferCanceled()

BxAdsModule::onOfferCanceled

(

$iOfferId

)

Hooks:

'bx_ads', 'offer_canceled' - hook after an offer was declined.

It's equivalent to 'bx_ads', 'offer_added' - hook after an offer was added. Allows to override action results. except override_result parameter in $extra_params is missing

HOOKS

'bx_ads', 'offer_canceled' - hook after an offer was declined.

onOfferDeclined()

BxAdsModule::onOfferDeclined

(

$iOfferId

)

Hooks:

'bx_ads', 'offer_declined' - hook after an offer was declined.

It's equivalent to 'bx_ads', 'offer_accepted' - hook after an offer was accepted.

HOOKS

'bx_ads', 'offer_declined' - hook after an offer was declined.

onPublished()

BxAdsModule::onPublished

(

$iContentId

)

Reimplemented from BxBaseModGeneralModule.

onReceived()

BxAdsModule::onReceived	(		$mixedContent,
			$iProfileSrc = 0,
			$iProfileDst = 0 )

Hooks:

'bx_ads', 'received' - hook after the ad (entry) was marked as received

It's equivalent to 'bx_ads', 'shipped' - hook after the ad (entry) was marked as shipped

HOOKS

'bx_ads', 'received' - hook after the ad (entry) was marked as received

onShipped()

BxAdsModule::onShipped	(		$mixedContent,
			$iProfileSrc = 0,
			$iProfileDst = 0 )

Common methods.

Hooks:

'bx_ads', 'shipped' - hook after the ad (entry) was marked as shipped

• $unit_name - equals bx_ads
• $action - equals shipped
• $object_id - ad (entry) id
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • status - [string] content status
  • status_admin - [string] content admin status
  • privacy_view - [int] or [string] privacy for view content action,

    See also

    BxDolPrivacy

  • cf - [int] content's audience filter value
  • profile_src - [int] sender profile id
  • profile_dst - [int] recipient profile id
  • offer_id - [int] offer id if the ad was sold by offer

    HOOKS

    'bx_ads', 'shipped' - hook after the ad (entry) was marked as shipped

processMetasAdd()

BxAdsModule::processMetasAdd

(

$iContentId

)

Reimplemented from BxBaseModGeneralModule.

processMetasEdit()

BxAdsModule::processMetasEdit	(		$iContentId,
			$oForm )

Reimplemented from BxBaseModGeneralModule.

serviceAuthorizeCartItem()

BxAdsModule::serviceAuthorizeCartItem	(		$iClientId,
			$iSellerId,
			$iItemId,
			$iItemCount,
			$sOrder )

authorize_cart_item

Hooks:

'bx_ads', 'order_authorize' - hook after the order was authorized with payment processing module

• $unit_name - equals bx_ads
• $action - equals order_authorize
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • id - [int] commodity id
  • type - [string] commodity type, 'product' or 'promotion'
  • product_id - [int] ad (entry) id the commodity is associated with
  • order - [string] order number provided with payment processing module
  • count - [int] number of items in order

    HOOKS

    'bx_ads', 'order_authorize' - hook after the order was authorized with payment processing module

serviceAuthorizeSubscriptionItem()

BxAdsModule::serviceAuthorizeSubscriptionItem	(		$iClientId,
			$iSellerId,
			$iItemId,
			$iItemCount,
			$sOrder )

authorize_subscription_item

serviceBlockLicenses()

BxAdsModule::serviceBlockLicenses

(

)

block_licenses

serviceBlockLicensesAdministration()

BxAdsModule::serviceBlockLicensesAdministration

(

)

block_licenses

serviceBlockLicensesNote()

BxAdsModule::serviceBlockLicensesNote

(

)

block_licenses_note

serviceBrowseCategory()

BxAdsModule::serviceBrowseCategory	(		$sUnitView = false,
			$bEmptyMessage = true,
			$bAjaxPaginate = true,
			$aParams = [] )

browse_category

Reimplemented from BxBaseModGeneralModule.

serviceCancelSubscriptionItem()

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

cancel_subscription_item

serviceCategoriesList()

BxAdsModule::serviceCategoriesList

(

$aParams = array()

)

categories_list

serviceEntityCreate()

BxAdsModule::serviceEntityCreate

(

$sParams = false

)

Create entry form

Returns

HTML string

Reimplemented from BxBaseModGeneralModule.

serviceEntityReviews()

BxAdsModule::serviceEntityReviews

(

$iContentId = 0

)

entity_reviews

serviceEntityReviewsRating()

BxAdsModule::serviceEntityReviewsRating

(

$iContentId = 0

)

entity_reviews_rating

serviceGetCartItem()

BxAdsModule::serviceGetCartItem	(		$mixedItemId,
			$iClientId = 0 )

get_cart_item

serviceGetCartItems()

BxAdsModule::serviceGetCartItems

(

$iSellerId

)

get_cart_items

serviceGetNotificationsData()

BxAdsModule::serviceGetNotificationsData

(

)

Data for Notifications module

Reimplemented from BxBaseModGeneralModule.

serviceGetPaymentData()

BxAdsModule::serviceGetPaymentData

(

)

get_payment_data

serviceGetSafeServices()

BxAdsModule::serviceGetSafeServices

(

)

Reimplemented from BxBaseModTextModule.

serviceGetSearchableFields()

BxAdsModule::serviceGetSearchableFields

(

$aInputsAdd = array()

)

Reimplemented from BxBaseModGeneralModule.

serviceGetSearchableFieldsExtended()

BxAdsModule::serviceGetSearchableFieldsExtended

(

$aInputsAdd = array()

)

Reimplemented from BxBaseModGeneralModule.

serviceGetTimelinePost()

BxAdsModule::serviceGetTimelinePost	(		$aEvent,
			$aBrowseParams = [] )

Entry post for Timeline module

Don't show anonymous posts on the post's owner timeline and don't cache them when they're viewed by their authors.

Reimplemented from BxBaseModGeneralModule.

serviceMarkAs()

BxAdsModule::serviceMarkAs	(		$sAction,
			$iContentId,
			$iProfileSrc = 0,
			$iProfileDst = 0 )

Mark an ad as shipped/received by seller/bauer accordingly.

Parameters

type	$sAction	- shipped/received action.
type	$iContentId	- an ad the action will be performed with.
integer	$iProfileSrc	- profile, who performed the action.
integer	$iProfileDst	- profile, the action is pointed on.

Returns

boolean - true or a string value with error message.

serviceRegisterCartItem()

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

register_cart_item

serviceRegisterSubscriptionItem()

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

register_subscription_item

serviceReregisterCartItem()

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

reregister_cart_item

serviceReregisterSubscriptionItem()

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

reregister_subscription_item

serviceUnregisterCartItem()

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

unregister_cart_item

serviceUnregisterSubscriptionItem()

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

unregister_subscription_item

---

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

• modules/boonex/ads/classes/BxAdsModule.php