BxBaseModGeneralModule Class Reference

Inheritance diagram for BxBaseModGeneralModule:

Public Member Functions
	__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 ()
	serviceGetSafeServices ()
	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')
	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())
	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
	__construct ($aModule)
	isEnabled ()
	getName ()
	isLogged ()
	getUserPassword ()
	serviceIsSafeService ($s)
	serviceIsPublicService ($s)
	serviceGetPublicServices ()

Protected Member Functions
	_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
	$_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

Base module class.

Constructor & Destructor Documentation

__construct()

BxBaseModGeneralModule::__construct

(

&

$aModule

)

Reimplemented in BxFaceBookConnectModule.

Member Function Documentation

_alertParams()

BxBaseModGeneralModule::_alertParams ( $aContentInfo )

protected

Get array of params to be passed in Add/Edit Alert.

Reimplemented in BxBaseModGroupsModule, BxBaseModProfileModule, and BxBaseModTextModule.

_getApproveForm()

BxBaseModGeneralModule::_getApproveForm ( $iContentId, $aContentInfo )

protected

Hooks:

'{module_name}', 'get_approve_form' - hook to override approve content form

• $unit_name - module name
• $action - equals get_approve_form
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • content_id - [int] content id
  • content_info - [array] content info array as key&value pairs
  • override_result - [object] by ref, an instance of approve content form,

    See also

    BxDolForm, can be overridden in hook processing

    HOOKS

    '{module_name}', 'get_approve_form' - hook to override approve content form

_getContent()

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

protected

Reimplemented in BxPollsModule.

_isModerator()

BxBaseModGeneralModule::_isModerator

(

$isPerformAction = false

)

Reimplemented in BxCnvModule.

_processModerationNotifications()

BxBaseModGeneralModule::_processModerationNotifications ( $aContentInfo )

protected

Hooks:

'{module_name}', 'pending_approval' - hook to notify admins/moderators about new pending approval content

• $unit_name - module name
• $action - equals pending_approval
• $object_id - content id
• $sender_id - content author profile id
• $extra_params - array of additional params with the following array keys:
  • object_author_id - [int] admin/moderator profile id

    HOOKS

    '{module_name}', 'pending_approval' - hook to notify admins/moderators about new pending approval content

_sendApproveMessage()

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

protected

Hooks:

'{module_name}', 'get_approve_form' - hook to override approve content message

• $unit_name - module name
• $action - equals get_approve_message
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • content_id - [int] content id
  • content_info - [array] content info array as key&value pairs
  • form - [object] an instance of approve content form
  • email_template - [string] by ref, email template name,

    See also

    BxDolEmailTemplates, can be overridden in hook processing

  • email_params - [array] by ref, email template params, can be overridden in hook processing

    HOOKS

    '{module_name}', 'get_approve_form' - hook to override approve content message

_serviceBrowseQuick()

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

protected

Shows a list of profiles.

_serviceCheckAllowedViewForProfile()

BxBaseModGeneralModule::_serviceCheckAllowedViewForProfile ( $aDataEntry, $isPerformAction, $iProfileId )

protected

Reimplemented in BxRemindersModule.

actionAjaxGetProfiles()

BxBaseModGeneralModule::actionAjaxGetProfiles

(

)

Get possible recipients for start conversation form

alertAfterAdd()

BxBaseModGeneralModule::alertAfterAdd

(

$aContentInfo

)

Reimplemented in BxBaseModGroupsModule, BxBaseModProfileModule, and BxBaseModTextModule.

alertAfterApprove()

BxBaseModGeneralModule::alertAfterApprove

(

$aContentInfo

)

Hooks:

'{module_name}', 'approved' - hook when module content has been approved

• $unit_name - module name
• $action - equals approved
• $object_id - content id
• $sender_id - not used, always false
• $extra_params - array of additional params with the following array keys:
  • source - [string] uniq string for particular content in the following format {module}_{content}
  • object_author_id - [int] content author profile id

    HOOKS

    '{module_name}', 'approved' - hook when module content has been approved

alertAfterEdit()

BxBaseModGeneralModule::alertAfterEdit

(

$aContentInfo

)

