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

Collaboration diagram for ilSettingsPermissionGUI:

Public Member Functions
	__construct (object $a_gui_obj)

	determineRoles ()
	Determine roles. More...

	setRoleRequiredPermissions (array $a_val)
	Set role required permissions (this permissions are required for a role to be listed) More...

	getRoleRequiredPermissions ()
	Get role required permissions. More...

	setRoleProhibitedPermissions (array $a_val)
	Set role prohibited permissions (this permissions are prohibited for a role to be listed) More...

	getRoleProhibitedPermissions ()
	Get role prohibited permissions. More...

	setPermissions (array $a_val)
	Set permissions. More...

	getPermissions ()
	Get permissions. More...

	executeCommand ()
	Execute command. More...

	showForm ()
	Show form. More...

	initPermissionForm ()
	Init permission form. More...

	save ()
	Save form. More...

Protected Attributes
array	$permissions = []

array	$base_permissions = []

array	$base_permissions_by_op = []

array	$role_required_permissions = []

array	$role_prohibited_permissions = []

array	$base_roles = []

ilRbacReview	$review

ilRbacAdmin	$admin

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilCtrl	$ctrl

Private Attributes
object	$obj

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 UI class for handling permissions that can be configured having the write permission for an object

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilSettingsPermissionGUI::__construct ( object $a_gui_obj )

Definition at line 45 of file class.ilSettingsPermissionGUI.php.

References $DIC, ilRbacReview\_getOperationList(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule("rbac");
         $this->ctrl = $DIC->ctrl();
         $this->obj = $a_gui_obj->getObject();
         $this->review = $DIC->rbac()->review();
         $this->admin = $DIC->rbac()->admin();
         $this->tpl = $DIC->ui()->mainTemplate();
 
         foreach (ilRbacReview::_getOperationList($this->obj->getType()) as $p) {
             $this->base_permissions[$p["ops_id"]] = $p["operation"];
             $this->base_permissions_by_op[$p["operation"]] = $p["ops_id"];
         }
 
         $this->base_roles = $this->review->getParentRoleIds($this->obj->getRefId());
     }

Here is the call graph for this function:

Member Function Documentation

◆ determineRoles()

ilSettingsPermissionGUI::determineRoles ( )

Determine roles.

Definition at line 68 of file class.ilSettingsPermissionGUI.php.

References $r, getRoleProhibitedPermissions(), getRoleRequiredPermissions(), and ILIAS\Repository\int().

