BxPersonsModule Class Reference

Inheritance diagram for BxPersonsModule:

Public Member Functions
	__construct (&$aModule)
	servicePrepareFields ($aFieldsProfile)
	serviceGetSearchOptions ($sField, $sFieldType, $sSearchType)
	getSubtypes ()
	getProfileName ($aContentInfo)
Public Member Functions inherited from BxBaseModProfileModule
	actionDeleteProfileImg ($iFileId, $iContentId, $sFieldPicture)
	actionProfileCalendarData ()
	actionEmbed ($iContentId, $sUnitTemplate='', $sAddCode='')
	serviceGetSafeServices ()
	serviceGetOptionsRedirectAfterAdd ()
	serviceGetOptionsActivation ()
	serviceGetThumb ($iContentId, $sTranscoder='')
	serviceGetCover ($iContentId, $sTranscoder='')
	serviceGetSearchResultUnit ($iContentId, $sUnitTemplate='')
	serviceGetSearchableFieldsExtended ($aInputsAdd=array())
	serviceEntityCalendar ($iContentId=0, $sTemplate='calendar.html')
	servicePrivateProfileMsg ()
	serviceGetContentInfoById ($iContentId)
	serviceGetContentInfoByProfileId ($iProfileId)
	serviceGetMenuAddonManageTools ()
	serviceGetMenuAddonManageToolsProfileStats ($iProfileId=0)
	serviceGetMenuAddonFavoritesProfileStats ()
	serviceGetSubmenuObject ()
	serviceGetMenuSetNameForMenuTrigger ($sMenuTriggerName)
	serviceGetSnippetMenuVars ($iProfileId, $bPublic=null, $aParams=[])
	serviceGetPageObjectForPageTrigger ($sPageTriggerName)
	serviceProfilesSearch ($sTerm, $iLimit)
	serviceProfileUnitSafe ($iContentId, $aParams=array())
	serviceProfileUnit ($iContentId, $aParams=[])
	serviceProfileUnitApi ($iContentId, $aParams=[])
	serviceHasImage ($iContentId)
	serviceProfilePicture ($iContentId)
	serviceProfileAvatar ($iContentId)
	serviceProfileAvatarBig ($iContentId)
	serviceProfileCover ($iContentId)
	serviceProfileUnitCover ($iContentId)
	serviceProfileEditUrl ($iContentId)
	serviceProfileThumb ($iContentId)
	serviceProfileIcon ($iContentId)
	serviceProfileName ($iContentId)
	serviceProfileSettings ($iContentId)
	serviceProfileSettingsSet ($iContentId, $oValue)
	serviceProfileCreateUrl ($bAbsolute=true)
	serviceProfileUrl ($iContentId)
	serviceGetSpaceTitle ()
	serviceGetParticipatingProfiles ($iProfileId, $aConnectionObjects=false)
	serviceFormsHelper ()
	serviceEntityCreate ($sDisplay=false)
	serviceActAsProfile ()
	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)
	serviceBrowseConnections ($iProfileId, $sObjectConnections='sys_profiles_friends', $sConnectionsType='content', $iMutual=false, $iDesignBox=BX_DB_PADDING_DEF, $iProfileId2=0)
	serviceBrowseRelationsQuick ($iProfileId, $sObjectConnections='sys_profiles_friends', $sConnectionsType='content', $iMutual=false, $iProfileId2=0)
	serviceBrowseConnectionsQuick ($iProfileId, $sObjectConnections='sys_profiles_friends', $sConnectionsType='content', $iMutual=false, $iProfileId2=0)
	serviceBrowseConnectionsByType ($aParamsCnn, $aParamsBrs=array())
	serviceBrowseByAcl ($mixedLevelId, $iDesignBox=BX_DB_PADDING_DEF)
	serviceEntityEditCover ($iContentId=0)
	serviceEntityCover ($iContentId=0, $aParams=[])
	serviceEntityCommentsByProfile ($iProfileId)
	serviceEntitySocialSharing ($mixedContent=false, $aParams=array())
	serviceProfileMembership ($iContentId=0)
	serviceProfileFriends ($iContentId=0)
	serviceProfileFriendsMutual ($iContentId=0)
	serviceProfileSubscriptions ($iContentId=0, $aParams=array())
	serviceProfileSubscribedMe ($iContentId=0)
	serviceProfileRelations ($iContentId=0, $aParams=array())
	serviceProfileRelatedMe ($iContentId=0)
	serviceIsEnableProfileActivationLetter ()
	serviceIsEnableRelations ()
	serviceDeleteEntityService ($iContentId, $bDeleteWithContent=false)
	serviceGetNotificationsData ()
	serviceGetNotificationsPost ($aEvent)
	serviceGetNotificationsVote ($aEvent)
	serviceGetNotificationsTimelinePostCommon ($aEvent)
	serviceGetTimelineData ()
	serviceGetTimelineProfilePicture ($aEvent, $aBrowseParams=[])
	serviceGetTimelineProfilePictureAllowedView ($aEvent)
	serviceGetTimelineProfileCover ($aEvent, $aBrowseParams=[])
	serviceGetTimelineProfileCoverAllowedView ($aEvent)
	serviceGetMenuItemTitleByConnection ($sConnection, $sAction, $iContentProfileId, $iInitiatorProfileId=0)
	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)
	serviceSetViewProfileCover ($oPage, $aProfileInfo)
	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)
	checkAllowedRelationsView (&$aDataEntry, $isPerformAction=false)
	checkAllowedSubscribeAdd (&$aDataEntry, $isPerformAction=false)
	_modProfileCheckAllowedSubscribeAdd (&$aDataEntry, $isPerformAction=false)
	checkAllowedSubscribeRemove (&$aDataEntry, $isPerformAction=false)
	checkAllowedSubscriptionsView (&$aDataEntry, $isPerformAction=false)
	checkMyself ($iContentId)
	isAllowDeleteOrDisable ($iActorProfileId, $iTargetProfileId)
	getProfileObject ($iContentId)
	onUpdateImage ($iContentId, $sFiledName, $sFiledValue, $iProfileId=0)
	alertAfterAdd ($aContentInfo)
	alertAfterEdit ($aContentInfo)
	getProfileByCurrentUrl ()
	getEntryImageData ($aContentInfo, $sField='FIELD_PICTURE', $aTranscoders=array())
	getMenuItemTitleByConnection ($sConnection, $sAction, $iContentProfileId, $iInitiatorProfileId=0)
	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 ()
	actionGetCreatePostForm ()
	actionGetNotes ()
	actionNested ()
	subactionDelete ()
	actionAjaxGetProfiles ()
	serviceGetProfiles ($sParams)
	actionGetBrowsingFilters ()
	actionApplyBrowsingFilters ()
	serviceIsBadgesAvaliable ()
	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)
	serviceGetAll ($aParams=array())
	serviceGetAllByAuthor ($iProfileId)
	serviceGetSortableFieldsExtended ($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')
	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())
	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)
	serviceDeleteEntity ($iContentId, $sFuncDelete='deleteData')
	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)
	serviceGetNotificationsPostPendingApproval ($aEvent)
	serviceGetNotificationsPostApproved ($aEvent)
	serviceGetNotificationsPostPublishFailed ($aEvent)
	serviceGetNotificationsPostPublishSucceeded ($aEvent)
	serviceGetNotificationsComment ($aEvent)
	serviceGetNotificationsReply ($aEvent)
	serviceGetNotificationsReaction ($aEvent)
	serviceGetNotificationsScoreUp ($aEvent)
	serviceGetNotificationsScoreDown ($aEvent)
	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)
	checkAllowedSetThumb ($iContentId=0)
	checkAllowedBrowse ()
	checkAllowedViewForProfile ($aDataEntry, $iProfileId, $isPerformAction=false)
	checkAllowedApprove ($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)
	alertAfterApprove ($aContentInfo)
	processMetasAdd ($iContentId)
	processMetasEdit ($iContentId, $oForm)
	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=[])
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)
	serviceGetAll ($aParams=array())
	serviceGetSearchResultExtended ($aParams, $iStart=0, $iPerPage=0, $bFilterMode=false)