Reimplemented in BxBaseModProfileModule, and BxBaseModTextModule.

checkAllowedAdd()

BxBaseModGeneralModule::checkAllowedAdd

(

$isPerformAction = false

)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

Reimplemented in BxBaseModProfileModule, and BxMassMailerModule.

checkAllowedApprove()

BxBaseModGeneralModule::checkAllowedApprove	(		$aDataEntry,
			$isPerformAction = false )

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

Reimplemented in BxBaseModTextModule.

checkAllowedBrowse()

BxBaseModGeneralModule::checkAllowedBrowse

(

)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking.

Hooks:

'system', 'check_allowed_browse' - hook to override the result of checking whether 'browse' action is allowed or not to currently logged in profile

It's equivalent to 'system', 'check_allowed_view' - hook to override the result of checking whether 'view' action is allowed or not to specified profile except content_info parameter in $extra_params is missing

HOOKS

'system', 'check_allowed_browse' - hook to override the result of checking whether 'browse' action is allowed or not to currently logged in profile

checkAllowedCommentsPost()

BxBaseModGeneralModule::checkAllowedCommentsPost	(		$aContentInfo,
			$isPerformAction = false )

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking.

Reimplemented in BxTimelineModule.

checkAllowedCommentsView()

BxBaseModGeneralModule::checkAllowedCommentsView	(		$aContentInfo,
			$isPerformAction = false )

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking.

Reimplemented in BxTimelineModule.

checkAllowedDelete()

BxBaseModGeneralModule::checkAllowedDelete	(	&	$aDataEntry,
			$isPerformAction = false )

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

Reimplemented in BxAccntModule, BxBaseModGroupsModule, BxBaseModProfileModule, BxCnvModule, BxMarketModule, BxMassMailerModule, and BxTimelineModule.

checkAllowedDeleteAnyEntry()

BxBaseModGeneralModule::checkAllowedDeleteAnyEntry

(

$isPerformAction = false

)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

checkAllowedDeleteAnyEntryForProfile()

BxBaseModGeneralModule::checkAllowedDeleteAnyEntryForProfile	(		$isPerformAction = false,
			$iProfileId = false )

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

Reimplemented in BxCnvModule, and BxTimelineModule.

checkAllowedEdit()

BxBaseModGeneralModule::checkAllowedEdit	(		$aDataEntry,
			$isPerformAction = false )

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

Reimplemented in BxBaseModGroupsModule, BxBaseModProfileModule, BxCnvModule, and BxMassMailerModule.

checkAllowedEditAnyEntry()

BxBaseModGeneralModule::checkAllowedEditAnyEntry

(

$isPerformAction = false

)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

Reimplemented in BxCnvModule, and BxRemindersModule.

checkAllowedEditAnyEntryForProfile()

BxBaseModGeneralModule::checkAllowedEditAnyEntryForProfile	(		$isPerformAction = false,
			$iProfileId = false )

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

Reimplemented in BxCnvModule, BxMassMailerModule, BxRemindersModule, and BxTimelineModule.

checkAllowedSetMembership()

BxBaseModGeneralModule::checkAllowedSetMembership	(	&	$aDataEntry,
			$isPerformAction = false )

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

checkAllowedSetThumb()

BxBaseModGeneralModule::checkAllowedSetThumb

(

$iContentId = 0

)

Reimplemented in BxAlbumsModule, BxBaseModTextModule, BxCnvModule, BxFilesModule, BxPhotosModule, BxShopifyModule, and BxStrmModule.

checkAllowedView()

BxBaseModGeneralModule::checkAllowedView	(		$aDataEntry,
			$isPerformAction = false )

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

Reimplemented in BxBaseModGroupsModule, BxBaseModProfileModule, BxCnvModule, and BxTimelineModule.

checkAllowedViewForProfile()

BxBaseModGeneralModule::checkAllowedViewForProfile	(		$aDataEntry,
			$iProfileId,
			$isPerformAction = false )

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

getDataAPI()

BxBaseModGeneralModule::getDataAPI	(		$aData,
			$aParams = [] )

Hooks:

'system', 'decode_data_api' - hook to override content data prepared for sending in API response

