ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilAccess Class Reference

Class ilAccessHandler Checks access for ILIAS objects. More...

+ Inheritance diagram for ilAccess:
+ Collaboration diagram for ilAccess:

Public Member Functions

 __construct ()
 
 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...
 
 setPreventCachingLastResult (bool $a_val)
 Set prevent caching last result. More...
 
 getPreventCachingLastResult ()
 Get prevent caching last result. More...
 
 getStoredAccessResult (string $a_permission, string $a_cmd, int $a_ref_id, ?int $a_user_id=null)
 get stored access result
Parameters
string$a_permissionpermission
string$a_cmdcommand string
int$a_ref_idreference id
int | null$a_user_iduser id (if no id passed, current user id)
Returns
array<{granted: bool, info: ?ilAccessInfo, prevent_db_cache: bool}>
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=0, ?int $a_tree_id=0)
 check access for an object (provide $a_type and $a_obj_id if available for better performance) More...
 
 getInfo ()
 get last info object
See also
ilAccessInfo::getInfoItems()
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
Returns
array<{hit: bool, granted: bool, prevent_db_cache: bool}>
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)
 @deprected More...
 
 filterUserIdsForCurrentUsersPositionsAndPermission (array $user_ids, string $permission)
 
Parameters
int[]$user_idsList of ILIAS-User-IDs which shall be filtered
string$permission
Returns
int[] Filtered List of ILIAS-User-IDs
Exceptions

ilOrgUnitAccessException when a unknown permission is used. See the list of available permissions in interface ilOrgUnitPositionAccessHandler

See also
getAvailablePositionRelatedPermissions for available permissions
More...
 
 filterUserIdsForUsersPositionsAndPermission (array $user_ids, int $for_user_id, string $permission)
 
Parameters
int[]$user_idsList of ILIAS-User-IDs which shall be filtered
int$for_user_id
string$permission
Returns
int[] Filtered List of ILIAS-User-IDs
Exceptions

ilOrgUnitAccessException when a unknown permission is used. See the list of available permissions in interface ilOrgUnitPositionAccessHandler

See also
getAvailablePositionRelatedPermissions for available permissions
More...
 
 isCurrentUserBasedOnPositionsAllowedTo (string $permission, array $on_user_ids)
 
Parameters
string$permission
int[]$on_user_idsList of ILIAS-User-IDs
Returns
bool
See also
getAvailablePositionRelatedPermissions for available permissions
More...
 
 isUserBasedOnPositionsAllowedTo (int $which_user_id, string $permission, array $on_user_ids)
 
Parameters
int$which_user_idPermission check for this ILIAS-User-ID
string$permission
int[]$on_user_idsList of ILIAS-User-IDs
Returns
bool
See also
getAvailablePositionRelatedPermissions for available permissions
More...
 
 checkPositionAccess (string $pos_perm, int $ref_id)
 
Parameters
string$pos_perm
int$ref_idReference-ID of the desired Object in the tree
Returns
bool
See also
getAvailablePositionRelatedPermissions for available permissions
More...
 
 checkRbacOrPositionPermissionAccess (string $rbac_perm, string $pos_perm, int $ref_id)
 
Parameters
string$rbac_perm
string$pos_permSee the list of available permissions in interface ilOrgUnitPositionAccessHandler
int$ref_idReference-ID of the desired Object in the tree
Returns
bool
More...
 
 filterUserIdsByPositionOfCurrentUser (string $pos_perm, int $ref_id, array $user_ids)
 
Parameters
string$pos_perm
int$ref_id
int[]$user_ids
Returns
int[]
See also
getAvailablePositionRelatedPermissions for available permissions
More...
 
 filterUserIdsByPositionOfUser (int $user_id, string $pos_perm, int $ref_id, array $user_ids)
 
Parameters
int$user_id
string$pos_perm
int$ref_id
int[]$user_ids
Returns
int[]
See also
getAvailablePositionRelatedPermissions for available permissions
More...
 
 filterUserIdsByRbacOrPositionOfCurrentUser (string $rbac_perm, string $pos_perm, int $ref_id, array $user_ids)
 
Parameters
string$rbac_perm
string$pos_permSee the list of available permissions in interface ilOrgUnitPositionAccessHandler
int$ref_idReference-ID of the desired Object in the tree
int[]$user_ids
Returns
int[]
More...
 
 hasCurrentUserAnyPositionAccess (int $ref_id)
 
Parameters
int$ref_id
Returns
bool
More...
 
 hasUserRBACorAnyPositionAccess (string $rbac_perm, int $ref_id)
 
 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)
 @deprected More...
 
 filterUserIdsForCurrentUsersPositionsAndPermission (array $user_ids, string $permission)
 
 filterUserIdsForUsersPositionsAndPermission (array $user_ids, int $for_user_id, string $permission)
 
 isCurrentUserBasedOnPositionsAllowedTo (string $permission, array $on_user_ids)
 
 isUserBasedOnPositionsAllowedTo (int $which_user_id, string $permission, array $on_user_ids)
 
 checkPositionAccess (string $pos_perm, int $ref_id)
 
 hasCurrentUserAnyPositionAccess (int $ref_id)
 
 filterUserIdsByPositionOfCurrentUser (string $pos_perm, int $ref_id, array $user_ids)
 
 filterUserIdsByPositionOfUser (int $user_id, string $pos_perm, int $ref_id, array $user_ids)
 
 checkRbacOrPositionPermissionAccess (string $rbac_perm, string $pos_perm, int $ref_id)
 
 filterUserIdsByRbacOrPositionOfCurrentUser (string $rbac_perm, string $pos_perm, int $ref_id, array $user_ids)
 
 hasUserRBACorAnyPositionAccess (string $rbac_perm, int $ref_id)
 

Protected Attributes

ilOrgUnitPositionAccess $ilOrgUnitPositionAccess
 
array $obj_tree_cache
 