Referenced by initPermissionForm(), and save().

                                     : array
     {
         $roles = [];
         foreach ($this->base_roles as $k => $r) {
             $ops = $this->review->getActiveOperationsOfRole($this->obj->getRefId(), (int) $r["rol_id"]);
             $use = true;
             foreach ($this->getRoleRequiredPermissions() as $o) {
                 if (!in_array($o, $ops)) {
                     $use = false;
                 }
             }
             foreach ($this->getRoleProhibitedPermissions() as $o) {
                 if (in_array($o, $ops)) {
                     $use = false;
                 }
             }
             if ($use) {
                 $roles[$k] = $r;
             }
         }
         return $roles;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilSettingsPermissionGUI::executeCommand ( )

Execute command.

Definition at line 165 of file class.ilSettingsPermissionGUI.php.

References ILIAS\Repository\ctrl().

                                     : void
     {
         $cmd = $this->ctrl->getCmd("showForm");
         if (in_array($cmd, ["showForm", "save"])) {
             $this->$cmd();
         }
     }

Here is the call graph for this function:

◆ getPermissions()

ilSettingsPermissionGUI::getPermissions ( )

Get permissions.

Returns: array array of operations (string) that should be offered

Definition at line 157 of file class.ilSettingsPermissionGUI.php.

References $permissions.

Referenced by initPermissionForm(), and save().

                                     : array
     {
         return $this->permissions;
     }

Here is the caller graph for this function:

◆ getRoleProhibitedPermissions()

ilSettingsPermissionGUI::getRoleProhibitedPermissions ( )

Get role prohibited permissions.

Returns: array permissions prohibited to be listed

Definition at line 133 of file class.ilSettingsPermissionGUI.php.

References $role_prohibited_permissions.

Referenced by determineRoles().

                                                   : array
     {
         return $this->role_prohibited_permissions;
     }

Here is the caller graph for this function:

◆ getRoleRequiredPermissions()

ilSettingsPermissionGUI::getRoleRequiredPermissions ( )

Get role required permissions.

Returns: array permissions required to be listed

Definition at line 109 of file class.ilSettingsPermissionGUI.php.

References $role_required_permissions.

Referenced by determineRoles().

                                                 : array
     {
         return $this->role_required_permissions;
     }

Here is the caller graph for this function:

◆ initPermissionForm()

ilSettingsPermissionGUI::initPermissionForm ( )

Init permission form.

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

References $r, ilObjRole\_getTranslation(), ILIAS\Repository\ctrl(), determineRoles(), getPermissions(), ILIAS\Repository\int(), and ILIAS\Repository\lng().

Referenced by save(), and showForm().

                                         : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $roles = $this->determineRoles();
         $ops = [];
         foreach ($roles as $r) {
             $ops[(int) $r["rol_id"]] = $this->review->getActiveOperationsOfRole($this->obj->getRefId(), (int) $r["rol_id"]);
         }
 
         // for each permission, collect all roles that have the permission activated
         $perm_roles = [];
         foreach ($ops as $r => $o2) {
             foreach ($o2 as $o) {
                 $perm_roles[$o][] = $r;
             }
         }
 
         // for each permission
         foreach ($this->getPermissions() as $p) {
             // roles
             $cb = new ilCheckboxGroupInputGUI($this->lng->txt($p), $p);
             reset($roles);
             foreach ($roles as $k => $r) {
                 $option = new ilCheckboxOption(ilObjRole::_getTranslation($r["title"]), (string) $k);
                 $cb->addOption($option);
             }
             if (isset($perm_roles[$this->base_permissions_by_op[$p]])) {
                 $cb->setValue($perm_roles[$this->base_permissions_by_op[$p]]);
             }
             $form->addItem($cb);
         }
 
         $form->addCommandButton("save", $this->lng->txt("save"));
 
         $form->setTitle($this->lng->txt("rbac_permissions"));
         $form->setFormAction($this->ctrl->getFormAction($this));
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilSettingsPermissionGUI::save ( )

Save form.

Definition at line 227 of file class.ilSettingsPermissionGUI.php.

References $r, ILIAS\Repository\ctrl(), determineRoles(), getPermissions(), initPermissionForm(), and ILIAS\Repository\lng().

                           : void
     {
         $form = $this->initPermissionForm();
         if ($form->checkInput()) {
             foreach ($this->determineRoles() as $r) {
                 // get active operations for role
                 $ops = $this->review->getActiveOperationsOfRole($this->obj->getRefId(), $r["rol_id"]);
 
                 // revode all permissions for the role
                 $this->admin->revokePermission($this->obj->getRefId(), $r["rol_id"]);
 
                 // for all permissions of the form...
                 foreach ($this->getPermissions() as $p) {
                     $roles = $form->getInput($p);
                     if (!is_array($roles)) {
                         $roles = [];
                     }
                     $o = $this->base_permissions_by_op[$p];
 
                     // ... if in original operations, but not checked, remove it from operations
                     if (in_array($o, $ops) && !in_array($r["rol_id"], $roles)) {
                         if (($key = array_search($o, $ops)) !== false) {
                             unset($ops[$key]);
                         }
                     }
 
                     // ...if not in original operations, but checked, add to operations
                     if (!in_array($o, $ops) && in_array($r["rol_id"], $roles)) {
                         $ops[] = $o;
                     }
                 }
                 // now grant resulting permissions
                 $this->admin->grantPermission(
                     $r["rol_id"],
                     array_unique($ops),
                     $this->obj->getRefId()
                 );
             }
 
             $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
             $this->ctrl->redirect($this, "");
         } else {
             $form->setValuesByPost();
             $this->tpl->setContent($form->getHTML());
         }
     }

Here is the call graph for this function:

◆ setPermissions()

ilSettingsPermissionGUI::setPermissions ( array $a_val )

Set permissions.

Parameters

array $a_val array of operations (string) that should be offered

Definition at line 142 of file class.ilSettingsPermissionGUI.php.

                                                 : void
     {
         if (is_array($a_val)) {
             foreach ($a_val as $p) {
                 if (in_array($p, $this->base_permissions)) {
                     $this->permissions[$this->base_permissions_by_op[$p]] = $p;
                 }
             }
         }
     }

◆ setRoleProhibitedPermissions()

ilSettingsPermissionGUI::setRoleProhibitedPermissions ( array $a_val )

Set role prohibited permissions (this permissions are prohibited for a role to be listed)

Parameters

array $a_val permissions prohibited to be listed

Definition at line 118 of file class.ilSettingsPermissionGUI.php.

                                                               : void
     {
         if (is_array($a_val)) {
             foreach ($a_val as $p) {
                 if (in_array($p, $this->base_permissions)) {
                     $this->role_prohibited_permissions[] = $this->base_permissions_by_op[$p];
                 }
             }
         }
     }

◆ setRoleRequiredPermissions()

ilSettingsPermissionGUI::setRoleRequiredPermissions ( array $a_val )

Set role required permissions (this permissions are required for a role to be listed)

Definition at line 94 of file class.ilSettingsPermissionGUI.php.

                                                             : void
     {
         if (is_array($a_val)) {
             foreach ($a_val as $p) {
                 if (in_array($p, $this->base_permissions)) {
                     $this->role_required_permissions[] = $this->base_permissions_by_op[$p];
                 }
             }
         }
     }

◆ showForm()

ilSettingsPermissionGUI::showForm ( )

Show form.

Definition at line 176 of file class.ilSettingsPermissionGUI.php.

References initPermissionForm().

                               : void
     {
         $form = $this->initPermissionForm();
         $this->tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

Field Documentation

◆ $admin

ilRbacAdmin ilSettingsPermissionGUI::$admin

protected

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

◆ $base_permissions

array ilSettingsPermissionGUI::$base_permissions = []

protected

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

◆ $base_permissions_by_op

array ilSettingsPermissionGUI::$base_permissions_by_op = []

protected

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

◆ $base_roles

array ilSettingsPermissionGUI::$base_roles = []

protected

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

◆ $ctrl

ilCtrl ilSettingsPermissionGUI::$ctrl

protected

Definition at line 43 of file class.ilSettingsPermissionGUI.php.

◆ $lng

ilLanguage ilSettingsPermissionGUI::$lng

protected

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

◆ $obj

object ilSettingsPermissionGUI::$obj

private

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

◆ $permissions

array ilSettingsPermissionGUI::$permissions = []

protected

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

Referenced by getPermissions().

◆ $review

ilRbacReview ilSettingsPermissionGUI::$review

protected

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

◆ $role_prohibited_permissions

array ilSettingsPermissionGUI::$role_prohibited_permissions = []

protected

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

Referenced by getRoleProhibitedPermissions().

◆ $role_required_permissions

array ilSettingsPermissionGUI::$role_required_permissions = []

protected

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

Referenced by getRoleRequiredPermissions().

◆ $tpl

ilGlobalTemplateInterface ilSettingsPermissionGUI::$tpl

protected

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

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

components/ILIAS/AccessControl/classes/class.ilSettingsPermissionGUI.php

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ determineRoles()

◆ executeCommand()

◆ getPermissions()

◆ getRoleProhibitedPermissions()

◆ getRoleRequiredPermissions()

◆ initPermissionForm()

◆ save()

◆ setPermissions()

◆ setRoleProhibitedPermissions()

◆ setRoleRequiredPermissions()

◆ showForm()

Field Documentation

◆ $admin

◆ $base_permissions

◆ $base_permissions_by_op

◆ $base_roles

◆ $ctrl

◆ $lng

◆ $obj

◆ $permissions

◆ $review

◆ $role_prohibited_permissions

◆ $role_required_permissions

◆ $tpl