UNA
iBxDolProfileService Interface Reference
Inheritance diagram for iBxDolProfileService:
BxBaseModProfileModule BxBaseServices BxBaseModGroupsModule BxPersonsModule BxTemplServices BxCnlModule BxCoursesModule BxEventsModule BxGroupsModule BxOrgsModule BxSpacesModule

Public Member Functions

 serviceCheckAllowedProfileView ($iContentId)
 
 serviceCheckAllowedProfileContact ($iContentId)
 
 serviceCheckAllowedPostInProfile ($iContentId, $sPostModule='')
 
 serviceCheckAllowedModuleActionInProfile ($iContentId, $sModule, $sActionName)
 
 serviceGetParticipatingProfiles ($iProfileId, $aConnectionObject=false)
 
 serviceGetSpaceTitle ()
 
 serviceCheckSpacePrivacy ($iContentId)
 

Detailed Description

Profile services module interface, module class must implement basic profile services to be compliant with Profile interface

Member Function Documentation

◆ serviceCheckAllowedModuleActionInProfile()

iBxDolProfileService::serviceCheckAllowedModuleActionInProfile (   $iContentId,
  $sModule,
  $sActionName 
)

Check if a certain type of action in a content module in profile is allowed, for example deleting timeline's posts inside a context

Parameters
$iContentIdcontent ID
$sPostModuletype of content to be posted
Returns
message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed

Implemented in BxBaseModProfileModule, and BxBaseServices.

◆ serviceCheckAllowedPostInProfile()

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

Check if posting of a certain type of content in profile is allowed, for example posting in profile's timeline

Parameters
$iContentIdcontent ID
$sPostModuletype of content to be posted
Returns
message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed

Implemented in BxBaseModProfileModule, and BxBaseServices.

◆ serviceCheckAllowedProfileContact()

iBxDolProfileService::serviceCheckAllowedProfileContact (   $iContentId)

Check if profile can be contacted

Parameters
$iContentIdcontent ID
Returns
message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed

Implemented in BxBaseModProfileModule, and BxBaseServices.

◆ serviceCheckAllowedProfileView()

iBxDolProfileService::serviceCheckAllowedProfileView (   $iContentId)

Check profile visibility

Parameters
$iContentIdcontent ID
Returns
message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed

Implemented in BxBaseModProfileModule, and BxBaseServices.

◆ serviceCheckSpacePrivacy()

iBxDolProfileService::serviceCheckSpacePrivacy (   $iContentId)

Check space privacy, when some profile is used for privacy checking of some content

Parameters
$iContentIdcontent ID
Returns
message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed

Implemented in BxBaseModProfileModule, and BxBaseServices.

◆ serviceGetParticipatingProfiles()

iBxDolProfileService::serviceGetParticipatingProfiles (   $iProfileId,
  $aConnectionObject = false 
)

Get profiles, current profile have relation with, like friends, joined groups and events

Parameters
$iProfileIdprofile to get relations for
$aConnectionObjectlook for relations in these connection objects
Returns
array

Implemented in BxBaseServices, BxBaseModProfileModule, BxBaseModGroupsModule, and BxOrgsModule.

◆ serviceGetSpaceTitle()

iBxDolProfileService::serviceGetSpaceTitle ( )

Get space title

Returns
string

Implemented in BxBaseServices, BxBaseModProfileModule, BxBaseModGroupsModule, and BxOrgsModule.


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