array $obj_type_cache
 
array $obj_id_cache
 
array $ac_cache
 
bool $status
 
bool $path
 
bool $condition
 
bool $tree
 
bool $rbac
 
bool $cache
 
ilAccessInfo $current_info
 
ilAccessInfo $last_info = null
 
array $results = []
 
array $last_result = []
 
array $stored_rbac_access = []
 
array $current_result_element = []
 
ilRbacSystem $rbacsystem
 
ilObjUser $user
 
ilLogger $ac_logger
 
ilDBInterface $db
 
ilTree $repositoryTree
 
ilObjectDefinition $objDefinition
 
ilLanguage $language = null
 

Private Member Functions

 getLanguage ()
 

Private Attributes

const MAX_CACHE_SIZE = 1000
 
bool $prevent_caching_last_result = false
 

Detailed Description

Class ilAccessHandler 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 27 of file class.ilAccess.php.

Constructor & Destructor Documentation

◆ __construct()

ilAccess::__construct ( )

Definition at line 62 of file class.ilAccess.php.

63 {
64 global $DIC;
65
66 $this->user = $DIC->user();
67 $this->db = $DIC->database();
68 $this->rbacsystem = $DIC['rbacsystem'];
69 $this->results = [];
70 $this->current_info = new ilAccessInfo();
71 $this->repositoryTree = $DIC->repositoryTree();
72 $this->objDefinition = $DIC['objDefinition'];
73
74 // use function enable to switch on/off tests (only cache is used so far)
75 $this->cache = true;
76 $this->rbac = true;
77 $this->tree = true;
78 $this->condition = true;
79 $this->path = true;
80 $this->status = true;
81 $this->obj_id_cache = [];
82 $this->obj_type_cache = [];
83 $this->obj_tree_cache = [];
84 $this->ac_cache = [];
85
87
88 $this->ac_logger = ilLoggerFactory::getLogger('ac');
89 }
class ilAccessInfo
static getLogger(string $a_component_id)
Get component logger.
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
global $DIC
Definition: shib_login.php:26

References $DIC, ilLoggerFactory\getLogger(), ILIAS\Repository\rbac(), ILIAS\Repository\repositoryTree(), and ILIAS\Repository\user().

+ Here is the call graph for this function:

Member Function Documentation

◆ addInfoItem()

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

add an info item to current info object

Implements ilRBACAccessHandler.

Definition at line 185 of file class.ilAccess.php.

185 : void
186 {
187 $this->current_info->addInfoItem($a_type, $a_text, $a_data);
188 }

Referenced by ilObjRemoteCourseAccess\_checkAccess().

+ Here is the caller graph for this function:

◆ checkAccess()

ilAccess::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)

Implements ilRBACAccessHandler.

Definition at line 193 of file class.ilAccess.php.

200 : bool {
201 return $this->checkAccessOfUser(
202 $this->user->getId(),
203 $a_permission,
204 $a_cmd,
205 $a_ref_id,
206 $a_type,
207 $a_obj_id,
208 $a_tree_id
209 );
210 }
checkAccessOfUser(int $a_user_id, string $a_permission, string $a_cmd, int $a_ref_id, string $a_type="", ?int $a_obj_id=0, ?int $a_tree_id=0)
check access for an object (provide $a_type and $a_obj_id if available for better performance)

Referenced by ilOrgUnitSimpleImportGUI\__construct(), ilLDAPSettingsGUI\addRoleAssignmentCmd(), ilLDAPSettingsGUI\checkAccess(), ilObjOrgUnitGUI\editAdvancedSettings(), ilObjOrgUnitGUI\editSettings(), ilObjOrgUnitGUI\executeCommand(), ilSessionClassificationPathGUI\findSessionContainerForItem(), ilLDAPSettingsGUI\saveRoleSelectionCmd(), ilObjOrgUnitGUI\setContentSubTabs(), ilObjOrgUnitGUI\updateAdvancedSettings(), ilLDAPSettingsGUI\updateRoleAssignmentCmd(), and ilObjOrgUnitGUI\updateSettings().

+ Here is the caller graph for this function:

◆ checkAccessOfUser()

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

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

Implements ilRBACAccessHandler.

Definition at line 215 of file class.ilAccess.php.

