BxCnvModule Class Reference

Inheritance diagram for BxCnvModule:

Public Member Functions
	__construct (&$aModule)
	sortCollaborators ($aCollaborators, $iProfileIdLastComment, $iProfileIdAuthor, $iProfileIdCurrent=0)
	setModuleSubmenu ($iCurrentFolderId=0)
	markUnread ($iContentId)
	deleteConvo ($iContentId)
	deleteConvoForever ($iContentId)
	actionMarkUnread ($iContentId)
	actionDelete ($iContentId)
	actionFolder ($iFolderId)
	actionAjaxGetRecipients ()
	serviceGetSafeServices ()
	serviceIsAllowedContact ($iProfileId)
	serviceConversationsInFolder ($iFolderId=BX_CNV_FOLDER_INBOX)
	serviceMessagesPreviews ($iProfileId=0, $bEmptyMessage=true)
	serviceGetMessagesPreviews ($iProfileId=0, $iStart=0, $iPerPage=10, $iFolderId=BX_CNV_FOLDER_INBOX)
	serviceGetUnreadMessagesNum ($iProfileId=0)
	serviceGetLiveUpdates ($aMenuItemParent, $aMenuItemChild, $iCount=0)
	serviceTriggerCommentPost ($iContentId, $iProfileId, $iCommentId, $iTimestamp=0, $sCommentText='')
	serviceEntityCreate ($sParams=false)
	serviceEntityCollaborators ($iContentId=0)
	serviceEntitySocialSharing ($mixedContent=false, $aParams=array())
	serviceDeleteEntity ($iContentId, $sFuncDelete='deleteData')
	serviceRemoveCollaboratorFromAllConversations ($iProfileId)
	serviceDeleteEntitiesByAuthor ($iProfileId)
	_isModerator ($isPerformAction=false)
	checkAllowedSetThumb ($iContentId=0)
	checkAllowedEditAnyEntry ($isPerformAction=false)
	checkAllowedEditAnyEntryForProfile ($isPerformAction=false, $iProfileId=false)
	checkAllowedDeleteAnyEntryForProfile ($isPerformAction=false, $iProfileId=false)
	checkAllowedEdit ($aDataEntry, $isPerformAction=false)
	checkAllowedDelete (&$aDataEntry, $isPerformAction=false)
	checkAllowedView ($aDataEntry, $isPerformAction=false)
	checkAllowedContact ($iProfileId, $isPerformAction=false)
	serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction=false, $iProfileId=false)
	serviceIsAllowedPostInContext ()
Public Member Functions inherited from BxBaseModTextModule
	actionEmbedPoll ($iPollId=0)
	actionEmbedPolls ($iId=0)
	actionGetPoll ()
	actionDeletePoll ()
	actionGetPollForm ()
	actionSubmitPollForm ()
	actionFileEmbedVideo ($iFileId)
	actionFileEmbedSound ($iFileId)
	serviceManageTools ($sType='common')
	serviceCategoriesMultiListContext ($iProfileId=0, $bDisplayEmptyCats=true)
	serviceGetBlockPollAnswers ($iPollId, $bForceDisplay=false)
	serviceGetBlockPollResults ($iPollId)
	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)
	serviceEntityPolls ($iContentId=0)
	serviceEntityBreadcrumb ($iContentId=0)
	isAllowedApprove ($mixedContent, $isPerformAction=false)
	checkAllowedApprove ($mixedContent, $isPerformAction=false)
	isPollPerformed ($iObjectId, $iAuthorId=0, $iAuthorIp=0)
	deleteAttachLinks ($iId)
	deleteAttachLinksUnused ($iProfileId)
	onApprove ($mixedContent)
	alertAfterAdd ($aContentInfo)
	alertAfterEdit ($aContentInfo)
	getPollForm ()
	getEntryImageData ($aContentInfo, $sField='FIELD_THUMB', $aTranscoders=array())
	decodeDataAPI ($aData, $aParams=[])
