ilRBACAccessHandler Interface Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilRBACAccessHandler:

Collaboration diagram for ilRBACAccessHandler:

Public Member Functions
	storeAccessResult (string $a_permission, string $a_cmd, int $a_ref_id, bool $a_access_granted, ?int $a_user_id=null, ?ilAccessInfo $a_info=null)
	store access result More...
	getStoredAccessResult (string $a_permission, string $a_cmd, int $a_ref_id, ?int $a_user_id=null)
	get stored access result More...
	setPreventCachingLastResult (bool $a_val)
	Set prevent caching last result. More...
	getPreventCachingLastResult ()
	Get prevent caching last result. More...
	getResults ()
	setResults (array $a_results)
	addInfoItem (string $a_type, string $a_text, string $a_data="")
	add an info item to current info object More...
	checkAccess (string $a_permission, string $a_cmd, int $a_ref_id, string $a_type="", ?int $a_obj_id=null, ?int $a_tree_id=null)
	check access for an object (provide $a_type and $a_obj_id if available for better performance) More...
	checkAccessOfUser (int $a_user_id, string $a_permission, string $a_cmd, int $a_ref_id, string $a_type="", ?int $a_obj_id=null, ?int $a_tree_id=null)
	check access for an object (provide $a_type and $a_obj_id if available for better performance) More...
	getInfo ()
	get last info object More...
	getResultLast ()
	get last info object More...
	getResultAll (int $a_ref_id=0)
	doCacheCheck (string $a_permission, string $a_cmd, int $a_ref_id, int $a_user_id)
	look if result for current query is already in cache More...
	doTreeCheck (string $a_permission, string $a_cmd, int $a_ref_id, int $a_user_id)
	check if object is in tree and not deleted More...
	doRBACCheck (string $a_permission, string $a_cmd, int $a_ref_id, int $a_user_id, string $a_type)
	rbac check for current object -> type is used for create permission More...
	doPathCheck (string $a_permission, string $a_cmd, int $a_ref_id, int $a_user_id, bool $a_all=false)
	check read permission for all parents More...
	doActivationCheck (string $a_permission, string $a_cmd, int $a_ref_id, int $a_user_id, int $a_obj_id, string $a_type)
	check for activation and centralized offline status. More...
	doConditionCheck (string $a_permission, string $a_cmd, int $a_ref_id, int $a_user_id, int $a_obj_id, string $a_type)
	condition check (currently only implemented for read permission) More...
	doStatusCheck (string $a_permission, string $a_cmd, int $a_ref_id, int $a_user_id, int $a_obj_id, string $a_type)
	object type specific check More...
	clear ()
	enable (string $a_str, bool $a_bool)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Interface ilRBACAccessHandler Checks access for ILIAS objects

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de

Definition at line 28 of file interface.ilRBACAccessHandler.php.

Member Function Documentation

addInfoItem()

ilRBACAccessHandler::addInfoItem	(	string	$a_type,
		string	$a_text,
		string	$a_data = ""
	)

add an info item to current info object

Implemented in ilAccess.

Referenced by ilObjFileBasedLMAccess\_checkAccess(), and ilObjContentObjectAccess\_checkAccess().

Here is the caller graph for this function:

checkAccess()

ilRBACAccessHandler::checkAccess	(	string	$a_permission,
		string	$a_cmd,
		int	$a_ref_id,
		string	$a_type = "",
		?int	$a_obj_id = null,
		?int	$a_tree_id = null
	)

check access for an object (provide $a_type and $a_obj_id if available for better performance)

Implemented in ilAccess.

Referenced by ilObjStudyProgrammeReferenceGUI\_goto(), ilObjCourseReferenceGUI\_goto(), ilObjCmiXapiGUI\_goto(), ilObjDataCollectionGUI\_goto(), ilObjIndividualAssessmentGUI\_goto(), ilObjFileBasedLMGUI\_goto(), ilObjLTIConsumerGUI\_goto(), ilExportOptions\addOptions(), ilBlockGUI\addRepoCommands(), ilCalendarPresentationGUI\addStandardTabs(), ilObjectListGUI\checkCommandAccess(), ilObjPortfolioTemplateGUI\createFromTemplate(), ilBlockGUI\getHTML(), ilRecommendedContentManager\getOpenRecommendationsOfUser(), ilCopySelfAssQuestionTableGUI\getQuestions(), ilPCSection\handleAccess(), ilBadgeManagementGUI\hasWrite(), ilObjBookingPoolGUI\initHeaderAction(), ilObjRepositorySettingsGUI\initSettingsForm(), ilPCFileItemFileSelectorGUI\isNodeClickable(), ilContainerSelectionExplorer\isVisible(), ilMediaCreationGUI\listPoolItems(), ilContainerReferenceGUI\loadPropertiesFromSettingsForm(), and ilObjBlogGUI\setSettingsSubTabs().

Here is the caller graph for this function:

checkAccessOfUser()

ilRBACAccessHandler::checkAccessOfUser	(	int	$a_user_id,
		string	$a_permission,
		string	$a_cmd,
		int	$a_ref_id,
		string	$a_type = "",
		?int	$a_obj_id = null,
		?int	$a_tree_id = null
	)

