ilSettingsPermissionGUI Class Reference

UI class for handling permissions that can be configured having the write permission for an object. More...

Collaboration diagram for ilSettingsPermissionGUI:

Public Member Functions
	__construct ($a_gui_obj)
	Constructor. More...
	determineRoles ()
	Determine roles. More...
	setRoleRequiredPermissions ($a_val)
	Set role required permissions (this permissions are required for a role to be listed) More...
	getRoleRequiredPermissions ()
	Get role required permissions. More...
	setRoleProhibitedPermissions ($a_val)
	Set role prohibited permissions (this permissions are prohibited for a role to be listed) More...
	getRoleProhibitedPermissions ()
	Get role prohibited permissions. More...
	setPermissions ($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
	$permissions = array()
	$base_permissions = array()
	$base_permissions_by_op = array()
	$role_required_permissions = array()
	$role_prohibited_permissions = array()

Detailed Description

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 13 of file class.ilSettingsPermissionGUI.php.

Constructor & Destructor Documentation

__construct()

ilSettingsPermissionGUI::__construct

(

$a_gui_obj

)

Constructor.

Parameters

ilObjectGUI

$a_gui_obj

object gui object

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

References $ilCtrl, $lng, $tpl, and ilRbacReview\_getOperationList().

    {
        global $objDefinition, $tpl, $ilCtrl, $lng, $rbacreview;

        $this->objDefinition = $objDefinition;
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->lng->loadLanguageModule("rbac");

        $this->ctrl = $ilCtrl;

        $this->gui_obj = $a_gui_obj;
        $this->obj = $a_gui_obj->object;
        $this->red_id = $this->obj->getRefId();


        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 = $rbacreview->getParentRoleIds($this->obj->getRefId());
    }

Here is the call graph for this function:

Member Function Documentation

determineRoles()

ilSettingsPermissionGUI::determineRoles

(

)

Determine roles.

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

References $r, array, getRoleProhibitedPermissions(), and getRoleRequiredPermissions().

Referenced by initPermissionForm(), and save().

    {
        global $rbacreview;

        $roles = array();
        foreach ($this->base_roles as $k => $r) {
            $ops = $rbacreview->getActiveOperationsOfRole($this->obj->getRefId(), $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 160 of file class.ilSettingsPermissionGUI.php.

References array.

    {
        $cmd = $this->ctrl->getCmd("showForm");
        if (in_array($cmd, array("showForm", "save"))) {
            $this->$cmd();
        }
    }

getPermissions()

ilSettingsPermissionGUI::getPermissions

(

)

Get permissions.

Returns

array array of operations (string) that should be offered

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

References $permissions.

Referenced by initPermissionForm(), and save().

    {
        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 126 of file class.ilSettingsPermissionGUI.php.

References $role_prohibited_permissions.

Referenced by determineRoles().

    {
        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 100 of file class.ilSettingsPermissionGUI.php.

References $role_required_permissions.

Referenced by determineRoles().

    {
        return $this->role_required_permissions;
    }

Here is the caller graph for this function:

initPermissionForm()

ilSettingsPermissionGUI::initPermissionForm

(

)

Init permission form.

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

References $form, $r, ilObjRole\_getTranslation(), array, determineRoles(), and getPermissions().

Referenced by save(), and showForm().

    {
        global $rbacreview;

        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();

        $roles = $this->determineRoles();
        $ops = array();
        foreach ($roles as $r) {
            $ops[$r["rol_id"]] = $rbacreview->getActiveOperationsOfRole($this->obj->getRefId(), $r["rol_id"]);
        }

        // for each permission, collect all roles that have the permission activated
        $perm_roles = array();
        foreach ($ops as $r => $o2) {
            foreach ($o2 as $o) {
                $perm_roles[$o][] = $r;
            }
        }

        // for each permission
        include_once './Services/AccessControl/classes/class.ilObjRole.php';
        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"]), $k);
                $cb->addOption($option);
            }
            if (is_array($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 229 of file class.ilSettingsPermissionGUI.php.

References $form, $key, $r, array, determineRoles(), getPermissions(), initPermissionForm(), and ilUtil\sendSuccess().

    {
        global $rbacreview, $rbacadmin;

        $form = $this->initPermissionForm();
        if ($form->checkInput()) {
            foreach ($this->determineRoles() as $r) {
                // get active operations for role
                $ops = $rbacreview->getActiveOperationsOfRole($this->obj->getRefId(), $r["rol_id"]);

                // revode all permissions for the role
                $rbacadmin->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 = array();
                    }
                    $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
                $rbacadmin->grantPermission(
                    $r["rol_id"],
                    array_unique($ops),
                    $this->obj->getRefId()
                );
            }

            ilUtil::sendSuccess($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

(

$a_val

)

Set permissions.

Parameters

array

$a_val

array of operations (string) that should be offered

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

    {
        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

(

$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 110 of file class.ilSettingsPermissionGUI.php.

    {
        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

(

$a_val

)

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

Parameters

array

$a_val

permissions required to be listed

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

    {
        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 171 of file class.ilSettingsPermissionGUI.php.

References $form, and initPermissionForm().

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

Here is the call graph for this function:

Field Documentation

$base_permissions

ilSettingsPermissionGUI::$base_permissions = array()

protected

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

$base_permissions_by_op

ilSettingsPermissionGUI::$base_permissions_by_op = array()

protected

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

$permissions

ilSettingsPermissionGUI::$permissions = array()

protected

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

Referenced by getPermissions().

$role_prohibited_permissions

ilSettingsPermissionGUI::$role_prohibited_permissions = array()

protected

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

Referenced by getRoleProhibitedPermissions().

$role_required_permissions

ilSettingsPermissionGUI::$role_required_permissions = array()

protected

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

Referenced by getRoleRequiredPermissions().

---

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

• Services/AccessControl/classes/class.ilSettingsPermissionGUI.php