223 : bool {
224 global $DIC;
225
226 $ilBench = $DIC['ilBench'];
227
228 $this->setPreventCachingLastResult(false); // for external db based caches
229
230 $ilBench->start("AccessControl", "0400_clear_info");
231 $this->current_info->clear();
232 $ilBench->stop("AccessControl", "0400_clear_info");
233
234 // get stored result (internal memory based cache)
235 $cached = $this->doCacheCheck($a_permission, $a_cmd, $a_ref_id, $a_user_id);
236 if ($cached["hit"]) {
237 // Store access result
238 if (!$cached["granted"]) {
239 $this->current_info->addInfoItem(ilAccessInfo::IL_NO_PERMISSION, $this->getLanguage()->txt("status_no_permission"));
240 }
241 if ($cached["prevent_db_cache"]) {
242 $this->setPreventCachingLastResult(true); // should have been saved in previous call already
243 }
244 return $cached["granted"];
245 }
246
247 $ilBench->start("AccessControl", "0500_lookup_id_and_type");
248 // get object id if not provided
249 if ($a_obj_id == 0) {
250 if (isset($this->obj_id_cache[$a_ref_id]) && $this->obj_id_cache[$a_ref_id] > 0) {
251 $a_obj_id = $this->obj_id_cache[$a_ref_id];
252 } else {
253 $a_obj_id = ilObject::_lookupObjId($a_ref_id);
254 $this->obj_id_cache[$a_ref_id] = $a_obj_id;
255 }
256 }
257 if ($a_type == "") {
258 if (isset($this->obj_type_cache[$a_ref_id]) && $this->obj_type_cache[$a_ref_id] != "") {
259 $a_type = $this->obj_type_cache[$a_ref_id];
260 } else {
261 $a_type = ilObject::_lookupType($a_ref_id, true);
262 $this->obj_type_cache[$a_ref_id] = $a_type;
263 }
264 }
265
266 $ilBench->stop("AccessControl", "0500_lookup_id_and_type");
267
268 // if supplied tree id is not = 1 (= repository main tree),
269 // check if object is in tree and not deleted
270 if ($a_tree_id != 1 &&
271 !$this->doTreeCheck($a_permission, $a_cmd, $a_ref_id, $a_user_id)) {
272 $this->current_info->addInfoItem(ilAccessInfo::IL_NO_PERMISSION, $this->getLanguage()->txt("status_no_permission"));
273 $this->storeAccessResult($a_permission, $a_cmd, $a_ref_id, false, $a_user_id);
274 return false;
275 }
276
277 // rbac check for current object
278 if (!$this->doRBACCheck($a_permission, $a_cmd, $a_ref_id, $a_user_id, $a_type)) {
279 $this->current_info->addInfoItem(ilAccessInfo::IL_NO_PERMISSION, $this->getLanguage()->txt("status_no_permission"));
280 $this->storeAccessResult($a_permission, $a_cmd, $a_ref_id, false, $a_user_id);
281 return false;
282 }
283
284 // Check object activation
285 $act_check = $this->doActivationCheck(
286 $a_permission,
287 $a_cmd,
288 $a_ref_id,
289 $a_user_id,
290 $a_obj_id,
291 $a_type
292 );
293
294 if (!$act_check) {
295 $this->current_info->addInfoItem(ilAccessInfo::IL_NO_PERMISSION, $this->getLanguage()->txt('status_no_permission'));
296 $this->storeAccessResult($a_permission, $a_cmd, $a_ref_id, false, $a_user_id);
297 return false;
298 }
299
300 // check read permission for all parents
301 $par_check = $this->doPathCheck($a_permission, $a_cmd, $a_ref_id, $a_user_id);
302 if (!$par_check) {
303 $this->current_info->addInfoItem(ilAccessInfo::IL_NO_PERMISSION, $this->getLanguage()->txt("status_no_permission"));
304 $this->storeAccessResult($a_permission, $a_cmd, $a_ref_id, false, $a_user_id);
305 return false;
306 }
307
308 // condition check (currently only implemented for read permission)
309 if (!$this->doConditionCheck($a_permission, $a_cmd, $a_ref_id, $a_user_id, $a_obj_id, $a_type)) {
310 $this->current_info->addInfoItem(ilAccessInfo::IL_NO_PERMISSION, $this->getLanguage()->txt("status_no_permission"));
311 $this->storeAccessResult($a_permission, $a_cmd, $a_ref_id, false, $a_user_id);
312 $this->setPreventCachingLastResult(true); // do not store this in db, since condition updates are not monitored
313 return false;
314 }
315
316 // object type specific check
317 if (!$this->doStatusCheck($a_permission, $a_cmd, $a_ref_id, $a_user_id, $a_obj_id, $a_type)) {
318 $this->current_info->addInfoItem(ilAccessInfo::IL_NO_PERMISSION, $this->getLanguage()->txt("status_no_permission"));
319 $this->storeAccessResult($a_permission, $a_cmd, $a_ref_id, false, $a_user_id);
320 $this->setPreventCachingLastResult(true); // do not store this in db, since status updates are not monitored
321 return false;
322 }
323
324 // all checks passed
325 $this->storeAccessResult($a_permission, $a_cmd, $a_ref_id, true, $a_user_id);
326 return true;
327 }
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
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
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)
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
doCacheCheck(string $a_permission, string $a_cmd, int $a_ref_id, int $a_user_id)
look if result for current query is already in cachearray<{hit: bool, granted: bool,...
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.
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
doTreeCheck(string $a_permission, string $a_cmd, int $a_ref_id, int $a_user_id)
check if object is in tree and not deleted
setPreventCachingLastResult(bool $a_val)
Set prevent caching last result.
static _lookupType(int $id, bool $reference=false)
static _lookupObjId(int $ref_id)

Referenced by ilSearchResult\filter(), and ilExerciseDerivedTaskProvider\getFirstRefIdWithPermission().

+ Here is the caller graph for this function:

◆ checkPositionAccess()

ilAccess::checkPositionAccess ( string  $pos_perm,
int  $ref_id 
)

Parameters
string$pos_perm
int$ref_idReference-ID of the desired Object in the tree
Returns
bool
See also
getAvailablePositionRelatedPermissions for available permissions

Implements ilOrgUnitPositionAccessHandler.

Definition at line 777 of file class.ilAccess.php.

777 : bool
778 {
779 return $this->ilOrgUnitPositionAccess->checkPositionAccess($pos_perm, $ref_id);
780 }
checkPositionAccess(string $pos_perm, int $ref_id)
$ref_id
Definition: ltiauth.php:66

References $ref_id, and ilOrgUnitPositionAccess\checkPositionAccess().

+ Here is the call graph for this function:

◆ checkRbacOrPositionPermissionAccess()

ilAccess::checkRbacOrPositionPermissionAccess ( string  $rbac_perm,
string  $pos_perm,
int  $ref_id 
)

Parameters
string$rbac_perm
string$pos_permSee the list of available permissions in interface ilOrgUnitPositionAccessHandler
int$ref_idReference-ID of the desired Object in the tree
Returns
bool

Implements ilOrgUnitPositionAndRBACAccessHandler.

Definition at line 785 of file class.ilAccess.php.

785 : bool
786 {
787 return $this->ilOrgUnitPositionAccess->checkRbacOrPositionPermissionAccess($rbac_perm, $pos_perm, $ref_id);
788 }
checkRbacOrPositionPermissionAccess(string $rbac_perm, string $pos_perm, int $ref_id)

References $ref_id, and ilOrgUnitPositionAccess\checkRbacOrPositionPermissionAccess().

+ Here is the call graph for this function:

◆ clear()

ilAccess::clear ( )

Implements ilRBACAccessHandler.

Definition at line 708 of file class.ilAccess.php.

708 : void
709 {
710 $this->results = [];
711 $this->last_result = [];
712 $this->current_info = new ilAccessInfo();
713 $this->stored_rbac_access = [];
714 }

◆ doActivationCheck()

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

Implements ilRBACAccessHandler.

Definition at line 512 of file class.ilAccess.php.

519 : bool {
520 $cache_perm = ($a_permission === "visible" || $a_permission === 'leave')
521 ? "visible"
522 : "other";
523
524 if (isset($this->ac_cache[$cache_perm][$a_ref_id][$a_user_id])) {
525 return $this->ac_cache[$cache_perm][$a_ref_id][$a_user_id];
526 }
527
528 // nothings needs to be done if current permission is write permission
529 if ($a_permission === 'write') {
530 return true;
531 }
532
533 // #10852 - member view check
534 if ($a_user_id === $this->user->getId()) {
535 // #10905 - activate parent container ONLY
537 if ($memview->isActiveForRefId($a_ref_id) &&
538 $memview->getContainer() == $a_ref_id) {
539 return true;
540 }
541 }
542
543 // in any case, if user has write permission return true.
544 // you may specify further exceptions in ilObj[TYPE]Access::getBypassActivationCheckForPermissions;
545 $class = $this->objDefinition->getClassName($a_type);
546 $full_class = "ilObj" . $class . "Access";
547
548 $bypass = method_exists($full_class, 'getBypassActivationCheckForPermissions') ?
549 $full_class::getBypassActivationCheckForPermissions() : ['write'];
550
551 foreach ($bypass as $permission) {
552 if ($this->checkAccessOfUser($a_user_id, $permission, "", $a_ref_id)) {
553 $this->ac_cache[$cache_perm][$a_ref_id][$a_user_id] = true;
554 return true;
555 }
556 }
557
558 // no write access/bypass => check centralized offline status
559 if (
560 $this->objDefinition->supportsOfflineHandling($a_type) &&
562 ) {
563 $this->ac_cache[$cache_perm][$a_ref_id][$a_user_id] = false;
564 return false;
565 }
566 $item_data = ilObjectActivation::getItem($a_ref_id);
567 // if activation isn't enabled
568 if ($item_data === null || (is_array($item_data) && count($item_data) == 0) ||
569 $item_data['timing_type'] != ilObjectActivation::TIMINGS_ACTIVATION) {
570 $this->ac_cache[$cache_perm][$a_ref_id][$a_user_id] = true;
571 return true;
572 }
573 // if within activation time
574 if (($item_data['timing_start'] == 0 || time() >= $item_data['timing_start']) and
575 ($item_data['timing_end'] == 0 || time() <= $item_data['timing_end'])) {
576 $this->ac_cache[$cache_perm][$a_ref_id][$a_user_id] = true;
577 return true;
578 }
579
580 // if user has write permission
581 if ($this->checkAccessOfUser($a_user_id, "write", "", $a_ref_id)) {
582 $this->ac_cache[$cache_perm][$a_ref_id][$a_user_id] = true;
583 return true;
584 }
585
586 // if current permission is visible or leave and visible is set in activation
587 if (($a_permission === 'visible' || $a_permission === 'leave')
588 && $item_data['visible']) {
589 $this->ac_cache[$cache_perm][$a_ref_id][$a_user_id] = true;
590 return true;
591 }
592
593 // learning progress must be readable, regardless of the activation
594 if ($a_permission == 'read_learning_progress') {
595 $this->ac_cache[$cache_perm][$a_ref_id][$a_user_id] = true;
596 return true;
597 }
598 // no access
599 $this->ac_cache[$cache_perm][$a_ref_id][$a_user_id] = false;
600 return false;
601 }
static getItem(int $ref_id)
static lookupOfflineStatus(int $obj_id)
Lookup offline status using objectDataCache.

◆ doCacheCheck()

ilAccess::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}>

