BxBaseModProfileModule Class Reference

Inheritance diagram for BxBaseModProfileModule:

Public Member Functions
	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

Base class for profile modules.

Member Function Documentation

_modProfileCheckAllowedSubscribeAdd()

BxBaseModProfileModule::_modProfileCheckAllowedSubscribeAdd	(	&	$aDataEntry,
			$isPerformAction = false
	)

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

checkAllowedAdd()

BxBaseModProfileModule::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.

checkAllowedChangeCover()

BxBaseModProfileModule::checkAllowedChangeCover	(		$aDataEntry,
			$isPerformAction = false
	)

Check if user can change cover image

checkAllowedCompose()

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

Compose differs from Contact. For example, a user should NOT be able to start conversation (compose) with himself but he should be able to view conversation page where he is one of the participants.

Returns

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

checkAllowedContact()

BxBaseModProfileModule::checkAllowedContact	(		$aDataEntry,
			$isPerformAction = false
	)

Returns

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

checkAllowedDelete()

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

Returns

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

checkAllowedEdit()

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

Returns

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

checkAllowedFriendAdd()

BxBaseModProfileModule::checkAllowedFriendAdd	(	&	$aDataEntry,
			$isPerformAction = false
	)

Returns

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

checkAllowedFriendRemove()

BxBaseModProfileModule::checkAllowedFriendRemove	(	&	$aDataEntry,
			$isPerformAction = false
	)

Returns

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

checkAllowedPost()

BxBaseModProfileModule::checkAllowedPost	(		$aDataEntry,
			$isPerformAction = false
	)

Returns

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

checkAllowedRelationAdd()

BxBaseModProfileModule::checkAllowedRelationAdd	(	&	$aDataEntry,
			$isPerformAction = false
	)

Returns

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

checkAllowedRelationRemove()

BxBaseModProfileModule::checkAllowedRelationRemove	(	&	$aDataEntry,
			$isPerformAction = false
	)

Returns

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

checkAllowedSubscribeAdd()

BxBaseModProfileModule::checkAllowedSubscribeAdd	(	&	$aDataEntry,
			$isPerformAction = false
	)

Returns

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

checkAllowedSubscribeRemove()

BxBaseModProfileModule::checkAllowedSubscribeRemove	(	&	$aDataEntry,
			$isPerformAction = false
	)

Returns

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

checkAllowedView()

BxBaseModProfileModule::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.

checkAllowedViewCoverImage()

BxBaseModProfileModule::checkAllowedViewCoverImage	(		$aDataEntry,
			$isPerformAction = false
	)

Returns

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

checkAllowedViewMoreMenu()

BxBaseModProfileModule::checkAllowedViewMoreMenu	(	&	$aDataEntry,
			$isPerformAction = false
	)

Returns

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

checkAllowedViewProfileImage()

BxBaseModProfileModule::checkAllowedViewProfileImage	(		$aDataEntry,
			$isPerformAction = false
	)

Returns

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

serviceBrowseActiveProfiles()

BxBaseModProfileModule::serviceBrowseActiveProfiles	(		$sUnitView = false,
			$bEmptyMessage = false,
			$bAjaxPaginate = false
	)

browse_active_profiles

serviceBrowseByAcl()

BxBaseModProfileModule::serviceBrowseByAcl	(		$mixedLevelId,
			$iDesignBox = BX_DB_PADDING_DEF
	)

browse_by_acl

serviceBrowseFamiliarProfiles()

BxBaseModProfileModule::serviceBrowseFamiliarProfiles	(		$sConnection = '',
			$sUnitView = false,
			$bEmptyMessage = false,
			$bAjaxPaginate = false
	)

browse_familiar_profiles

serviceBrowseOnlineProfiles()

BxBaseModProfileModule::serviceBrowseOnlineProfiles	(		$bDisplayEmptyMsg = false,
			$bAjaxPaginate = false
	)

browse_online_profiles

serviceBrowseRecentProfiles()

BxBaseModProfileModule::serviceBrowseRecentProfiles	(		$bDisplayEmptyMsg = false,
			$bAjaxPaginate = true
	)

browse_recent_profiles

serviceBrowseRecommended()

BxBaseModProfileModule::serviceBrowseRecommended	(		$sUnitView = false,
			$bEmptyMessage = false,
			$bAjaxPaginate = true
	)

browse_recommended

serviceBrowseTopProfiles()

BxBaseModProfileModule::serviceBrowseTopProfiles	(		$bDisplayEmptyMsg = false,
			$bAjaxPaginate = false
	)

browse_top_profiles

serviceCheckAllowedContactForProfile()

BxBaseModProfileModule::serviceCheckAllowedContactForProfile	(		$aDataEntry,
			$isPerformAction = false,
			$iProfileId = false
	)

Check if profile can be contacted.

NOTE. This service should be used if it's needed to pass some specific values in $isPerformAction and $iProfileId parameters, otherwise it's recommended to use BxBaseModProfileModule::serviceCheckAllowedProfileContact service method or BxDolProfile::checkAllowedProfileContact method.

Parameters

type	$aDataEntry	- entry which the action will be performed for
type	$isPerformAction	- perform or just check the action
type	$iProfileId	- performer's profile ID

Returns

integer - one of CHECK_ACTION_RESULT_XXX constants.

serviceCheckAllowedModuleActionInProfile()

BxBaseModProfileModule::serviceCheckAllowedModuleActionInProfile	(		$iContentId,
			$sPostModule,
			$sActionName
	)

See also

iBxDolProfileService::serviceCheckAllowedModuleActionInProfile