Public Member Functions inherited from iBxDolProfileService
	serviceProfileUnit ($iContentId)

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 Member Functions inherited from BxBaseModProfileModule
	_servicePrepareFields ($aFieldsProfile, $aFieldsDefault, $aMap)
	_serviceCheckAllowedContactForProfile ($aDataEntry, $isPerformAction=false, $iProfileId=false)
	_alertParams ($aContentInfo)
	_getMenuItemTitleProfilesFriends ($sAction, $iContentProfileId, $iInitiatorProfileId, &$oConnection)
	_getMenuItemTitleProfilesSubscriptions ($sAction, $iContentProfileId, $iInitiatorProfileId, &$oConnection)
	_checkAllowedConnect (&$aDataEntry, $isPerformAction, $mixedConnection, $isMutual, $isInvertResult, $isSwap=false)
	_buildRssParams ($sMode, $aArgs)
	_serviceGetTimelineProfileImage ($aEvent, $aBrowseParams, $aBuildParams)
	_serviceGetTimelineProfileImageAllowedView ($aEvent)
	_getContentForTimelineProfileImage ($aEvent, $aBrowseParams, $aBuildParams, $aContentInfo, $aFileInfo)
	_entityComments ($sObject, $iId=0)
	_getContent ($iContentId=0, $sFuncGetContent='getContentInfoById')
