BxBaseModGroupsModule Class Reference

Inheritance diagram for BxBaseModGroupsModule:

Public Member Functions
	actionAjaxGetInitialMembers ()
	actionProcessInvite ($sKey, $iGroupProfileId, $bAccept)
	serviceGetSpaceTitle ()
	serviceGetParticipatingProfiles ($iProfileId, $aConnectionObjects=false)
	serviceActAsProfile ()
	serviceIsGroupProfile ()
	serviceIsFan ($iGroupProfileId, $iProfileId=false)
	serviceIsAdmin ($iGroupProfileId, $iProfileId=false)
	serviceDeleteProfileFromFansAndAdmins ($iProfileId)
	serviceReassignEntityAuthor ($iContentId, $iAuthorId=0)
	serviceEntityAllActions ($mixedContent=false, $aParams=array())
	serviceReassignEntitiesByAuthor ($iProfileId, $iAuthorId=0)
	serviceEntitySocialSharing ($mixedContent=false, $aParams=array())
	isPaidJoinByProfileForProfile ($iGroupProfileId, $iProfileId=0)
	isPaidJoinByProfile ($iGroupProfileId)
	serviceGetPaymentData ()
	serviceGetNotificationsData ()
	serviceGetNotificationsJoinInvitation ($aEvent)
	serviceGetNotificationsJoinRequest ($aEvent)
	serviceGetNotificationsFanAdded ($aEvent)
	serviceGetTimelineData ()
	serviceGetTimelinePost ($aEvent, $aBrowseParams=array())
	checkAllowedUsePaidJoin ($isPerformAction=false)
	checkAllowedView ($aDataEntry, $isPerformAction=false)
	checkAllowedCompose (&$aDataEntry, $isPerformAction=false)
	checkAllowedFanAdd (&$aDataEntry, $isPerformAction=false)
	checkAllowedFanRemove (&$aDataEntry, $isPerformAction=false)
	_modGroupsCheckAllowedSubscribeAdd (&$aDataEntry, $isPerformAction=false)
	_checkAllowedSubscribeAdd (&$aDataEntry, $isPerformAction=false)
