BxBaseModGeneralModule Class Reference

Inheritance diagram for BxBaseModGeneralModule:

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

Protected Member Functions
	_serviceBrowseQuick ($aProfiles, $iStart=0, $iLimit=4, $aAdditionalParams=array())
	_alertParams ($aContentInfo)

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

Detailed Description

Base module class.

Member Function Documentation

_alertParams()

BxBaseModGeneralModule::_alertParams (   $aContentInfo )

protected

Get array of params to be passed in Add/Edit Alert.

_serviceBrowseQuick()

BxBaseModGeneralModule::_serviceBrowseQuick (   $aProfiles,   $iStart = 0,   $iLimit = 4,   $aAdditionalParams = array()  )

protected

Shows a list of profiles.

actionAjaxGetProfiles()

BxBaseModGeneralModule::actionAjaxGetProfiles

(

)

Get possible recipients for start conversation form

checkAllowedAdd()

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

checkAllowedApprove()

BxBaseModGeneralModule::checkAllowedApprove	(		$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.

checkAllowedBrowse()

BxBaseModGeneralModule::checkAllowedBrowse

(

)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking.

checkAllowedCommentsPost()

BxBaseModGeneralModule::checkAllowedCommentsPost	(		$aContentInfo,
			$isPerformAction = false
	)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking.

checkAllowedCommentsView()

BxBaseModGeneralModule::checkAllowedCommentsView	(		$aContentInfo,
			$isPerformAction = false
	)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make "true === " checking.

checkAllowedDelete()

BxBaseModGeneralModule::checkAllowedDelete	(	&	$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.

checkAllowedDeleteAnyEntry()

BxBaseModGeneralModule::checkAllowedDeleteAnyEntry

(

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

checkAllowedDeleteAnyEntryForProfile()

BxBaseModGeneralModule::checkAllowedDeleteAnyEntryForProfile	(		$isPerformAction = false,
			$iProfileId = false
	)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

checkAllowedEdit()

BxBaseModGeneralModule::checkAllowedEdit	(		$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.

checkAllowedEditAnyEntry()

BxBaseModGeneralModule::checkAllowedEditAnyEntry

(

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

checkAllowedEditAnyEntryForProfile()

BxBaseModGeneralModule::checkAllowedEditAnyEntryForProfile	(		$isPerformAction = false,
			$iProfileId = false
	)

Returns

CHECK_ACTION_RESULT_ALLOWED if access is granted or error message if access is forbidden. So make sure to make strict(===) checking.

checkAllowedSetMembership()

BxBaseModGeneralModule::checkAllowedSetMembership	(	&	$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.

checkAllowedView()

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

checkAllowedViewForProfile()

BxBaseModGeneralModule::checkAllowedViewForProfile	(		$aDataEntry,
			$iProfileId,
			$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.

serviceBrowse()

BxBaseModGeneralModule::serviceBrowse

(

$aParams = array()

)

browse

serviceBrowseCategory()

BxBaseModGeneralModule::serviceBrowseCategory	(		$sUnitView = false,
			$bEmptyMessage = true,
			$bAjaxPaginate = true,
			$aParams = []
	)

browse_by_category

serviceBrowseContext()

BxBaseModGeneralModule::serviceBrowseContext	(		$iProfileId = 0,
			$aParams = array()
	)

Display entries posted into particular context

Returns

HTML string

serviceBrowseFavorite()

BxBaseModGeneralModule::serviceBrowseFavorite	(		$iProfileId = 0,
			$aParams = array()
	)

browse_favorite

serviceBrowseFavoriteLists()

BxBaseModGeneralModule::serviceBrowseFavoriteLists	(		$iProfileId = 0,
			$aParams = array()
	)

browse_favorite_lists

serviceBrowseFeatured()

BxBaseModGeneralModule::serviceBrowseFeatured	(		$sUnitView = false,
			$bEmptyMessage = false,
			$bAjaxPaginate = true
	)

browse_featured

serviceCategoriesMultiList()

BxBaseModGeneralModule::serviceCategoriesMultiList

(

$bDisplayEmptyCats = true

)

categories_multi_list

serviceCheckAllowed()

BxBaseModGeneralModule::serviceCheckAllowed	(		$sAction,
			$isPerformAction = false
	)

Check particular action permission without content

Parameters

$sAction	action to check, for example: Browse, Add
$iContentId	content ID

Returns

message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed

serviceCheckAllowedViewForProfile()

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

======

PERMISSION METHODS

serviceCheckAllowedWithContent()

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

Check particular action permission with content

Parameters

$sAction	action to check, for example: View, Edit
$iContentId	content ID

Returns

message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed

serviceCheckAllowedWithContentForProfile()

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

Check particular action permission with content for specified profile

Parameters

$sAction	action to check, for example: View, Edit
$iContentId	content ID
$iProfileId	profile ID which the permissions to be cheked for

Returns

message on error, or CHECK_ACTION_RESULT_ALLOWED when allowed

serviceDeleteEntity()

BxBaseModGeneralModule::serviceDeleteEntity	(		$iContentId,
			$sFuncDelete = 'deleteData'
	)

Delete content entry

Parameters

$iContentId

content id

Returns

error message or empty string on success

serviceEntityActions()

BxBaseModGeneralModule::serviceEntityActions

(

$iContentId = 0

)

entity_actions

serviceEntityAdd()

BxBaseModGeneralModule::serviceEntityAdd	(		$iProfile,
			$aValues,
			$sDisplay = false
	)

Add entry using provided fields' values.

Returns

array with result: 'code' is 0 on success or non-zero on error, 'message' is error message in case of error, 'content' is content info array in case of success

serviceEntityAllActions()

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

entity_all_actions

serviceEntityAttachments()

BxBaseModGeneralModule::serviceEntityAttachments

(

$iContentId = 0

)

entity_attachments

serviceEntityComments()

BxBaseModGeneralModule::serviceEntityComments

(

$iContentId = 0

)

entity_comments

serviceEntityContext()

BxBaseModGeneralModule::serviceEntityContext

(

$iContentId = 0

)

Entry context block

serviceEntityCreate()

BxBaseModGeneralModule::serviceEntityCreate

(

$sParams = false

)

Create entry form

Returns

HTML string

serviceEntityDelete()

BxBaseModGeneralModule::serviceEntityDelete

(

$iContentId = 0

)

entity_delete

serviceEntityEdit()

BxBaseModGeneralModule::serviceEntityEdit	(		$iContentId = 0,
			$sDisplay = false
	)

entity_edit

serviceEntityInfo()

BxBaseModGeneralModule::serviceEntityInfo	(		$iContentId = 0,
			$sDisplay = false
	)

entity_info

serviceEntityInfoExtended()

BxBaseModGeneralModule::serviceEntityInfoExtended

(

$iContentId = 0

)

entity_info_extended

serviceEntityInfoFull()

BxBaseModGeneralModule::serviceEntityInfoFull

(

$iContentId = 0

)

entity_info_full

serviceEntityLocation()

BxBaseModGeneralModule::serviceEntityLocation

(

$iContentId = 0

)

entity_location

serviceEntityReports()

BxBaseModGeneralModule::serviceEntityReports

(

$iContentId = 0

)

entity_reports

serviceEntitySocialSharing()

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

entity_social_sharing

serviceEntityTextBlock()

BxBaseModGeneralModule::serviceEntityTextBlock

(

$iContentId = 0

)

entity_text_block

serviceFavoritesListActions()

BxBaseModGeneralModule::serviceFavoritesListActions

(

)

browse_favorite_list_actions

serviceFavoritesListInfo()

BxBaseModGeneralModule::serviceFavoritesListInfo

(

$aParams = array()

)

favorites_list_info

serviceGetCreatePostForm()

BxBaseModGeneralModule::serviceGetCreatePostForm

(

$aParams = []

)

get_create_post_form

serviceGetLablesTree()

BxBaseModGeneralModule::serviceGetLablesTree

(

)

Blocks for lables tree browsing

serviceGetLink()

BxBaseModGeneralModule::serviceGetLink

(

$iContentId

)

get_link

serviceGetNotificationsComment()

BxBaseModGeneralModule::serviceGetNotificationsComment

(

$aEvent

)

Entry post comment for Notifications module

serviceGetNotificationsData()

BxBaseModGeneralModule::serviceGetNotificationsData

(

)

Data for Notifications module

serviceGetNotificationsPost()

BxBaseModGeneralModule::serviceGetNotificationsPost

(

$aEvent

)

Entry post for Notifications module

serviceGetNotificationsPostPendingApproval()

BxBaseModGeneralModule::serviceGetNotificationsPostPendingApproval

(

$aEvent

)

Unset Entry Author because the notification is addressed to 'admins'.

serviceGetNotificationsReaction()

BxBaseModGeneralModule::serviceGetNotificationsReaction

(

$aEvent

)

Entry post vote for Notifications module

serviceGetNotificationsReply()

BxBaseModGeneralModule::serviceGetNotificationsReply

(

$aEvent

)

Entry post reply for Notifications module

serviceGetNotificationsScoreDown()

BxBaseModGeneralModule::serviceGetNotificationsScoreDown

(

$aEvent

)

Entry post score -> vote up for Notifications module

serviceGetNotificationsScoreUp()

BxBaseModGeneralModule::serviceGetNotificationsScoreUp

(

$aEvent

)

Entry post score -> vote up for Notifications module

serviceGetNotificationsVote()

BxBaseModGeneralModule::serviceGetNotificationsVote

(

$aEvent

)

Entry post vote for Notifications module

serviceGetObjectForm()

BxBaseModGeneralModule::serviceGetObjectForm	(		$sType,
			$aParams = array()
	)

Get form object for add, edit, view or delete the content

Parameters

$sType	'add', 'edit', 'view' or 'delete'
$aParams	optional array with parameters(display name, etc)

Returns

form object or false on error

serviceGetSearchResultUnit()

BxBaseModGeneralModule::serviceGetSearchResultUnit	(		$iContentId,
			$sUnitTemplate = ''
	)

get_search_result_unit

serviceGetTimelineData()

BxBaseModGeneralModule::serviceGetTimelineData

(

)

Data for Timeline module

serviceGetTimelinePost()

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

Entry post for Timeline module

Don't show anonymous posts on the post's owner timeline.

serviceModuleIcon()

BxBaseModGeneralModule::serviceModuleIcon

(

)

module_icon

serviceMyEntriesActions()

BxBaseModGeneralModule::serviceMyEntriesActions

(

$iProfileId = 0

)

my_entries_actions

serviceRedirectAfterAdd()

BxBaseModGeneralModule::serviceRedirectAfterAdd

(

$aContentInfo

)

Perform redirect after content creation

Returns

nothing, rediret header is sent

serviceReportsCountByStatus()

BxBaseModGeneralModule::serviceReportsCountByStatus

(

$iStatus

)

entity_reports

---

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

• modules/base/general/classes/BxBaseModGeneralModule.php