Implements ilRBACAccessHandler.

Definition at line 360 of file class.ilAccess.php.

360 : array
361 {
362 $stored_access = $this->getStoredAccessResult($a_permission, $a_cmd, $a_ref_id, $a_user_id);
363
364 //var_dump($stored_access);
365 if ($stored_access !== []) {
366 if (isset($stored_access['info']) && $stored_access['info'] instanceof ilAccessInfo) {
367 $this->current_info = $stored_access["info"];
368 }
369 //var_dump("cache-treffer:");
370 return [
371 "hit" => true,
372 "granted" => $stored_access["granted"],
373 "prevent_db_cache" => $stored_access["prevent_db_cache"]
374 ];
375 }
376
377 // not in cache
378 return [
379 "hit" => false,
380 "granted" => false,
381 "prevent_db_cache" => false
382 ];
383 }
getStoredAccessResult(string $a_permission, string $a_cmd, int $a_ref_id, ?int $a_user_id=null)
get stored access resultarray<{granted: bool, info: ?ilAccessInfo, prevent_db_cache: bool}>

◆ doConditionCheck()

ilAccess::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)

Implements ilRBACAccessHandler.

Definition at line 606 of file class.ilAccess.php.

613 : bool {
614 if (
615 ($a_permission == 'visible') &&
616 !$this->checkAccessOfUser($a_user_id, "write", "", $a_ref_id, $a_type, $a_obj_id)
617 ) {
618 if (ilConditionHandler::lookupEffectiveHiddenStatusByTarget($a_ref_id)) {
619 if (!ilConditionHandler::_checkAllConditionsOfTarget($a_ref_id, $a_obj_id, $a_type, $a_user_id)) {
620 $conditions = ilConditionHandler::_getEffectiveConditionsOfTarget($a_ref_id, $a_obj_id, $a_type);
621 foreach ($conditions as $condition) {
622 $this->current_info->addInfoItem(
624 $this->getLanguage()->txt("missing_precondition") . ": " .
625 ilObject::_lookupTitle($condition["trigger_obj_id"]) . " " .
626 $this->getLanguage()->txt("condition_" . $condition["operator"]) . " " .
627 $condition["value"],
628 serialize($condition)
629 );
630 }
631 return false;
632 }
633 }
634 }
635
636 if (($a_permission == "read" or $a_permission == 'join') &&
637 !$this->checkAccessOfUser($a_user_id, "write", "", $a_ref_id, $a_type, $a_obj_id)) {
638 if (!ilConditionHandler::_checkAllConditionsOfTarget($a_ref_id, $a_obj_id, $a_type, $a_user_id)) {
639 $conditions = ilConditionHandler::_getEffectiveConditionsOfTarget($a_ref_id, $a_obj_id, $a_type);
640 foreach ($conditions as $condition) {
641 $this->current_info->addInfoItem(
643 $this->getLanguage()->txt("missing_precondition") . ": " .
644 ilObject::_lookupTitle($condition["trigger_obj_id"]) . " " .
645 $this->getLanguage()->txt("condition_" . $condition["operator"]) . " " .
646 $condition["value"],
647 serialize($condition)
648 );
649 }
650 return false;
651 }
652 }
653 return true;
654 }
const IL_MISSING_PRECONDITION
bool $condition
static _checkAllConditionsOfTarget(int $a_target_ref_id, int $a_target_id, string $a_target_type="", int $a_usr_id=0)
checks wether all conditions of a target object are fulfilled
static _lookupTitle(int $obj_id)