Public Member Functions inherited from BxBaseModProfileModule
	serviceEntityCalendar ($iContentId=0, $sTemplate='calendar.html')
	serviceProfileUnitSafe ($iContentId, $aParams=array())
	serviceProfileUrl ($iContentId)
	serviceGetSpaceTitle ()
	serviceGetParticipatingProfiles ($iProfileId, $aConnectionObjects=false)
	servicePrepareFields ($aFieldsProfile)
	serviceEntityCreate ($sDisplay=false)
	serviceBrowseRecommended ($sUnitView=false, $bEmptyMessage=false, $bAjaxPaginate=true)
	serviceBrowseRecentProfiles ($bDisplayEmptyMsg=false, $bAjaxPaginate=true)
	serviceBrowseActiveProfiles ($sUnitView=false, $bEmptyMessage=false, $bAjaxPaginate=false)
	serviceBrowseFamiliarProfiles ($sConnection='', $sUnitView=false, $bEmptyMessage=false, $bAjaxPaginate=false)
	serviceBrowseTopProfiles ($bDisplayEmptyMsg=false, $bAjaxPaginate=false)
	serviceBrowseOnlineProfiles ($bDisplayEmptyMsg=false, $bAjaxPaginate=false)
	serviceBrowseByAcl ($mixedLevelId, $iDesignBox=BX_DB_PADDING_DEF)
	serviceEntityCover ($iContentId=0, $aParams=[])
	serviceEntityCommentsByProfile ($iProfileId)
	serviceEntitySocialSharing ($mixedContent=false, $aParams=array())
	serviceIsEnableProfileActivationLetter ()
	serviceDeleteEntityService ($iContentId, $bDeleteWithContent=false)
	serviceGetNotificationsData ()
	serviceGetNotificationsTimelinePostCommon ($aEvent)
	serviceGetTimelineData ()
	serviceGetTimelineProfilePicture ($aEvent, $aBrowseParams=[])
	serviceCheckAllowedProfileView ($iContentId)
	serviceCheckAllowedProfileContact ($iContentId)
	serviceCheckAllowedPostInProfile ($iContentId, $sPostModule='')
	serviceCheckAllowedModuleActionInProfile ($iContentId, $sPostModule, $sActionName)
	serviceCheckSpacePrivacy ($iContentId)
	serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction=false, $iProfileId=false)
	serviceCheckAllowedPostForProfile ($aDataEntry, $isPerformAction=false, $iProfileId=false)
	serviceCheckAllowedContactForProfile ($aDataEntry, $isPerformAction=false, $iProfileId=false)
	serviceGetMembers ($sMode='active', $iStart=0, $iPerPage=10)
	checkAllowedAdd ($isPerformAction=false)
	checkAllowedView ($aDataEntry, $isPerformAction=false)
	checkAllowedViewProfileImage ($aDataEntry, $isPerformAction=false)
	checkAllowedViewCoverImage ($aDataEntry, $isPerformAction=false)
	checkAllowedPost ($aDataEntry, $isPerformAction=false)
	checkAllowedContact ($aDataEntry, $isPerformAction=false)
	checkAllowedEdit ($aDataEntry, $isPerformAction=false)
	checkAllowedChangeCover ($aDataEntry, $isPerformAction=false)
	checkAllowedDelete (&$aDataEntry, $isPerformAction=false)
	checkAllowedViewMoreMenu (&$aDataEntry, $isPerformAction=false)
	checkAllowedCompose (&$aDataEntry, $isPerformAction=false)
	checkAllowedFriendAdd (&$aDataEntry, $isPerformAction=false)
	checkAllowedFriendRemove (&$aDataEntry, $isPerformAction=false)
	checkAllowedRelationAdd (&$aDataEntry, $isPerformAction=false)
	checkAllowedRelationRemove (&$aDataEntry, $isPerformAction=false)
	checkAllowedSubscribeAdd (&$aDataEntry, $isPerformAction=false)
	_modProfileCheckAllowedSubscribeAdd (&$aDataEntry, $isPerformAction=false)
	checkAllowedSubscribeRemove (&$aDataEntry, $isPerformAction=false)
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 BxBaseModGeneralModule
	_serviceBrowseQuick ($aProfiles, $iStart=0, $iLimit=4, $aAdditionalParams=array())
	_alertParams ($aContentInfo)

Detailed Description

Groups profiles module.

Member Function Documentation

_checkAllowedSubscribeAdd()

BxBaseModGroupsModule::_checkAllowedSubscribeAdd	(	&	$aDataEntry,
			$isPerformAction = false
	)

Deprecated:

since version 11.0.3 and can be removed in the next version.

_modGroupsCheckAllowedSubscribeAdd()

BxBaseModGroupsModule::_modGroupsCheckAllowedSubscribeAdd	(	&	$aDataEntry,
			$isPerformAction = false
	)

Note. Is mainly needed for internal usage. Access level is 'public' to allow outer calls from alerts.

actionAjaxGetInitialMembers()

BxBaseModGroupsModule::actionAjaxGetInitialMembers

(

)

Get possible recipients for start conversation form

actionProcessInvite()

BxBaseModGroupsModule::actionProcessInvite	(		$sKey,
			$iGroupProfileId,
			$bAccept
	)

Process Process Invitation

checkAllowedCompose()

BxBaseModGroupsModule::checkAllowedCompose	(	&	$aDataEntry,
			$isPerformAction = false
	)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden.

checkAllowedFanAdd()

BxBaseModGroupsModule::checkAllowedFanAdd	(	&	$aDataEntry,
			$isPerformAction = false
	)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden.

checkAllowedFanRemove()

BxBaseModGroupsModule::checkAllowedFanRemove	(	&	$aDataEntry,
			$isPerformAction = false
	)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden.

checkAllowedUsePaidJoin()

BxBaseModGroupsModule::checkAllowedUsePaidJoin

(

$isPerformAction = false

)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden.

checkAllowedView()

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

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden.

isPaidJoinByProfile()

BxBaseModGroupsModule::isPaidJoinByProfile

(

$iGroupProfileId

)