check access for an object (provide $a_type and $a_obj_id if available for better performance)

Implemented in ilAccess.

Referenced by ilExAssignmentTeamTableGUI\__construct(), ilObjSurvey\addAppraisee(), ilObjSurvey\addRater(), ilExAssTypeWikiTeamGUI\createWiki(), ilExcRepoObjAssignmentAccessInfo\getInfo(), ilLearningHistoryTimelineItem\render(), ilObjSurvey\sent360Reminders(), and ilObjSessionGUI\unregisterObject().

Here is the caller graph for this function:

clear()

ilRBACAccessHandler::clear

(

)

Implemented in ilAccess.

Referenced by ilObjSessionGUI\unregisterObject().

Here is the caller graph for this function:

doActivationCheck()

ilRBACAccessHandler::doActivationCheck	(	string	$a_permission,
		string	$a_cmd,
		int	$a_ref_id,
		int	$a_user_id,
		int	$a_obj_id,
		string	$a_type
	)

check for activation and centralized offline status.

Implemented in ilAccess.

Referenced by ilStartUpGUI\processIndexPHP().

Here is the caller graph for this function:

doCacheCheck()

ilRBACAccessHandler::doCacheCheck	(	string	$a_permission,
		string	$a_cmd,
		int	$a_ref_id,
		int	$a_user_id
	)

look if result for current query is already in cache

Returns

array<{hit: bool, granted: bool, prevent_db_cache: bool}>

Implemented in ilAccess.

doConditionCheck()

ilRBACAccessHandler::doConditionCheck	(	string	$a_permission,
		string	$a_cmd,
		int	$a_ref_id,
		int	$a_user_id,
		int	$a_obj_id,
		string	$a_type
	)

condition check (currently only implemented for read permission)

Implemented in ilAccess.

doPathCheck()

ilRBACAccessHandler::doPathCheck	(	string	$a_permission,
		string	$a_cmd,
		int	$a_ref_id,
		int	$a_user_id,
		bool	$a_all = false
	)

check read permission for all parents

Implemented in ilAccess.

doRBACCheck()

ilRBACAccessHandler::doRBACCheck	(	string	$a_permission,
		string	$a_cmd,
		int	$a_ref_id,
		int	$a_user_id,
		string	$a_type
	)

rbac check for current object -> type is used for create permission

Implemented in ilAccess.

doStatusCheck()

ilRBACAccessHandler::doStatusCheck	(	string	$a_permission,
		string	$a_cmd,
		int	$a_ref_id,
		int	$a_user_id,
		int	$a_obj_id,
		string	$a_type
	)

object type specific check

Implemented in ilAccess.

Referenced by ilStartUpGUI\processIndexPHP().

Here is the caller graph for this function:

doTreeCheck()

ilRBACAccessHandler::doTreeCheck	(	string	$a_permission,
		string	$a_cmd,
		int	$a_ref_id,
		int	$a_user_id
	)

check if object is in tree and not deleted

Implemented in ilAccess.

enable()

ilRBACAccessHandler::enable	(	string	$a_str,
		bool	$a_bool
	)

Implemented in ilAccess.

getInfo()

ilRBACAccessHandler::getInfo

(

)

get last info object

See also

ilAccessInfo::getInfoItems()

Implemented in ilAccess.

getPreventCachingLastResult()

ilRBACAccessHandler::getPreventCachingLastResult

(

)

Get prevent caching last result.

Implemented in ilAccess.

getResultAll()

ilRBACAccessHandler::getResultAll

(

int

$a_ref_id = 0

)

Implemented in ilAccess.

getResultLast()

ilRBACAccessHandler::getResultLast

(

)

get last info object

Implemented in ilAccess.

getResults()

ilRBACAccessHandler::getResults

(

)

Implemented in ilAccess.

getStoredAccessResult()

ilRBACAccessHandler::getStoredAccessResult	(	string	$a_permission,
		string	$a_cmd,
		int	$a_ref_id,
		?int	$a_user_id = null
	)

get stored access result

Parameters

string	$a_permission	permission
string	$a_cmd	command string
int	$a_ref_id	reference id
int | null	$a_user_id	user id (if no id passed, current user id)

Returns

array<{granted: bool, info: ?ilAccessInfo, prevent_db_cache: bool}>

Implemented in ilAccess.

setPreventCachingLastResult()

ilRBACAccessHandler::setPreventCachingLastResult

(

bool

$a_val

)

Set prevent caching last result.

Implemented in ilAccess.

setResults()

ilRBACAccessHandler::setResults

(

array

$a_results

)

Implemented in ilAccess.

storeAccessResult()

ilRBACAccessHandler::storeAccessResult	(	string	$a_permission,
		string	$a_cmd,
		int	$a_ref_id,
		bool	$a_access_granted,
		?int	$a_user_id = null,
		?ilAccessInfo	$a_info = null
	)

store access result

Implemented in ilAccess.

---

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

• components/ILIAS/AccessControl/interfaces/interface.ilRBACAccessHandler.php