References ilConditionHandler\_checkAllConditionsOfTarget(), ilObject\_lookupTitle(), getLanguage(), and ilAccessInfo\IL_MISSING_PRECONDITION.

+ Here is the call graph for this function:

◆ doPathCheck()

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

Implements ilRBACAccessHandler.

Definition at line 482 of file class.ilAccess.php.

488 : bool {
489 $path = $this->repositoryTree->getPathId($a_ref_id);
490 foreach ($path as $id) {
491 if ($a_ref_id === $id) {
492 continue;
493 }
494 $access = $this->checkAccessOfUser($a_user_id, "read", "info", $id);
495 if ($access == false) {
496 $this->current_info->addInfoItem(
498 $this->getLanguage()->txt("no_parent_access"),
499 (string) $id
500 );
501 if ($a_all == false) {
502 return false;
503 }
504 }
505 }
506 return true;
507 }
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23

References $id, getLanguage(), and ilAccessInfo\IL_NO_PARENT_ACCESS.

+ Here is the call graph for this function:

◆ doRBACCheck()

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

Implements ilRBACAccessHandler.

Definition at line 439 of file class.ilAccess.php.

445 : bool {
446 if ($a_permission == "") {
447 $message = sprintf(
448 '%s::doRBACCheck(): No operations given! $a_ref_id: %s',
449 get_class($this),
450 $a_ref_id
451 );
452 $this->ac_logger->error($message);
454 }
455
456 if (isset($this->stored_rbac_access[$a_user_id . "-" . $a_permission . "-" . $a_ref_id])) {
457 $access = $this->stored_rbac_access[$a_user_id . "-" . $a_permission . "-" . $a_ref_id];
458 } else {
459 $access = $this->rbacsystem->checkAccessOfUser($a_user_id, $a_permission, $a_ref_id, $a_type);
460 if (!is_array($this->stored_rbac_access) || count($this->stored_rbac_access) < self::MAX_CACHE_SIZE) {
461 if ($a_permission != "create") {
462 $this->stored_rbac_access[$a_user_id . "-" . $a_permission . "-" . $a_ref_id] = $access;
463 }
464 }
465 }
466 // Store in result cache
467 if (!$access) {
468 $this->current_info->addInfoItem(
470 $this->getLanguage()->txt("status_no_permission")
471 );
472 }
473 if ($a_permission != "create") {
474 $this->storeAccessResult($a_permission, $a_cmd, $a_ref_id, true, $a_user_id);
475 }
476 return $access;
477 }
$message
Definition: xapiexit.php:31

References $message.

◆ doStatusCheck()

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

Implements ilRBACAccessHandler.

Definition at line 659 of file class.ilAccess.php.

666 : bool {
667 // check for a deactivated plugin
668 if ($this->objDefinition->isPluginTypeName($a_type) && !$this->objDefinition->isPlugin($a_type)) {
669 return false;
670 }
671 if (!$a_type) {
672 return false;
673 }
674
675 $class = $this->objDefinition->getClassName($a_type);
676 $location = $this->objDefinition->getLocation($a_type);
677 $full_class = "ilObj" . $class . "Access";
678
679 if ($class == "") {
680 $this->ac_logger->error("Cannot find class for object type $a_type, obj id $a_obj_id, ref id $a_ref_id. Abort status check.");
681 return false;
682 }
683
684 $full_class = new $full_class();
685
686 $obj_access = call_user_func(
687 [$full_class, "_checkAccess"],
688 $a_cmd,
689 $a_permission,
690 $a_ref_id,
691 $a_obj_id,
692 $a_user_id
693 );
694 if ($obj_access !== true) {
695 //Note: We must not add an info item here, because one is going
696 // to be added by the user function we just called a few
697 // lines above.
698 $this->storeAccessResult($a_permission, $a_cmd, $a_ref_id, false, $a_user_id);
699 return false;
700 }
701 $this->storeAccessResult($a_permission, $a_cmd, $a_ref_id, true, $a_user_id);
702 return true;
703 }
$location
Definition: buildRTE.php:22

◆ doTreeCheck()

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

check if object is in tree and not deleted

Implements ilRBACAccessHandler.

Definition at line 388 of file class.ilAccess.php.

