Inheritance diagram for ilRBACAccessHandler:

Collaboration diagram for ilRBACAccessHandler:

Public Member Functions
	storeAccessResult ($a_permission, $a_cmd, $a_ref_id, $a_access_granted, $a_user_id=null, $a_info="")
	store access result More...

	setPreventCachingLastResult ($a_val)
	Set prevent caching last result. More...

	getPreventCachingLastResult ()
	Get prevent caching last result. More...

	getStoredAccessResult ($a_permission, $a_cmd, $a_ref_id, $a_user_id="")
	get stored access result More...

	storeCache ()

	readCache ($a_secs=0)

	getResults ()

	setResults ($a_results)

	addInfoItem ($a_type, $a_text, $a_data="")
	add an info item to current info object More...

	checkAccess ($a_permission, $a_cmd, $a_ref_id, $a_type="", $a_obj_id=null, $a_tree_id=null)
	check access for an object (provide $a_type and $a_obj_id if available for better performance) More...

	checkAccessOfUser ($a_user_id, $a_permission, $a_cmd, $a_ref_id, $a_type="", $a_obj_id=null, $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 ($a_ref_id="")

	doCacheCheck ($a_permission, $a_cmd, $a_ref_id, $a_user_id)
	look if result for current query is already in cache More...

	doTreeCheck ($a_permission, $a_cmd, $a_ref_id, $a_user_id)
	check if object is in tree and not deleted More...

	doRBACCheck ($a_permission, $a_cmd, $a_ref_id, $a_user_id, $a_type)
	rbac check for current object -> type should be used for create permission More...

	doPathCheck ($a_permission, $a_cmd, $a_ref_id, $a_user_id, $a_all=false)
	check read permission for all parents More...

	doActivationCheck ($a_permission, $a_cmd, $a_ref_id, $a_user_id, $a_obj_id, $a_type)
	check for activation and centralized offline status. More...

	doConditionCheck ($a_permission, $a_cmd, $a_ref_id, $a_user_id, $a_obj_id, $a_type)
	condition check (currently only implemented for read permission) More...

	doStatusCheck ($a_permission, $a_cmd, $a_ref_id, $a_user_id, $a_obj_id, $a_type)
	object type specific check More...

	clear ()

	enable ($a_str, $a_bool)

Detailed Description

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

Version: $Id$

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

Member Function Documentation

◆ addInfoItem()

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

add an info item to current info object

Implemented in ilAccess.

◆ checkAccess()

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

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

Parameters

string	$a_permission
string	$a_cmd
int	$a_ref_id
string	$a_type	(optional)
int	$a_obj_id	(optional)
int	$a_tree_id	(optional)

Implemented in ilAccess.

◆ checkAccessOfUser()

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

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

Parameters

integer	$a_user_id
string	$a_permission
string	$a_cmd
int	$a_ref_id
string	$a_type	(optional)
int	$a_obj_id	(optional)
int	$a_tree_id	(optional)

Implemented in ilAccess.

◆ clear()

ilRBACAccessHandler::clear ( )

Implemented in ilAccess.

◆ doActivationCheck()

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

check for activation and centralized offline status.

Parameters

string	$a_permission
string	$a_cmd
int	$a_ref_id
int	$a_user_id
int	$a_obj_id
string	$a_type

Returns: bool

Referenced by ilAccess\checkAccessOfUser().

Here is the caller graph for this function:

◆ doCacheCheck()

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

look if result for current query is already in cache

Parameters

string	$a_permission
string	$a_cmd
int	$a_ref_id
int	$a_user_id

Returns: bool

Implemented in ilAccess.

◆ doConditionCheck()

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

condition check (currently only implemented for read permission)

Parameters

string	$a_permission
string	$a_cmd
int	$a_ref_id
int	$a_user_id
int	$a_obj_id
string	$a_type

Returns: bool

Implemented in ilAccess.

◆ doPathCheck()

ilRBACAccessHandler::doPathCheck	(	$a_permission,
		$a_cmd,
		$a_ref_id,
		$a_user_id,
		$a_all = `false`
	)

check read permission for all parents

Parameters

string	$a_permission
string	$a_cmd
int	$a_ref_id
int	$a_user_id
bool	$a_all

Returns: bool

Implemented in ilAccess.

◆ doRBACCheck()

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

rbac check for current object -> type should be used for create permission

Parameters

string	$a_permission
string	$a_cmd
int	$a_ref_id
int	$a_user_id
string	$a_type

Returns: bool

Implemented in ilAccess.

◆ doStatusCheck()

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

object type specific check

Parameters

string	$a_permission
string	$a_cmd
int	$a_ref_id
int	$a_user_id
int	$a_obj_id
string	$a_type

Returns: bool

Implemented in ilAccess.

◆ doTreeCheck()

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

check if object is in tree and not deleted

Parameters

string	$a_permission
string	$a_cmd
int	$a_ref_id
int	$a_user_id

Returns: bool

Implemented in ilAccess.

◆ enable()

ilRBACAccessHandler::enable	(	$a_str,
		$a_bool
	)

Parameters

$a_str
$a_bool

Implemented in ilAccess.

◆ getInfo()

ilRBACAccessHandler::getInfo ( )

get last info object

Implemented in ilAccess.

◆ getPreventCachingLastResult()

ilRBACAccessHandler::getPreventCachingLastResult ( )

Get prevent caching last result.

Returns: boolean true if last result should not be cached

Implemented in ilAccess.

◆ getResultAll()

ilRBACAccessHandler::getResultAll ( $a_ref_id = "" )

Implemented in ilAccess.

◆ getResultLast()

ilRBACAccessHandler::getResultLast ( )

get last info object

Implemented in ilAccess.

◆ getResults()

ilRBACAccessHandler::getResults ( )

Implemented in ilAccess.

◆ getStoredAccessResult()

ilRBACAccessHandler::getStoredAccessResult	(	$a_permission,
		$a_cmd,
		$a_ref_id,
		$a_user_id = `""`
	)

get stored access result

@access private

Parameters

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

Returns: array result array: "granted" (boolean) => true if access is granted "info" (object) => info object

Implemented in ilAccess.

◆ readCache()

ilRBACAccessHandler::readCache ( $a_secs = 0 )

Implemented in ilAccess.

◆ setPreventCachingLastResult()

ilRBACAccessHandler::setPreventCachingLastResult ( $a_val )

Set prevent caching last result.

Parameters

boolean true if last result should not be cached

Implemented in ilAccess.

◆ setResults()

ilRBACAccessHandler::setResults ( $a_results )

Implemented in ilAccess.

◆ storeAccessResult()

ilRBACAccessHandler::storeAccessResult	(	$a_permission,
		$a_cmd,
		$a_ref_id,
		$a_access_granted,
		$a_user_id = `null`,
		$a_info = `""`
	)

store access result

@access private

Parameters

string	$a_permission	permission
string	$a_cmd	command string
int	$a_ref_id	reference id
boolean	$a_access_granted	true if access is granted
int	$a_user_id	user id (if no id passed, current user id)

Implemented in ilAccess.

◆ storeCache()

ilRBACAccessHandler::storeCache ( )

Implemented in ilAccess.

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

Services/AccessControl/interfaces/interface.ilRBACAccessHandler.php

Public Member Functions

Detailed Description

Member Function Documentation

◆ addInfoItem()

◆ checkAccess()

◆ checkAccessOfUser()

◆ clear()

◆ doActivationCheck()

◆ doCacheCheck()

◆ doConditionCheck()

◆ doPathCheck()

◆ doRBACCheck()

◆ doStatusCheck()

◆ doTreeCheck()

◆ enable()

◆ getInfo()

◆ getPreventCachingLastResult()

◆ getResultAll()

◆ getResultLast()

◆ getResults()

◆ getStoredAccessResult()

◆ readCache()

◆ setPreventCachingLastResult()

◆ setResults()

◆ storeAccessResult()

◆ storeCache()