Public Member Functions inherited from BxBaseModGeneralModule
	isEntryActive ($aContentInfo)
	isEntryAuthor ($aContentInfo, $iProfileId=0)
	actionUpdateImage ($sFiledName, $iContentId, $sValue)
	actionUpdateImagePosition ($iContentId, $sFiledName, $sH, $sV)
	actionApprove ()
	serviceSetStatus ($iId, $sValue, $sStatus='')
	actionRss ()
	actionGetAttachLinkForm ()
	actionSubmitAttachLinkForm ()
	actionAddAttachLink ()
	actionDeleteAttachLink ()
	actionGetCreatePostForm ()
	actionGetNotes ()
	actionNested ()
	actionEmbed ($iContentId, $sUnitTemplate='', $sAddCode='')
	subactionDelete ()
	actionAjaxGetProfiles ()
	serviceGetProfiles ($sParams)
	actionGetBrowsingFilters ()
	actionApplyBrowsingFilters ()
	serviceIsActive ($iContentId)
	serviceIsAllowedAddContentToContext ($iContextPid)
	serviceIsBadgesAvaliable ()
	serviceModuleIcon ()
	serviceGetAuthor ($iContentId)
	serviceGetPrivacyView ($iContentId)
	serviceGetDateAdded ($iContentId)
	serviceGetDateChanged ($iContentId)
	serviceGetLinkAdd ()
	serviceGetLinkEdit ($iContentId)
	serviceGetLink ($iContentId)
	serviceGetTitle ($iContentId)
	serviceGetText ($iContentId)
	serviceGetLocation ($iContentId)
	serviceGetEmbed ($iContentId)
	serviceGetInfo ($iContentId, $bSearchableFieldsOnly=true)
	serviceGetInfoApi ($iContentId, $bExtendedUnits=false)
	serviceGetSearchResultUnit ($iContentId, $sUnitTemplate='')
	serviceGetView ($iContentId)
	serviceGetAll ($aParams=array())
	serviceGetAllByAuthor ($iProfileId)
	serviceGetSortableFieldsExtended ($aInputsAdd=array())
	serviceGetSearchableFieldsExtended ($aInputsAdd=array())
	serviceGetSearchResultExtended ($aParams, $iStart=0, $iPerPage=0, $bFilterMode=false)
	serviceGetSearchableFields ($aInputsAdd=array())
	serviceUpdateImage ($sFiledName, $iContentId, $sValue)
	serviceUpdateImagePosition ($iContentId, $sFiledName, $sH, $sV)
	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())
	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)
	serviceEditEntity ($iContentId, $aValues)
	serviceMyEntriesActions ($iProfileId=0)
	serviceEntityAllActions ($mixedContent=false, $aParams=array())
	serviceEntityActions ($iContentId=0)
	serviceEntityReports ($iContentId=0)
	serviceReportsCountByStatus ($iStatus)
	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)
	checkAllowedBrowse ()
	checkAllowedViewForProfile ($aDataEntry, $iProfileId, $isPerformAction=false)
	checkAllowedAdd ($isPerformAction=false)
	checkAllowedSetMembership (&$aDataEntry, $isPerformAction=false)
	checkAllowedDeleteAnyEntry ($isPerformAction=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)
	onUpdateImage ($iContentId, $sFiledName, $sFiledValue, $iProfileId=0)
	alertAfterApprove ($aContentInfo)
	processMetasAdd ($iContentId)
	processMetasEdit ($iContentId, $oForm)
	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)
	_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())
	serviceGetSearchableFieldsExtended ($aInputsAdd=array())
	serviceGetSearchResultExtended ($aParams, $iStart=0, $iPerPage=0, $bFilterMode=false)

Protected Member Functions
	isCollaborator ($aDataEntry, $iProfileId)
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())
	_getContentForTimelinePost ($aEvent, $aContentInfo, $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)
	_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)
	_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())

Additional Inherited Members
Static Public Member Functions inherited from BxDolModule
static	getInstance ($sName)
static	getTitle ($sUri)
static	getTitleKey ($sUri)
Public Attributes inherited from BxDolModule
	$_aModule
	$_oDb
	$_oTemplate
	$_oConfig
Protected Attributes inherited from BxBaseModGeneralModule
	$_bIsApi
	$_iProfileId
	$_aSearchableNamesExcept
	$_aFormParams
	$_aBrowsingFiltersKeys

Detailed Description

Conversations module

Constructor & Destructor Documentation

__construct()

BxCnvModule::__construct

(

&

$aModule

)

Reimplemented from BxBaseModTextModule.

Member Function Documentation

_isModerator()

BxCnvModule::_isModerator

(

$isPerformAction = false

)

No moderators for personal convos

Reimplemented from BxBaseModGeneralModule.

actionAjaxGetRecipients()

BxCnvModule::actionAjaxGetRecipients

(

)

Get possible recipients for start conversation form

actionFolder()

BxCnvModule::actionFolder

(

$iFolderId

)

Display convos in folder

checkAllowedContact()

BxCnvModule::checkAllowedContact	(		$iProfileId,
			$isPerformAction = false )