388 : bool
389 {
390 // Get stored result
391 $tree_cache_key = $a_user_id . ':' . $a_ref_id;
392 if (array_key_exists($tree_cache_key, $this->obj_tree_cache)) {
393 // Store access result
394 if (!$this->obj_tree_cache[$tree_cache_key]) {
395 $this->current_info->addInfoItem(
397 $this->getLanguage()->txt("status_no_permission")
398 );
399 }
400 $this->storeAccessResult(
401 $a_permission,
402 $a_cmd,
403 $a_ref_id,
404 $this->obj_tree_cache[$tree_cache_key],
405 $a_user_id
406 );
407
408 return $this->obj_tree_cache[$tree_cache_key];
409 }
410
411 if (!$this->repositoryTree->isInTree($a_ref_id) || $this->repositoryTree->isDeleted($a_ref_id)) {
412 // Store negative access results
413 // Store in tree cache
414 // Note, we only store up to 1000 results to avoid memory overflow.
415 if (count($this->obj_tree_cache) < self::MAX_CACHE_SIZE) {
416 $this->obj_tree_cache[$tree_cache_key] = false;
417 }
418
419 // Store in result cache
420 $this->current_info->addInfoItem(ilAccessInfo::IL_DELETED, $this->getLanguage()->txt("object_deleted"));
421 $this->storeAccessResult($a_permission, $a_cmd, $a_ref_id, false, $a_user_id);
422 return false;
423 }
424
425 // Store positive access result.
426 // Store in tree cache
427 // Note, we only store up to 1000 results to avoid memory overflow.
428 if (count($this->obj_tree_cache) < self::MAX_CACHE_SIZE) {
429 $this->obj_tree_cache[$tree_cache_key] = true;
430 }
431 // Store in result cache
432 $this->storeAccessResult($a_permission, $a_cmd, $a_ref_id, true, $a_user_id);
433 return true;
434 }

References getLanguage(), ilAccessInfo\IL_DELETED, ilAccessInfo\IL_NO_PERMISSION, and ILIAS\Repository\repositoryTree().

+ Here is the call graph for this function:

◆ enable()

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

@deprected

Todo:
check for valid properties

Implements ilRBACAccessHandler.

Definition at line 720 of file class.ilAccess.php.

720 : void
721 {
722 $this->$a_str = $a_bool;
723 }

◆ filterUserIdsByPositionOfCurrentUser()

ilAccess::filterUserIdsByPositionOfCurrentUser ( string  $pos_perm,
int  $ref_id,
array  $user_ids 
)

Parameters
string$pos_perm
int$ref_id
int[]$user_ids
Returns
int[]
See also
getAvailablePositionRelatedPermissions for available permissions

Implements ilOrgUnitPositionAccessHandler.

Definition at line 793 of file class.ilAccess.php.

793 : array
794 {
795 return $this->ilOrgUnitPositionAccess->filterUserIdsByPositionOfCurrentUser($pos_perm, $ref_id, $user_ids);
796 }
filterUserIdsByPositionOfCurrentUser(string $pos_perm, int $ref_id, array $user_ids)

References $ref_id, and ilOrgUnitPositionAccess\filterUserIdsByPositionOfCurrentUser().

+ Here is the call graph for this function:

◆ filterUserIdsByPositionOfUser()

ilAccess::filterUserIdsByPositionOfUser ( int  $user_id,
string  $pos_perm,
int  $ref_id,
array  $user_ids 
)

Parameters
int$user_id
string$pos_perm
int$ref_id
int[]$user_ids
Returns
int[]
See also
getAvailablePositionRelatedPermissions for available permissions

Implements ilOrgUnitPositionAccessHandler.

Definition at line 801 of file class.ilAccess.php.

801 : array
802 {
803 return $this->ilOrgUnitPositionAccess->filterUserIdsByPositionOfUser($user_id, $pos_perm, $ref_id, $user_ids);
804 }
filterUserIdsByPositionOfUser(int $user_id, string $pos_perm, int $ref_id, array $user_ids)

References $ref_id, $user_id, and ilOrgUnitPositionAccess\filterUserIdsByPositionOfUser().

+ Here is the call graph for this function:

◆ filterUserIdsByRbacOrPositionOfCurrentUser()

ilAccess::filterUserIdsByRbacOrPositionOfCurrentUser ( string  $rbac_perm,
string  $pos_perm,
int  $ref_id,
array  $user_ids 
)

Parameters
string$rbac_perm
string$pos_permSee the list of available permissions in interface ilOrgUnitPositionAccessHandler
int$ref_idReference-ID of the desired Object in the tree
int[]$user_ids
Returns
int[]

Implements ilOrgUnitPositionAndRBACAccessHandler.

Definition at line 809 of file class.ilAccess.php.

809 : array
810 {
812 $rbac_perm,
813 $pos_perm,
814 $ref_id,
815 $user_ids
816 );
817 }
filterUserIdsByRbacOrPositionOfCurrentUser(string $rbac_perm, string $pos_perm, int $ref_id, array $user_ids)

References $ref_id, and ilOrgUnitPositionAccess\filterUserIdsByRbacOrPositionOfCurrentUser().

+ Here is the call graph for this function:

◆ filterUserIdsForCurrentUsersPositionsAndPermission()

ilAccess::filterUserIdsForCurrentUsersPositionsAndPermission ( array  $user_ids,
string  $permission 
)

Parameters
int[]$user_idsList of ILIAS-User-IDs which shall be filtered
string$permission
Returns
int[] Filtered List of ILIAS-User-IDs
Exceptions

ilOrgUnitAccessException when a unknown permission is used. See the list of available permissions in interface ilOrgUnitPositionAccessHandler

See also
getAvailablePositionRelatedPermissions for available permissions

Implements ilOrgUnitPositionAccessHandler.

Definition at line 734 of file class.ilAccess.php.

