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

Class ilObjMainMenuAccess. More...

+ Inheritance diagram for ilObjMainMenuAccess:
+ Collaboration diagram for ilObjMainMenuAccess:

Public Member Functions

 __construct ()
 ilObjMainMenuAccess constructor. More...
 
 checkAccessAndThrowException (string $permission)
 
 hasUserPermissionTo (string $permission)
 
 getGlobalRoles ()
 
 isCurrentUserAllowedToSeeCustomItem (ilMMCustomItemStorage $item, Closure $current)
 
- Public Member Functions inherited from ilObjectAccess
 _checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
 Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
 
 canBeDelivered (ilWACPath $ilWACPath)
 
 canBeDelivered (ilWACPath $ilWACPath)
 
 checkAccessAndThrowException (string $permission)
 
 hasUserPermissionTo (string $permission)
 
 getGlobalRoles ()
 
 isCurrentUserAllowedToSeeCustomItem (ilMMCustomItemStorage $item, Closure $current)
 

Private Member Functions

 resolveUsersGlobalRoles ()
 

Private Attributes

ilObjUser $user
 
ilRbacSystem $rbacsystem
 
ilRbacReview $rbacreview
 
int $ref_id
 
array $global_roles = null
 

Additional Inherited Members

- Static Public Member Functions inherited from ilObjectAccess
static _getCommands ()
 get commands More...
 
static _checkGoto (string $target)
 check whether goto script will succeed More...
 
static _isOffline (int $obj_id)
 Type-specific implementation of general status, has to be overwritten if object type does not support centralized offline handling. More...
 
static _preloadData (array $obj_ids, array $ref_ids)
 Preload data. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilObjMainMenuAccess::__construct ( )

ilObjMainMenuAccess constructor.

Definition at line 36 of file class.ilObjMainMenuAccess.php.

37 {
38 global $DIC;
39 $this->rbacreview = $DIC->rbac()->review();
40 $this->rbacsystem = $DIC->rbac()->system();
41 $this->user = $DIC->user();
42 $this->ref_id = $DIC->http()->wrapper()->query()->has('ref_id')
43 ? $DIC->http()->wrapper()->query()->retrieve('ref_id', $DIC->refinery()->kindlyTo()->int())
44 : null;
45 }
global $DIC
Definition: shib_login.php:26

References $DIC, and ILIAS\Repository\user().

+ Here is the call graph for this function:

Member Function Documentation

◆ checkAccessAndThrowException()

ilObjMainMenuAccess::checkAccessAndThrowException ( string  $permission)
Parameters
string$permission
Exceptions
ilException

Implements ilMainMenuAccess.

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

51 : void
52 {
53 if (!$this->hasUserPermissionTo($permission)) {
54 throw new ilException('Permission denied');
55 }
56 }
Base class for ILIAS Exception handling.
hasUserPermissionTo(string $permission)

References hasUserPermissionTo().

+ Here is the call graph for this function:

◆ getGlobalRoles()

ilObjMainMenuAccess::getGlobalRoles ( )
Returns
array

Implements ilMainMenuAccess.

Definition at line 73 of file class.ilObjMainMenuAccess.php.

73 : array
74 {
75 $global_roles = $this->rbacreview->getRolesForIDs(
76 $this->rbacreview->getGlobalRoles(),
77 false
78 );
79
80 $roles = [];
81 foreach ($global_roles as $global_role) {
82 $roles[$global_role['rol_id']] = $global_role['title'];
83 }
84
85 return $roles;
86 }

References $global_roles.

◆ hasUserPermissionTo()

ilObjMainMenuAccess::hasUserPermissionTo ( string  $permission)
Parameters
string$permission
Returns
bool

Implements ilMainMenuAccess.

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

62 : bool
63 {
64 if ($this->ref_id === null) {
65 return false;
66 }
67 return $this->rbacsystem->checkAccess($permission, $this->ref_id);
68 }

Referenced by checkAccessAndThrowException().

+ Here is the caller graph for this function:

◆ isCurrentUserAllowedToSeeCustomItem()

ilObjMainMenuAccess::isCurrentUserAllowedToSeeCustomItem ( ilMMCustomItemStorage  $item,
Closure  $current 
)
Parameters
ilMMCustomItemStorage$item
Returns
Closure

Implements ilMainMenuAccess.

Definition at line 88 of file class.ilObjMainMenuAccess.php.

88 : Closure
89 {
90 return function () use ($item, $current): bool {
91 if (!$item->hasRoleBasedVisibility()) {
92 return $current();
93 }
94 if (!empty($item->getGlobalRoleIDs())) {
95 foreach ($this->resolveUsersGlobalRoles() as $role_of_current_user) {
96 if (in_array((int) $role_of_current_user, $item->getGlobalRoleIDs(), true)) {
97 return $current();
98 }
99 }
100 }
101 return false;
102 };
103 }

References ilMMCustomItemStorage\getGlobalRoleIDs(), ilMMCustomItemStorage\hasRoleBasedVisibility(), and resolveUsersGlobalRoles().

+ Here is the call graph for this function:

◆ resolveUsersGlobalRoles()

ilObjMainMenuAccess::resolveUsersGlobalRoles ( )
private

Definition at line 105 of file class.ilObjMainMenuAccess.php.

105 : array
106 {
107 return $this->global_roles
108 ?? $this->global_roles = $this->rbacreview->assignedGlobalRoles($this->user->getId());
109 }

References ILIAS\Repository\user().

Referenced by isCurrentUserAllowedToSeeCustomItem().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $global_roles

array ilObjMainMenuAccess::$global_roles = null
private

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

Referenced by getGlobalRoles().

◆ $rbacreview

ilRbacReview ilObjMainMenuAccess::$rbacreview
private

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

◆ $rbacsystem

ilRbacSystem ilObjMainMenuAccess::$rbacsystem
private

Definition at line 28 of file class.ilObjMainMenuAccess.php.

◆ $ref_id

int ilObjMainMenuAccess::$ref_id
private

Definition at line 30 of file class.ilObjMainMenuAccess.php.

◆ $user

ilObjUser ilObjMainMenuAccess::$user
private

Definition at line 27 of file class.ilObjMainMenuAccess.php.


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