Checks whether contact is allowed.

Parameters

integer	$iProfileId	- recipient profile ID
boolean	$isPerformAction	- perform or just check the action

Returns

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

checkAllowedDelete()

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

Conversations can be deleted by author and/or collaborators only. Admins can't delete conversations, since it's designed for participant only, it's moved to trash actually, also it's private content.

Reimplemented from BxBaseModGeneralModule.

checkAllowedDeleteAnyEntryForProfile()

BxCnvModule::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 from BxBaseModGeneralModule.

checkAllowedEdit()

BxCnvModule::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 from BxBaseModGeneralModule.

checkAllowedEditAnyEntry()

BxCnvModule::checkAllowedEditAnyEntry

(

$isPerformAction = false

)

There is no 'moderator' access in convos

Reimplemented from BxBaseModGeneralModule.

checkAllowedEditAnyEntryForProfile()

BxCnvModule::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 from BxBaseModGeneralModule.

checkAllowedSetThumb()

BxCnvModule::checkAllowedSetThumb

(

$iContentId = 0

)

No thumbs for convos

Reimplemented from BxBaseModTextModule.

checkAllowedView()

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

Only collaborators can view convo

Reimplemented from BxBaseModGeneralModule.

deleteConvo()

BxCnvModule::deleteConvo

(

$iContentId

)

Delete conversation for current user by content id, before deletetion it checks user permission to delete convos

Returns

error string on error, or empty string on success

deleteConvoForever()

BxCnvModule::deleteConvoForever

(

$iContentId

)

Delete whole conversation for all users by content id

Returns

error string on error, or empty string on success

markUnread()

BxCnvModule::markUnread

(

$iContentId

)

Mark conversation as unread for the current user

Returns

error string on error, or empty string on success

serviceCheckAllowedViewForProfile()

BxCnvModule::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 from BxBaseModGeneralModule.

serviceConversationsInFolder()

BxCnvModule::serviceConversationsInFolder

(

$iFolderId = BX_CNV_FOLDER_INBOX

)

conversations_in_folder

serviceDeleteEntitiesByAuthor()

BxCnvModule::serviceDeleteEntitiesByAuthor

(

$iProfileId

)

Delete all content by profile (when profile is delete with content)

Parameters

$iProfileId

profile id

Returns

number of deleted items

Reimplemented from BxBaseModTextModule.

serviceDeleteEntity()

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

Delete content entry

Parameters

$iContentId

content id

Returns

error message or empty string on success

Reimplemented from BxBaseModGeneralModule.

serviceEntityCollaborators()

BxCnvModule::serviceEntityCollaborators

(

$iContentId = 0

)

Entry collaborators block

serviceEntityCreate()

BxCnvModule::serviceEntityCreate

(

$sParams = false

)

Create entry form

Returns

HTML string

Reimplemented from BxBaseModGeneralModule.

serviceEntitySocialSharing()

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

No social sharing for private conversations

Reimplemented from BxBaseModGeneralModule.

serviceGetMessagesPreviews()

BxCnvModule::serviceGetMessagesPreviews	(		$iProfileId = 0,
			$iStart = 0,
			$iPerPage = 10,
			$iFolderId = BX_CNV_FOLDER_INBOX )

Returns preview of profile's conversations with statistic for React Jot

Parameters

int	$iProfileId
int	$iStart
int	$iPerPage
int	$iFolderId

Returns

mixed

serviceGetSafeServices()

BxCnvModule::serviceGetSafeServices

(

)

Reimplemented from BxBaseModTextModule.

serviceGetUnreadMessagesNum()

BxCnvModule::serviceGetUnreadMessagesNum

(

$iProfileId = 0

)

Get number of unread messages for spme profile

Parameters

$iProfileId

- profile to get unread messages for, if omitted then currently logged is profile is used

Returns

integer

serviceIsAllowedPostInContext()

BxCnvModule::serviceIsAllowedPostInContext

(

)

Reimplemented from BxBaseModTextModule.

serviceRemoveCollaboratorFromAllConversations()

BxCnvModule::serviceRemoveCollaboratorFromAllConversations

(

$iProfileId

)

Delete profile from all conversation (when profile is delete without content)

Parameters

$iProfileId

profile id

Returns

number of deleted items

serviceTriggerCommentPost()

BxCnvModule::serviceTriggerCommentPost	(		$iContentId,
			$iProfileId,
			$iCommentId,
			$iTimestamp = 0,
			$sCommentText = '' )

Update last comment time and author

---

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

• modules/boonex/convos/classes/BxCnvModule.php