• $unit_name - equals system
• $action - equals decode_data_api
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • module - [string] module name
  • data - [array] content info array as key&value pairs
  • params - [array] params array as key&value pairs
  • data_api - [array] by ref, content data prepared for sending in API response, can be overridden in hook processing

    HOOKS

    'system', 'decode_data_api' - hook to override content data prepared for sending in API response

Hooks:

'{module_name}', 'decode_data_api' - hook to override content data prepared for sending in API response

It's equivalent to 'system', 'decode_data_api' - hook to override content data prepared for sending in API response

HOOKS

'{module_name}', 'decode_data_api' - hook to override content data prepared for sending in API response

getUserId()

BxBaseModGeneralModule::getUserId

(

)

Get currently logged in user ID.

Returns

integer user ID.

Reimplemented from BxDolModule.

isEntryActive()

BxBaseModGeneralModule::isEntryActive

(

$aContentInfo

)

Hooks:

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

• $unit_name - module name
• $action - equals is_entry_active
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • viewer_id - [int] viewer profile id
  • is_moderator - [boolean] is viewer has moderator status or not
  • content_info - [array] content info array as key&value pairs
  • override_result - [boolean] by ref, boolean value which determines whether entry (content) active or not, can be overridden in hook processing

    HOOKS

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

Reimplemented in BxAdsModule.

isEntryAuthor()

BxBaseModGeneralModule::isEntryAuthor	(		$aContentInfo,
			$iProfileId = 0 )

Hooks:

'{module_name}', 'is_entry_author' - hook to check if a viewer is an author of viewed entry (content) or not

• $unit_name - module name
• $action - equals is_entry_author
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • viewer_id - [int] viewer profile id
  • content_info - [array] content info array as key&value pairs
  • override_result - [boolean] by ref, boolean value which determines whether the viewer is an author of viewed entry (content) or not, can be overridden in hook processing

    HOOKS

    '{module_name}', 'is_entry_author' - hook to check if a viewer is an author of viewed entry (content) or not

onFailed()

BxBaseModGeneralModule::onFailed

(

$iContentId

)

Hooks:

'{module_name}', 'failed' - hook after content creation when publishing was failed

• $unit_name - module name
• $action - equals failed
• $object_id - content id
• $sender_id - content author profile id
• $extra_params - array of additional params with the following array keys:
  • object_author_id - [int] content author profile id

    HOOKS

    '{module_name}', 'failed' - hook after content creation when publishing was failed

Reimplemented in BxTimelineModule.

onUpdateImage()

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

Reimplemented in BxBaseModGroupsModule, and BxBaseModProfileModule.

serviceBrowse()

BxBaseModGeneralModule::serviceBrowse

(

$aParams = array()

)

browse

serviceBrowseCategory()

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

browse_by_category

Reimplemented in BxAdsModule, and BxForumModule.

serviceBrowseContext()

BxBaseModGeneralModule::serviceBrowseContext	(		$iProfileId = 0,
			$aParams = array() )

Display entries posted into particular context

Returns

HTML string

Reimplemented in BxFilesModule, and BxTasksModule.

serviceBrowseFavorite()

BxBaseModGeneralModule::serviceBrowseFavorite	(		$iProfileId = 0,
			$aParams = array() )

browse_favorite

serviceBrowseFavoriteLists()

BxBaseModGeneralModule::serviceBrowseFavoriteLists	(		$iProfileId = 0,
			$aParams = array() )

browse_favorite_lists

serviceBrowseFeatured()

BxBaseModGeneralModule::serviceBrowseFeatured	(		$sUnitView = false,
			$bEmptyMessage = false,
			$bAjaxPaginate = true )

browse_featured

serviceCategoriesMultiList()

BxBaseModGeneralModule::serviceCategoriesMultiList

(

$bDisplayEmptyCats = true

)

categories_multi_list

serviceCheckAllowed()

BxBaseModGeneralModule::serviceCheckAllowed	(		$sAction,
			$isPerformAction = false )

Check particular action permission without content

Parameters

$sAction	action to check, for example: Browse, Add
$iContentId	content ID

Returns

message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed

