Inheritance diagram for BxCnvModule:

Public Member Functions
	markUnread ($iContentId)

	deleteConvo ($iContentId)

	deleteConvoForever ($iContentId)

	actionFolder ($iFolderId)

	actionAjaxGetRecipients ()

	serviceConversationsInFolder ($iFolderId=BX_CNV_FOLDER_INBOX)

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

	serviceGetUnreadMessagesNum ($iProfileId=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)

	checkAllowedDelete (&$aDataEntry, $isPerformAction=false)

	checkAllowedView ($aDataEntry, $isPerformAction=false)

	checkAllowedContact ($iProfileId, $isPerformAction=false)

Public Member Functions inherited from BxBaseModTextModule
	serviceCategoriesMultiListContext ($iProfileId=0, $bDisplayEmptyCats=true)

	serviceGetBlockPollAnswers ($iPollId, $bForceDisplay=false)

	serviceGetBlockPollResults ($iPollId)

	serviceMediaExif ($iMediaId=0)

	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)

	serviceDeleteEntitiesByAuthor ($iProfileId)

	checkAllowedSetThumb ($iContentId=0)

Public Member Functions inherited from BxBaseModGeneralModule
	actionAjaxGetProfiles ()

	serviceModuleIcon ()

	serviceGetLink ($iContentId)

	serviceGetSearchResultUnit ($iContentId, $sUnitTemplate='')

	serviceBrowse ($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())

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

	serviceGetNotificationsData ()

	serviceGetNotificationsPost ($aEvent)

	serviceGetNotificationsComment ($aEvent)

	serviceGetNotificationsReply ($aEvent)

	serviceGetNotificationsVote ($aEvent)

	serviceGetNotificationsReaction ($aEvent)

	serviceGetNotificationsScoreUp ($aEvent)

	serviceGetNotificationsScoreDown ($aEvent)

	serviceGetTimelineData ()

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

	serviceCheckAllowed ($sAction, $isPerformAction=false)

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

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

	serviceCategoriesMultiList ($bDisplayEmptyCats=true)

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

	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)

Public Member Functions inherited from BxDolModule
	__construct ($aModule)

	isEnabled ()

	getName ()

	isLogged ()

	getUserId ()

	getUserPassword ()

Additional Inherited Members
Static Public Member Functions inherited from BxDolModule
static	getInstance ($sName)

Protected Member Functions inherited from BxBaseModTextModule
	_alertParams ($aContentInfo)

Protected Member Functions inherited from BxBaseModGeneralModule
	_serviceBrowseQuick ($aProfiles, $iStart=0, $iLimit=4, $aAdditionalParams=array())

	_alertParams ($aContentInfo)

Detailed Description

Conversations module

Member Function Documentation

◆ _isModerator()

BxCnvModule::_isModerator ( $isPerformAction = false )

No moderators for personal convos

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

◆ checkAllowedEditAnyEntry()

BxCnvModule::checkAllowedEditAnyEntry ( $isPerformAction = false )

There is no 'moderator' access in convos

◆ checkAllowedSetThumb()

BxCnvModule::checkAllowedSetThumb ( $iContentId = 0 )

No thumbs for convos

◆ checkAllowedView()

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

Only collaborators can view convo

◆ 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

◆ 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

◆ serviceDeleteEntity()

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

Delete content entry

Parameters

$iContentId content id

Returns: error message or empty string on success

◆ serviceEntityCollaborators()

BxCnvModule::serviceEntityCollaborators ( $iContentId = 0 )

Entry collaborators block

◆ serviceEntityCreate()

BxCnvModule::serviceEntityCreate ( $sParams = false )

Create entry form

Returns: HTML string

◆ serviceEntitySocialSharing()

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

No social sharing for private conversations

◆ 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

◆ 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

◆ 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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _isModerator()

◆ actionAjaxGetRecipients()

◆ actionFolder()

◆ checkAllowedContact()

◆ checkAllowedDelete()

◆ checkAllowedEditAnyEntry()

◆ checkAllowedSetThumb()

◆ checkAllowedView()

◆ deleteConvo()

◆ deleteConvoForever()

◆ markUnread()

◆ serviceConversationsInFolder()

◆ serviceDeleteEntitiesByAuthor()

◆ serviceDeleteEntity()

◆ serviceEntityCollaborators()

◆ serviceEntityCreate()

◆ serviceEntitySocialSharing()

◆ serviceGetMessagesPreviews()

◆ serviceGetUnreadMessagesNum()

◆ serviceRemoveCollaboratorFromAllConversations()

◆ serviceTriggerCommentPost()