UNA
All Classes Functions Variables Modules Pages
BxBaseModGeneralModule Class Reference
Inheritance diagram for BxBaseModGeneralModule:
BxDolModule BxDol BxAccntModule BxBaseModConnectModule BxBaseModNotificationsModule BxBaseModPaymentModule BxBaseModProfileModule BxBaseModTemplateModule BxBaseModTextModule BxCreditsModule BxDolMModule BxDonationsModule BxElsModule BxFdbModule BxMassMailerModule BxRemindersModule BxSEMigModule

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 ()
 
 actionGetAttachLinkForm ()
 
 actionSubmitAttachLinkForm ()
 
 actionAddAttachLink ()
 
 actionDeleteAttachLink ()
 
 actionGetCreatePostForm ()
 
 actionGetNotes ()
 
 actionNested ()
 
 actionEmbed ($iContentId, $sUnitTemplate='', $sAddCode='')
 
 subactionDelete ()
 
 actionAjaxGetProfiles ()
 
 serviceGetProfiles ($sParams)
 
 actionGetBrowsingFilters ()
 
 actionApplyBrowsingFilters ()
 
 serviceIsAllowedAddContentToContext ($iContextPid)
 
 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='')
 
 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
 __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)
 
 _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())
 

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:

◆ _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

◆ _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:

◆ _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)

◆ 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:

◆ alertAfterEdit()

BxBaseModGeneralModule::alertAfterEdit ( $aContentInfo)

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

◆ 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:

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:

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

◆ onFailed()

BxBaseModGeneralModule::onFailed ( $iContentId)

Hooks:

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

Reimplemented in BxTimelineModule.

◆ onUpdateImage()

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

◆ serviceBrowse()

BxBaseModGeneralModule::serviceBrowse ( $aParams = array())

◆ serviceBrowseCategory()

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

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

◆ serviceBrowseFavoriteLists()

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

◆ serviceBrowseFeatured()

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

◆ serviceCategoriesMultiList()

BxBaseModGeneralModule::serviceCategoriesMultiList ( $bDisplayEmptyCats = true)

◆ serviceCheckAllowed()

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

Check particular action permission without content

Parameters
$sActionaction to check, for example: Browse, Add
$iContentIdcontent 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

Reimplemented in BxBaseModGroupsModule, BxBaseModProfileModule, BxCnvModule, and BxTimelineModule.

◆ serviceCheckAllowedWithContent()

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

Check particular action permission with content

Parameters
$sActionaction to check, for example: View, Edit
$iContentIdcontent 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
$sActionaction to check, for example: View, Edit
$iContentIdcontent ID
$iProfileIdprofile 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
$iContentIdcontent id
Returns
error message or empty string on success

Reimplemented in BxCnvModule, BxFilesModule, and BxTimelineModule.

◆ serviceEditEntity()

BxBaseModGeneralModule::serviceEditEntity ( $iContentId,
$aValues )

Edit content entry

Parameters
$iContentIdcontent id
$aValueskey value pairs to update
Returns
error message or empty string on success

◆ serviceEntityActions()

BxBaseModGeneralModule::serviceEntityActions ( $iContentId = 0)

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

◆ serviceEntityAttachments()

BxBaseModGeneralModule::serviceEntityAttachments ( $iContentId = 0)

◆ serviceEntityComments()

BxBaseModGeneralModule::serviceEntityComments ( $iContentId = 0)

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

◆ serviceEntityInfo()

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

◆ serviceEntityInfoExtended()

BxBaseModGeneralModule::serviceEntityInfoExtended ( $iContentId = 0)

◆ serviceEntityInfoFull()

BxBaseModGeneralModule::serviceEntityInfoFull ( $iContentId = 0)

◆ serviceEntityLocation()

BxBaseModGeneralModule::serviceEntityLocation ( $iContentId = 0)

◆ serviceEntityReports()

BxBaseModGeneralModule::serviceEntityReports ( $iContentId = 0)

◆ serviceEntitySocialSharing()

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

◆ serviceEntityTextBlock()

BxBaseModGeneralModule::serviceEntityTextBlock ( $iContentId = 0)

◆ serviceFavoritesListActions()

BxBaseModGeneralModule::serviceFavoritesListActions ( )

◆ serviceFavoritesListInfo()

BxBaseModGeneralModule::serviceFavoritesListInfo ( $aParams = array())

◆ 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 = [])

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

◆ 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'
$aParamsoptional 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.

◆ serviceGetReputationData()

BxBaseModGeneralModule::serviceGetReputationData ( )

Data for Reputation module

Reimplemented in BxBaseModGroupsModule, and BxTimelineModule.

◆ serviceGetSafeServices()

BxBaseModGeneralModule::serviceGetSafeServices ( )

◆ serviceGetSearchableFields()

BxBaseModGeneralModule::serviceGetSearchableFields ( $aInputsAdd = array())

◆ serviceGetSearchableFieldsExtended()

BxBaseModGeneralModule::serviceGetSearchableFieldsExtended ( $aInputsAdd = array())

Hooks:

'{module_name}', 'get_searchable_fields' - hook to override a list of searchable fields

◆ serviceGetSearchResultUnit()

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

◆ serviceGetSortableFieldsExtended()

BxBaseModGeneralModule::serviceGetSortableFieldsExtended ( $aInputsAdd = array())

Hooks:

'{module_name}', 'get_sortable_fields' - hook to override a list of sortable fields

◆ serviceGetText()

BxBaseModGeneralModule::serviceGetText ( $iContentId)

Reimplemented in BxTimelineModule.

◆ serviceGetTimelineData()

BxBaseModGeneralModule::serviceGetTimelineData ( )

◆ serviceGetTimelinePost()

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

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 in BxAdsModule, BxBaseModGroupsModule, BxClssModule, BxEventsModule, BxPostsModule, BxReviewsModule, BxStrmModule, BxTasksModule, and BxTimelineModule.

◆ serviceGetTitle()

BxBaseModGeneralModule::serviceGetTitle ( $iContentId)

Reimplemented in BxTimelineModule.

◆ serviceGetView()

BxBaseModGeneralModule::serviceGetView ( $iContentId)

get_view

Reimplemented in BxPhotosModule.

◆ serviceModuleIcon()

BxBaseModGeneralModule::serviceModuleIcon ( )

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

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