serviceCheckAllowedViewForProfile()

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

---

PERMISSION METHODS

Hooks:

'system', 'check_allowed_view' - hook to override the result of checking whether 'view' action is allowed or not to specified profile

• $unit_name - equals system
• $action - equals check_allowed_view
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • module - [string] module name
  • content_info - [array] content info array as key&value pairs
  • profile_id - [boolean] or [int] profile id to be checked the availability of the action to
  • override_result - [string] or [int] by ref, check action result, can be overridden in hook processing. Return string with an error if action isn't allowed or CHECK_ACTION_RESULT_ALLOWED,

    See also

    BxDolAcl

    HOOKS

    'system', 'check_allowed_view' - hook to override the result of checking whether 'view' action is allowed or not to specified profile

Reimplemented in BxBaseModGroupsModule, BxBaseModProfileModule, BxCnvModule, and BxTimelineModule.

serviceCheckAllowedWithContent()

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

Check particular action permission with content

Parameters

$sAction	action to check, for example: View, Edit
$iContentId	content ID

Returns

message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed

Reimplemented in BxRemindersModule.

serviceCheckAllowedWithContentForProfile()

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

Check particular action permission with content for specified profile

Parameters

$sAction	action to check, for example: View, Edit
$iContentId	content ID
$iProfileId	profile ID which the permissions to be cheked for

Returns

message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed

Reimplemented in BxFdbModule.

serviceDeleteEntity()

BxBaseModGeneralModule::serviceDeleteEntity	(		$iContentId,
			$sFuncDelete = 'deleteData' )

Delete content entry

Parameters

$iContentId

content id

Returns

error message or empty string on success

Reimplemented in BxCnvModule, BxFilesModule, and BxTimelineModule.

serviceEntityActions()

BxBaseModGeneralModule::serviceEntityActions

(

$iContentId = 0

)

entity_actions

serviceEntityAdd()

BxBaseModGeneralModule::serviceEntityAdd	(		$iProfile,
			$aValues,
			$sDisplay = false )

Add entry using provided fields' values.

Returns

array with result: 'code' is 0 on success or non-zero on error, 'message' is error message in case of error, 'content' is content info array in case of success

serviceEntityAllActions()

BxBaseModGeneralModule::serviceEntityAllActions	(		$mixedContent = false,
			$aParams = array() )

entity_all_actions

Reimplemented in BxAlbumsModule, and BxBaseModGroupsModule.

serviceEntityAttachments()

BxBaseModGeneralModule::serviceEntityAttachments

(

$iContentId = 0

)

entity_attachments

serviceEntityComments()

BxBaseModGeneralModule::serviceEntityComments

(

$iContentId = 0

)

entity_comments

serviceEntityContext()

BxBaseModGeneralModule::serviceEntityContext

(

$iContentId = 0

)

Entry context block

serviceEntityCreate()

BxBaseModGeneralModule::serviceEntityCreate

(

$sParams = false

)

Create entry form

Returns

HTML string

Reimplemented in BxAdsModule, BxBaseModProfileModule, BxCnvModule, BxMarketModule, BxShopifyModule, and BxSnipcartModule.

serviceEntityDelete()

BxBaseModGeneralModule::serviceEntityDelete

(

$iContentId = 0

)

entity_delete

Reimplemented in BxSpacesModule.

serviceEntityEdit()

BxBaseModGeneralModule::serviceEntityEdit	(		$iContentId = 0,
			$sDisplay = false )

entity_edit

serviceEntityInfo()

BxBaseModGeneralModule::serviceEntityInfo	(		$iContentId = 0,
			$sDisplay = false )

entity_info

serviceEntityInfoExtended()

BxBaseModGeneralModule::serviceEntityInfoExtended

(

$iContentId = 0

)

entity_info_extended

serviceEntityInfoFull()

BxBaseModGeneralModule::serviceEntityInfoFull

(

$iContentId = 0

)

entity_info_full

serviceEntityLocation()

BxBaseModGeneralModule::serviceEntityLocation

(

$iContentId = 0

)

entity_location

serviceEntityReports()

BxBaseModGeneralModule::serviceEntityReports