Is Paid Join enabled as is and whether a group has pricing plans added.

Parameters

type

$iGroupProfileId

- Group profile ID.

Returns

boolean

isPaidJoinByProfileForProfile()

BxBaseModGroupsModule::isPaidJoinByProfileForProfile	(		$iGroupProfileId,
			$iProfileId = 0
	)

Is Paid Join enabled in the group and whether a profile can use it.

Parameters

type	$iGroupProfileId	- Group profile ID.
type	$iProfileId	- Profile ID of the user who wants to join.

Returns

boolean

serviceActAsProfile()

BxBaseModGroupsModule::serviceActAsProfile

(

)

Check if this module entry can be used as profile

Implements iBxDolProfileService.

serviceAddMutualConnection()

BxBaseModGroupsModule::serviceAddMutualConnection	(		$iGroupProfileId,
			$iInitiatorId,
			$bSendInviteOnly = false
	)

'Invitation Received' alert for Notifications module. Note. It's essential to use Recipient ($iInitiatorId) in 'object_author_id' parameter. In this case notification will be received by Recipient profile.

serviceDeleteProfileFromFansAndAdmins()

BxBaseModGroupsModule::serviceDeleteProfileFromFansAndAdmins

(

$iProfileId

)

Delete profile from fans and admins tables

Parameters

$iProfileId

profile id

serviceEntityAllActions()

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

Entry actions and social sharing block

serviceEntitySocialSharing()

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

Entry social sharing block

serviceGetNotificationsData()

BxBaseModGroupsModule::serviceGetNotificationsData

(

)

Data for Notifications module

serviceGetNotificationsFanAdded()

BxBaseModGroupsModule::serviceGetNotificationsFanAdded

(

$aEvent

)

Notification about new member in the group

serviceGetNotificationsJoinInvitation()

BxBaseModGroupsModule::serviceGetNotificationsJoinInvitation

(

$aEvent

)

Notification about new invitation to join the group

serviceGetNotificationsJoinRequest()

BxBaseModGroupsModule::serviceGetNotificationsJoinRequest

(

$aEvent

)

Notification about new member requst in the group

serviceGetParticipatingProfiles()

BxBaseModGroupsModule::serviceGetParticipatingProfiles	(		$iProfileId,
			$aConnectionObjects = false
	)

See also

iBxDolProfileService::serviceGetParticipatingProfiles

Implements iBxDolProfileService.

serviceGetPaymentData()

BxBaseModGroupsModule::serviceGetPaymentData

(

)

Integration with Payments.

serviceGetSpaceTitle()

BxBaseModGroupsModule::serviceGetSpaceTitle

(

)

See also

BxBaseModProfileModule::serviceGetSpaceTitle

Implements iBxDolProfileService.

serviceGetTimelineData()

BxBaseModGroupsModule::serviceGetTimelineData

(

)

Data for Timeline module

serviceGetTimelinePost()

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

Entry post for Timeline module

serviceIsAdmin()

BxBaseModGroupsModule::serviceIsAdmin	(		$iGroupProfileId,
			$iProfileId = false
	)

check if provided profile is admin of the group

serviceIsFan()

BxBaseModGroupsModule::serviceIsFan	(		$iGroupProfileId,
			$iProfileId = false
	)

check if provided profile is member of the group

serviceIsGroupProfile()

BxBaseModGroupsModule::serviceIsGroupProfile

(

)

Check if this module is group profile

serviceReassignEntitiesByAuthor()

BxBaseModGroupsModule::serviceReassignEntitiesByAuthor	(		$iProfileId,
			$iAuthorId = 0
	)

Reset group's author when author profile is deleted

Parameters

$iProfileId	author profile id
$iAuthorId	new author profile id

Returns

number of changed items

serviceReassignEntityAuthor()

BxBaseModGroupsModule::serviceReassignEntityAuthor	(		$iContentId,
			$iAuthorId = 0
	)

Reset group's author for particular group

Parameters

$iContentId

group id $iAuthorId new author profile ID

Returns

false of error, or number of updated records on success

---

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

• modules/base/groups/classes/BxBaseModGroupsModule.php