Protected Member Functions inherited from BxBaseModGeneralModule
	_prepareBrowsingFiltersParamsGet ($mParams=false)
	_serviceGetNotificationsScore ($sType, $aEvent)
	_serviceCheckAllowedViewForProfile ($aDataEntry, $isPerformAction, $iProfileId)
	_serviceBrowseQuick ($aProfiles, $iStart=0, $iLimit=4, $aAdditionalParams=array())
	_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')
	_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())
	_getFields ($iContentId)
	_getFieldValue ($sField, $iContentId)
	_getFieldValueThumb ($sField, $iContentId, $sTranscoder='')
	_prepareResponse ($aResponse, $bAsJson=false, $aAdditional=array())
Protected Attributes inherited from BxBaseModProfileModule
	$_iAccountId
Protected Attributes inherited from BxBaseModGeneralModule
	$_bIsApi
	$_iProfileId
	$_aSearchableNamesExcept
	$_aFormParams
	$_aBrowsingFiltersKeys

Detailed Description

Person profiles module.

Constructor & Destructor Documentation

__construct()

BxPersonsModule::__construct

(

&

$aModule

)

Reimplemented from BxBaseModProfileModule.

Member Function Documentation

getProfileName()

BxPersonsModule::getProfileName

(

$aContentInfo

)

Reimplemented from BxBaseModProfileModule.

serviceGetSearchOptions()

BxPersonsModule::serviceGetSearchOptions	(		$sField,
			$sFieldType,
			$sSearchType )

get_search_options

servicePrepareFields()

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

Hooks:

'{module_name}', 'prepare_fields' - hook to override prepared profile fields

• $unit_name - module name
• $action - equals prepare_fields
• $object_id - not used
• $sender_id - not used
• $extra_params - array of additional params with the following array keys:
  • fields_orig - [array] original fields array as key&value pairs
  • fields_result - [array] by ref, resulting fields array as key&value pairs, can be overridden in hook processing

    HOOKS

    '{module_name}', 'prepare_fields' - hook to override prepared profile fields

Reimplemented from BxBaseModProfileModule.

---

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

• modules/boonex/persons/classes/BxPersonsModule.php