(

$iContentId = 0

)

entity_reports

serviceEntitySocialSharing()

BxBaseModGeneralModule::serviceEntitySocialSharing	(		$mixedContent = false,
			$aParams = array() )

entity_social_sharing

Reimplemented in BxBaseModGroupsModule, BxBaseModProfileModule, and BxCnvModule.

serviceEntityTextBlock()

BxBaseModGeneralModule::serviceEntityTextBlock

(

$iContentId = 0

)

entity_text_block

serviceFavoritesListActions()

BxBaseModGeneralModule::serviceFavoritesListActions

(

)

browse_favorite_list_actions

serviceFavoritesListInfo()

BxBaseModGeneralModule::serviceFavoritesListInfo

(

$aParams = array()

)

favorites_list_info

serviceGetAuthor()

BxBaseModGeneralModule::serviceGetAuthor

(

$iContentId

)

Reimplemented in BxTimelineModule.

serviceGetBadges()

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

Hooks:

'system', 'get_badges' - hook to override bages assigned to an entry (content)

• $unit_name - equals system
• $action - equals get_badges
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • module - [string] module name
  • content_id - [int] content id
  • is_single - [boolean] only one badge can be used or not
  • is_compact - [boolean] badge in compact mode or not
  • badges - [array] a list of all badges assigned to the content
  • override_result - [string] or [boolean] by ref, if string is returned then it will be used as resulting badges code, can be overridden in hook processing

    HOOKS

    'system', 'get_badges' - hook to override bages assigned to an entry (content)

serviceGetContentOwnerProfileId()

BxBaseModGeneralModule::serviceGetContentOwnerProfileId

(

$iContentId

)

Reimplemented in BxTimelineModule.

serviceGetCreatePostForm()

BxBaseModGeneralModule::serviceGetCreatePostForm

(

$aParams = []

)

get_create_post_form

Reimplemented in BxTimelineModule.

serviceGetDateChanged()

BxBaseModGeneralModule::serviceGetDateChanged

(

$iContentId

)

Reimplemented in BxTimelineModule.

serviceGetInfo()

BxBaseModGeneralModule::serviceGetInfo	(		$iContentId,
			$bSearchableFieldsOnly = true )

Reimplemented in BxForumModule, and BxTimelineModule.

serviceGetLablesTree()

BxBaseModGeneralModule::serviceGetLablesTree

(

)

Blocks for lables tree browsing

serviceGetLink()

BxBaseModGeneralModule::serviceGetLink

(

$iContentId

)

get_link

Reimplemented in BxTimelineModule.

serviceGetMenuAddonManageTools()

BxBaseModGeneralModule::serviceGetMenuAddonManageTools

(

)

Reimplemented in BxAccntModule, and BxTimelineModule.

serviceGetMenuAddonManageToolsProfileStats()

BxBaseModGeneralModule::serviceGetMenuAddonManageToolsProfileStats

(

$iProfileId = 0

)

Reimplemented in BxBaseModTextModule.

serviceGetNotificationsComment()

BxBaseModGeneralModule::serviceGetNotificationsComment

(

$aEvent

)

Entry post comment for Notifications module

Reimplemented in BxTimelineModule.

serviceGetNotificationsData()

BxBaseModGeneralModule::serviceGetNotificationsData

(

)

Data for Notifications module

Reimplemented in BxAdsModule, BxAlbumsModule, BxBaseModGroupsModule, BxBaseModProfileModule, BxCnlModule, BxEventsModule, BxFdbModule, BxRemindersModule, BxTasksModule, and BxTimelineModule.

serviceGetNotificationsPost()

BxBaseModGeneralModule::serviceGetNotificationsPost

(

$aEvent

)

Entry post for Notifications module

Reimplemented in BxBaseModProfileModule, BxRemindersModule, and BxTimelineModule.

serviceGetNotificationsPostPendingApproval()

BxBaseModGeneralModule::serviceGetNotificationsPostPendingApproval

(

$aEvent

)

Unset Entry Author because the notification is addressed to 'admins'.

serviceGetNotificationsReaction()

BxBaseModGeneralModule::serviceGetNotificationsReaction