Implements iBxDolProfileService.

serviceCheckAllowedPostForProfile()

BxBaseModProfileModule::serviceCheckAllowedPostForProfile	(		$aDataEntry,
			$isPerformAction = false,
			$iProfileId = false
	)

Check if posting (comment, post in Timeline) is available.

NOTE. This service should be used if it's needed to pass some specific values in $isPerformAction and $iProfileId parameters, otherwise it's recommended to use BxBaseModProfileModule::serviceCheckAllowedPostInProfile service method or BxDolProfile::checkAllowedPostInProfile method.

Parameters

type	$aDataEntry	- entry which the action will be performed for
type	$isPerformAction	- perform or just check the action
type	$iProfileId	- performer's profile ID

Returns

integer - one of CHECK_ACTION_RESULT_XXX constants.

serviceCheckAllowedPostInProfile()

BxBaseModProfileModule::serviceCheckAllowedPostInProfile	(		$iContentId,
			$sPostModule = ''
	)

See also

iBxDolProfileService::serviceCheckAllowedPostInProfile

Implements iBxDolProfileService.

serviceCheckAllowedProfileContact()

BxBaseModProfileModule::serviceCheckAllowedProfileContact

(

$iContentId

)

See also

iBxDolProfileService::serviceCheckAllowedProfileContact

Implements iBxDolProfileService.

serviceCheckAllowedProfileView()

BxBaseModProfileModule::serviceCheckAllowedProfileView

(

$iContentId

)

See also

iBxDolProfileService::serviceCheckAllowedProfileView

Implements iBxDolProfileService.

serviceCheckAllowedViewForProfile()

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

Check if the profile can be viewed.

NOTE. This service should be used if it's needed to pass some specific values in $isPerformAction and $iProfileId parameters, otherwise it's recommended to use BxBaseModProfileModule::serviceCheckAllowedProfileView service method or BxDolProfile::checkAllowedProfileView method.

Parameters

type	$aDataEntry	- entry which the action will be performed for
type	$isPerformAction	- perform or just check the action
type	$iProfileId	- performer's profile ID

Returns

integer - one of CHECK_ACTION_RESULT_XXX constants.

serviceCheckSpacePrivacy()

BxBaseModProfileModule::serviceCheckSpacePrivacy

(

$iContentId

)

See also

iBxDolProfileService::serviceCheckSpacePrivacy

Implements iBxDolProfileService.

serviceDeleteEntityService()

BxBaseModProfileModule::serviceDeleteEntityService	(		$iContentId,
			$bDeleteWithContent = false
	)

For internal usage only.

serviceEntityCalendar()

BxBaseModProfileModule::serviceEntityCalendar	(		$iContentId = 0,
			$sTemplate = 'calendar.html'
	)

entity_calendar

serviceEntityCommentsByProfile()

BxBaseModProfileModule::serviceEntityCommentsByProfile

(

$iProfileId

)

Entry comments

serviceEntityCover()

BxBaseModProfileModule::serviceEntityCover	(		$iContentId = 0,
			$aParams = []
	)

entity_cover

serviceEntityCreate()

BxBaseModProfileModule::serviceEntityCreate

(

$sDisplay = false

)

entity_create

serviceEntitySocialSharing()

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

Entry social sharing block

serviceGetMembers()

BxBaseModProfileModule::serviceGetMembers	(		$sMode = 'active',
			$iStart = 0,
			$iPerPage = 10
	)

Returns list of members by mode with limited number of records for React Jot

Parameters

string	$sMode
int	$iStart
int	$iPerPage

Returns

mixed

serviceGetNotificationsData()

BxBaseModProfileModule::serviceGetNotificationsData

(

)

Data for Notifications module

serviceGetNotificationsTimelinePostCommon()

BxBaseModProfileModule::serviceGetNotificationsTimelinePostCommon

(

$aEvent

)

Notification about new member requst in the group

serviceGetParticipatingProfiles()

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

See also

iBxDolProfileService::serviceGetParticipatingProfiles

Implements iBxDolProfileService.

serviceGetSpaceTitle()

BxBaseModProfileModule::serviceGetSpaceTitle

(

)

See also

iBxDolProfileService::serviceGetSpaceTitle

Implements iBxDolProfileService.

serviceGetTimelineData()

BxBaseModProfileModule::serviceGetTimelineData

(

)

Data for Timeline module

serviceGetTimelineProfilePicture()

BxBaseModProfileModule::serviceGetTimelineProfilePicture	(		$aEvent,
			$aBrowseParams = []
	)

Entry post for Timeline module

serviceIsEnableProfileActivationLetter()

BxBaseModProfileModule::serviceIsEnableProfileActivationLetter

(

)

check enabled profile activation letter

servicePrepareFields()

BxBaseModProfileModule::servicePrepareFields

(

$aFieldsProfile

)

Prepare fields from some universal set of fields to fields in particular profile module. By default only 'name' and 'description' fields are supported. After fields convertion it can be used in

See also

BxBaseModGeneralModule::serviceEntityAdd

Parameters

$aFieldsProfile

fields in soem universal format.

Returns

array which is ready to use for particular module

Implements iBxDolProfileService.

serviceProfileUnitSafe()

BxBaseModProfileModule::serviceProfileUnitSafe	(		$iContentId,
			$aParams = array()
	)

profile_unit_safe

serviceProfileUrl()

BxBaseModProfileModule::serviceProfileUrl

(

$iContentId

)

profile_url

Implements iBxDolProfileService.

---

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

• modules/base/profile/classes/BxBaseModProfileModule.php