734 : array
735 {
737 $user_ids,
738 $permission
739 );
740 }
filterUserIdsForCurrentUsersPositionsAndPermission(array $user_ids, string $permission)

References ilOrgUnitPositionAccess\filterUserIdsForCurrentUsersPositionsAndPermission().

+ Here is the call graph for this function:

◆ filterUserIdsForUsersPositionsAndPermission()

ilAccess::filterUserIdsForUsersPositionsAndPermission ( array  $user_ids,
int  $for_user_id,
string  $permission 
)

Parameters
int[]$user_idsList of ILIAS-User-IDs which shall be filtered
int$for_user_id
string$permission
Returns
int[] Filtered List of ILIAS-User-IDs
Exceptions

ilOrgUnitAccessException when a unknown permission is used. See the list of available permissions in interface ilOrgUnitPositionAccessHandler

See also
getAvailablePositionRelatedPermissions for available permissions

Implements ilOrgUnitPositionAccessHandler.

Definition at line 745 of file class.ilAccess.php.

745 : array
746 {
748 $user_ids,
749 $for_user_id,
750 $permission
751 );
752 }
filterUserIdsForUsersPositionsAndPermission(array $user_ids, int $for_user_id, string $permission)

References ilOrgUnitPositionAccess\filterUserIdsForUsersPositionsAndPermission().

+ Here is the call graph for this function:

◆ getInfo()

ilAccess::getInfo ( )

get last info object

See also
ilAccessInfo::getInfoItems()

Implements ilRBACAccessHandler.

Definition at line 332 of file class.ilAccess.php.

332 : array
333 {
334 return is_object($this->last_info) ? $this->last_info->getInfoItems() : [];
335 }

◆ getLanguage()

ilAccess::getLanguage ( )
private

Definition at line 91 of file class.ilAccess.php.

92 {
93 if ($this->language === null) {
94 global $DIC;
95 $this->language = $DIC['lng'];
96 }
97
98 return $this->language;
99 }
ilLanguage $language
language handling

References $DIC, $language, and ILIAS\UI\examples\Symbol\Glyph\Language\language().

+ Here is the call graph for this function:

◆ getPreventCachingLastResult()

ilAccess::getPreventCachingLastResult ( )

Get prevent caching last result.

Implements ilRBACAccessHandler.

Definition at line 143 of file class.ilAccess.php.

143 : bool
144 {
146 }
bool $prevent_caching_last_result

◆ getResultAll()

ilAccess::getResultAll ( int  $a_ref_id = 0)

Implements ilRBACAccessHandler.

Definition at line 348 of file class.ilAccess.php.

348 : array
349 {
350 if ($a_ref_id == "") {
351 return $this->results;
352 }
353
354 return $this->results[$a_ref_id];
355 }
array $results

References $results.

◆ getResultLast()

ilAccess::getResultLast ( )

get last info object

Implements ilRBACAccessHandler.

Definition at line 340 of file class.ilAccess.php.

340 : array
341 {
342 return $this->last_result;
343 }
array $last_result

◆ getResults()

ilAccess::getResults ( )

Implements ilRBACAccessHandler.

Definition at line 169 of file class.ilAccess.php.

169 : array
170 {
171 return $this->results;
172 }

References $results.

◆ getStoredAccessResult()

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

get stored access result

Parameters
string$a_permissionpermission
string$a_cmdcommand string
int$a_ref_idreference id
int | null$a_user_iduser id (if no id passed, current user id)
Returns
array<{granted: bool, info: ?ilAccessInfo, prevent_db_cache: bool}>

Implements ilRBACAccessHandler.

Definition at line 151 of file class.ilAccess.php.

156 : array {
157 if ($a_user_id === null) {
158 $a_user_id = $this->user->getId();
159 }
160 if (isset($this->results[$a_ref_id][$a_permission][$a_cmd][$a_user_id])) {
161 return $this->results[$a_ref_id][$a_permission][$a_cmd][$a_user_id];
162 }
163 return [];
164 }

References ILIAS\Repository\user().

+ Here is the call graph for this function:

◆ hasCurrentUserAnyPositionAccess()

ilAccess::hasCurrentUserAnyPositionAccess ( int  $ref_id)

Parameters
int$ref_id
Returns
bool

Implements ilOrgUnitPositionAccessHandler.

Definition at line 822 of file class.ilAccess.php.

822 : bool
823 {
825 }

References $ref_id, and ilOrgUnitPositionAccess\hasCurrentUserAnyPositionAccess().

+ Here is the call graph for this function:

◆ hasUserRBACorAnyPositionAccess()

ilAccess::hasUserRBACorAnyPositionAccess ( string  $rbac_perm,
int  $ref_id 
)

Implements ilOrgUnitPositionAndRBACAccessHandler.

Definition at line 830 of file class.ilAccess.php.

830 : bool
831 {
833 }
hasUserRBACorAnyPositionAccess(string $rbac_perm, int $ref_id)

References $ref_id, and ilOrgUnitPositionAccess\hasUserRBACorAnyPositionAccess().

+ Here is the call graph for this function:

◆ isCurrentUserBasedOnPositionsAllowedTo()

ilAccess::isCurrentUserBasedOnPositionsAllowedTo ( string  $permission,
array  $on_user_ids 
)

Parameters
string$permission
int[]$on_user_idsList of ILIAS-User-IDs
Returns
bool
See also
getAvailablePositionRelatedPermissions for available permissions

Implements ilOrgUnitPositionAccessHandler.

Definition at line 757 of file class.ilAccess.php.

757 : bool
758 {
759 return $this->ilOrgUnitPositionAccess->isCurrentUserBasedOnPositionsAllowedTo($permission, $on_user_ids);
760 }
isCurrentUserBasedOnPositionsAllowedTo(string $permission, array $on_user_ids)

References ilOrgUnitPositionAccess\isCurrentUserBasedOnPositionsAllowedTo().

+ Here is the call graph for this function:

◆ isUserBasedOnPositionsAllowedTo()

ilAccess::isUserBasedOnPositionsAllowedTo ( int  $which_user_id,
string  $permission,
array  $on_user_ids 
)

Parameters
int$which_user_idPermission check for this ILIAS-User-ID
string$permission
int[]$on_user_idsList of ILIAS-User-IDs
Returns
bool
See also
getAvailablePositionRelatedPermissions for available permissions

Implements ilOrgUnitPositionAccessHandler.

Definition at line 765 of file class.ilAccess.php.

765 : bool
766 {
768 $which_user_id,
769 $permission,
770 $on_user_ids
771 );
772 }
isUserBasedOnPositionsAllowedTo(int $which_user_id, string $permission, array $on_user_ids)

References ilOrgUnitPositionAccess\isUserBasedOnPositionsAllowedTo().

+ Here is the call graph for this function:

◆ setPreventCachingLastResult()

ilAccess::setPreventCachingLastResult ( bool  $a_val)

Set prevent caching last result.

Implements ilRBACAccessHandler.

Definition at line 135 of file class.ilAccess.php.

135 : void
136 {
137 $this->prevent_caching_last_result = $a_val;
138 }

◆ setResults()

ilAccess::setResults ( array  $a_results)

Implements ilRBACAccessHandler.

Definition at line 177 of file class.ilAccess.php.

177 : void
178 {
179 $this->results = $a_results;
180 }

◆ storeAccessResult()

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

Implements ilRBACAccessHandler.

Definition at line 104 of file class.ilAccess.php.

111 : void {
112 if ($a_user_id === null) {
113 $a_user_id = $this->user->getId();
114 }
115 if ($a_info === null) {
116 $a_info = $this->current_info;
117 }
118 if ($this->cache) {
119 $this->results[$a_ref_id][$a_permission][$a_cmd][$a_user_id] = [
120 "granted" => $a_access_granted,
121 "info" => $a_info,
122 "prevent_db_cache" => $this->getPreventCachingLastResult()
123 ];
124 $this->current_result_element = [$a_access_granted, $a_ref_id, $a_permission, $a_cmd, $a_user_id];
125 $this->last_result = $this->results[$a_ref_id][$a_permission][$a_cmd][$a_user_id];
126 $this->last_info = $a_info;
127 }
128 // get new info object
129 $this->current_info = new ilAccessInfo();
130 }
getPreventCachingLastResult()
Get prevent caching last result.
ilAccessInfo $current_info

References ILIAS\Repository\user().

+ Here is the call graph for this function:

Field Documentation

◆ $ac_cache

array ilAccess::$ac_cache
protected

Definition at line 35 of file class.ilAccess.php.

◆ $ac_logger

ilLogger ilAccess::$ac_logger
protected

Definition at line 55 of file class.ilAccess.php.

◆ $cache

bool ilAccess::$cache
protected

Definition at line 42 of file class.ilAccess.php.

◆ $condition

bool ilAccess::$condition
protected

Definition at line 39 of file class.ilAccess.php.

◆ $current_info

ilAccessInfo ilAccess::$current_info
protected

Definition at line 46 of file class.ilAccess.php.

◆ $current_result_element

array ilAccess::$current_result_element = []
protected

Definition at line 51 of file class.ilAccess.php.

◆ $db

ilDBInterface ilAccess::$db
protected

Definition at line 56 of file class.ilAccess.php.

◆ $ilOrgUnitPositionAccess

ilOrgUnitPositionAccess ilAccess::$ilOrgUnitPositionAccess
protected

Definition at line 31 of file class.ilAccess.php.

◆ $language

ilLanguage ilAccess::$language = null
protected

Definition at line 60 of file class.ilAccess.php.

Referenced by getLanguage().

◆ $last_info

ilAccessInfo ilAccess::$last_info = null
protected

Definition at line 47 of file class.ilAccess.php.

◆ $last_result

array ilAccess::$last_result = []
protected

Definition at line 49 of file class.ilAccess.php.

◆ $obj_id_cache

array ilAccess::$obj_id_cache
protected

Definition at line 34 of file class.ilAccess.php.

◆ $obj_tree_cache

array ilAccess::$obj_tree_cache
protected

Definition at line 32 of file class.ilAccess.php.

◆ $obj_type_cache

array ilAccess::$obj_type_cache
protected

Definition at line 33 of file class.ilAccess.php.

◆ $objDefinition

ilObjectDefinition ilAccess::$objDefinition
protected

Definition at line 58 of file class.ilAccess.php.

◆ $path

bool ilAccess::$path
protected

Definition at line 38 of file class.ilAccess.php.

◆ $prevent_caching_last_result

bool ilAccess::$prevent_caching_last_result = false
private

Definition at line 44 of file class.ilAccess.php.

◆ $rbac

bool ilAccess::$rbac
protected

Definition at line 41 of file class.ilAccess.php.

◆ $rbacsystem

ilRbacSystem ilAccess::$rbacsystem
protected

Definition at line 53 of file class.ilAccess.php.

◆ $repositoryTree

ilTree ilAccess::$repositoryTree
protected

Definition at line 57 of file class.ilAccess.php.

◆ $results

array ilAccess::$results = []
protected

Definition at line 48 of file class.ilAccess.php.

◆ $status

bool ilAccess::$status
protected

Definition at line 37 of file class.ilAccess.php.

◆ $stored_rbac_access

array ilAccess::$stored_rbac_access = []
protected

Definition at line 50 of file class.ilAccess.php.

◆ $tree

bool ilAccess::$tree
protected

Definition at line 40 of file class.ilAccess.php.

◆ $user

ilObjUser ilAccess::$user
protected

Definition at line 54 of file class.ilAccess.php.

◆ MAX_CACHE_SIZE

const ilAccess::MAX_CACHE_SIZE = 1000
private

Definition at line 29 of file class.ilAccess.php.


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