(

$aEvent

)

Entry post vote for Notifications module

Reimplemented in BxTimelineModule.

serviceGetNotificationsReply()

BxBaseModGeneralModule::serviceGetNotificationsReply

(

$aEvent

)

Entry post reply for Notifications module

Reimplemented in BxTimelineModule.

serviceGetNotificationsScoreDown()

BxBaseModGeneralModule::serviceGetNotificationsScoreDown

(

$aEvent

)

Entry post score -> vote up for Notifications module

Reimplemented in BxTimelineModule.

serviceGetNotificationsScoreUp()

BxBaseModGeneralModule::serviceGetNotificationsScoreUp

(

$aEvent

)

Entry post score -> vote up for Notifications module

Reimplemented in BxTimelineModule.

serviceGetNotificationsVote()

BxBaseModGeneralModule::serviceGetNotificationsVote

(

$aEvent

)

Entry post vote for Notifications module

Reimplemented in BxBaseModProfileModule, and BxTimelineModule.

serviceGetObjectForm()

BxBaseModGeneralModule::serviceGetObjectForm	(		$sType,
			$aParams = array() )

Get form object for add, edit, view or delete the content

Parameters

$sType	'add', 'edit', 'view' or 'delete'
$aParams	optional array with parameters(display name, etc)

Returns

form object or false on error

Hooks:

'system', 'get_object_form' - hook to override an object of create content form,

See also

BxDolForm

• $unit_name - equals system
• $action - equals get_object_form
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • module - [string] module name
  • type - [string] 'add', 'edit', 'view' or 'delete' form display type
  • params - [array] form params array as key&value pairs
  • form - [object] by ref, an object of create content form,

BxDolForm, can be overridden in hook processing

HOOKS

'system', 'get_object_form' - hook to override an object of create content form,

Reimplemented in BxTimelineModule.

serviceGetSafeServices()

BxBaseModGeneralModule::serviceGetSafeServices

(

)

Reimplemented from BxDolModule.

Reimplemented in BxForumModule, BxMassMailerModule, BxNtfsModule, and BxTimelineModule.

serviceGetSearchableFields()

BxBaseModGeneralModule::serviceGetSearchableFields

(

$aInputsAdd = array()

)

Reimplemented in BxForumModule, BxMarketModule, and BxSnipcartModule.

serviceGetSearchResultUnit()

BxBaseModGeneralModule::serviceGetSearchResultUnit	(		$iContentId,
			$sUnitTemplate = '' )

get_search_result_unit

Reimplemented in BxBaseModGroupsModule, BxBaseModProfileModule, BxOrgsModule, and BxTimelineModule.

serviceGetTimelineData()

BxBaseModGeneralModule::serviceGetTimelineData

(

)

Data for Timeline module

Reimplemented in BxAlbumsModule, BxBaseModGroupsModule, BxBaseModProfileModule, BxCnlModule, BxFdbModule, BxOrgsModule, and BxTasksModule.

serviceGetTimelinePost()

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

Entry post for Timeline module

Don't show anonymous posts on the post's owner timeline.

Reimplemented in BxAdsModule, BxBaseModGroupsModule, BxClssModule, BxEventsModule, BxPostsModule, BxReviewsModule, BxStrmModule, BxTasksModule, and BxTimelineModule.

serviceGetTitle()

BxBaseModGeneralModule::serviceGetTitle

(

$iContentId

)

Reimplemented in BxTimelineModule.

serviceModuleIcon()

BxBaseModGeneralModule::serviceModuleIcon

(

)

module_icon

serviceMyEntriesActions()

BxBaseModGeneralModule::serviceMyEntriesActions

(

$iProfileId = 0

)

my_entries_actions

Reimplemented in BxFilesModule.

serviceRedirectAfterAdd()

BxBaseModGeneralModule::serviceRedirectAfterAdd

(

$aContentInfo

)

Perform redirect after content creation

Returns

nothing, rediret header is sent

serviceReportsCountByStatus()

BxBaseModGeneralModule::serviceReportsCountByStatus

(

$iStatus

)

entity_reports

---

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

• modules/base/general/classes/BxBaseModGeneralModule.php