ilPermissionGUI Class Reference

New PermissionGUI (extends from old ilPermission2GUI) RBAC related output. More...

Inheritance diagram for ilPermissionGUI:

Collaboration diagram for ilPermissionGUI:

Public Member Functions
	__construct ($a_gui_obj)
	Constructor. More...
	executeCommand ()
	Execute command. More...
	getCurrentObject ()
	Get current object. More...
	perm (ilTable2GUI $table=null)
	show permission table More...
	applyRoleFilter ($a_roles, $a_filter_id)
	Apply filter to roles. More...
Public Member Functions inherited from ilPermission2GUI
	__construct ($a_gui_obj)
	owner ()
	changeOwner ()
	__initSubTabs ($a_cmd)
	log ()
	applyLogFilter ()
	resetLogFilter ()

Static Public Member Functions
static	hasContainerCommands ($a_type)
	Check if container commands are possible for the current object type. More...

Data Fields
const	CMD_PERM_POSITIONS = 'permPositions'
const	CMD_SAVE_POSITIONS_PERMISSIONS = 'savePositionsPermissions'
Data Fields inherited from ilPermission2GUI
const	TAB_POSITION_PERMISSION_SETTINGS = "position_permission_settings"

Protected Member Functions
	confirmTemplateSwitch ()
	Called after toolbar action applyTemplateSwitch. More...
	isAdminRoleFolder ()
	Check of current location is administration (main) role folder. More...
	isAdministrationObject ()
	isInAdministration ()
	Check if node is subobject of administration folder. More...
	applyFilter ()
	Apply filter. More...
	resetFilter ()
	Reset filter. More...
	savePermissions ()
	Save permissions. More...
	showConfirmBlockRole ($a_blocked_info)
	Show block role confirmation screen. More...
	modifyBlockRoles ()
	unblockRoles ($roles)
	blockRoles ($roles)
	Block role. More...
	displayImportRoleForm (ilPropertyFormGUI $form=null)
	Show import form. More...
	doImportRole ()
	Perform import. More...
	initImportForm ()
	init import form More...
	initRoleForm ()
	Shoew add role type $rbacreview type $objDefinition. More...
	displayAddRoleForm ()
	Show add role form. More...
	addRole ()
	adds a local role This method is only called when choose the option 'you may add local roles'. More...
	getModifiedBlockedSettings ()
	permPositions ()
	savePositionsPermissions ()

Protected Attributes
	$current_obj = null
	$recommended_content_manager
Protected Attributes inherited from ilPermission2GUI
	$gui_obj = null
	$ilErr = null
	$ctrl = null
	$lng = null
	$tpl

Detailed Description

New PermissionGUI (extends from old ilPermission2GUI) RBAC related output.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@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$

ilPermissionGUI: ilObjRoleGUI, ilRepositorySearchGUI, ilObjectPermissionStatusGUI

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

Constructor & Destructor Documentation

__construct()

ilPermissionGUI::__construct

(

$a_gui_obj

)

Constructor.

Parameters

object

$a_gui_obj

Returns

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

References ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct($a_gui_obj);

        $this->recommended_content_manager = new ilRecommendedContentManager();
    }

Here is the call graph for this function:

Member Function Documentation

addRole()

ilPermissionGUI::addRole ( )

protected

adds a local role This method is only called when choose the option 'you may add local roles'.

This option is displayed in the permission settings dialogue for an object TODO: this will be changed public

Definition at line 750 of file class.ilPermissionGUI.php.

References $DIC, $GLOBALS, ilPermission2GUI\$ilErr, getCurrentObject(), initRoleForm(), ilObjRole\MODE_PROTECTED_KEEP_LOCAL_POLICIES, and ilObjRole\MODE_UNPROTECTED_KEEP_LOCAL_POLICIES.

    {
        global $DIC;

        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];
        $rbacsystem = $DIC['rbacsystem'];
        $ilErr = $DIC['ilErr'];
        $ilCtrl = $DIC['ilCtrl'];

        $form = $this->initRoleForm();
        if ($form->checkInput()) {
            $new_title = $form->getInput("title");

            include_once './Services/AccessControl/classes/class.ilObjRole.php';
            $role = new ilObjRole();
            $role->setTitle($new_title);
            $role->setDescription($form->getInput('desc'));
            $role->create();

            $GLOBALS['DIC']['rbacadmin']->assignRoleToFolder($role->getId(), $this->getCurrentObject()->getRefId());

            // protect
            $rbacadmin->setProtected(
                $this->getCurrentObject()->getRefId(),
                $role->getId(),
                $form->getInput('pro') ? 'y' : 'n'
            );

            // copy rights
            $right_id_to_copy = $form->getInput("rights");
            if ($right_id_to_copy) {
                $parentRoles = $rbacreview->getParentRoleIds($this->getCurrentObject()->getRefId(), true);
                $rbacadmin->copyRoleTemplatePermissions(
                    $right_id_to_copy,
                    $parentRoles[$right_id_to_copy]["parent"],
                    $this->getCurrentObject()->getRefId(),
                    $role->getId(),
                    false
                );

                if ($form->getInput('existing')) {
                    if ($form->getInput('pro')) {
                        $role->changeExistingObjects(
                            $this->getCurrentObject()->getRefId(),
                            ilObjRole::MODE_PROTECTED_KEEP_LOCAL_POLICIES,
                            array('all')
                        );
                    } else {
                        $role->changeExistingObjects(
                            $this->getCurrentObject()->getRefId(),
                            ilObjRole::MODE_UNPROTECTED_KEEP_LOCAL_POLICIES,
                            array('all')
                        );
                    }
                }
            }

            // add to desktop items
            if ($form->getInput("desktop")) {
                $this->recommended_content_manager->addRoleRecommendation($role->getId(), $this->getCurrentObject()->getRefId());
            }

            ilUtil::sendSuccess($this->lng->txt("role_added"), true);
            $this->ctrl->redirect($this, 'perm');
        } else {
            $form->setValuesByPost();
            $this->tpl->setContent($form->getHTML());
        }
    }

Here is the call graph for this function:

applyFilter()

ilPermissionGUI::applyFilter ( )

protected

Apply filter.

Returns

Definition at line 194 of file class.ilPermissionGUI.php.

References getCurrentObject(), and perm().

    {
        include_once './Services/AccessControl/classes/class.ilObjectRolePermissionTableGUI.php';
        $table = new ilObjectRolePermissionTableGUI($this, 'perm', $this->getCurrentObject()->getRefId());
        $table->resetOffset();
        $table->writeFilterToSession();
        return $this->perm($table);
    }

Here is the call graph for this function:

applyRoleFilter()

ilPermissionGUI::applyRoleFilter	(		$a_roles,
			$a_filter_id
	)

Apply filter to roles.

Parameters

int

$a_filter_id

Returns

Definition at line 222 of file class.ilPermissionGUI.php.

References $DIC, $GLOBALS, getCurrentObject(), ilObjectRolePermissionTableGUI\ROLE_FILTER_ALL, ilObjectRolePermissionTableGUI\ROLE_FILTER_GLOBAL, ilObjectRolePermissionTableGUI\ROLE_FILTER_LOCAL, ilObjectRolePermissionTableGUI\ROLE_FILTER_LOCAL_OBJECT, ilObjectRolePermissionTableGUI\ROLE_FILTER_LOCAL_POLICY, and SYSTEM_ROLE_ID.

Referenced by savePermissions().

    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];

        // Always delete administrator role from view
        if (isset($a_roles[SYSTEM_ROLE_ID])) {
            unset($a_roles[SYSTEM_ROLE_ID]);
        }

        switch ($a_filter_id) {
            // all roles in context
            case ilObjectRolePermissionTableGUI::ROLE_FILTER_ALL:

                return $a_roles;

            // only global roles
            case ilObjectRolePermissionTableGUI::ROLE_FILTER_GLOBAL:

                $arr_global_roles = $rbacreview->getGlobalRoles();
                $arr_remove_roles = array_diff(array_keys($a_roles), $arr_global_roles);

                foreach ($arr_remove_roles as $role_id) {
                    unset($a_roles[$role_id]);
                }
                return $a_roles;

            // only local roles (all local roles in context that are not defined at ROLE_FOLDER_ID)
            case ilObjectRolePermissionTableGUI::ROLE_FILTER_LOCAL:
                $arr_global_roles = $rbacreview->getGlobalRoles();

                foreach ($arr_global_roles as $role_id) {
                    unset($a_roles[$role_id]);
                }

                return $a_roles;
                break;

            // only roles which use a local policy
            case ilObjectRolePermissionTableGUI::ROLE_FILTER_LOCAL_POLICY:

                $arr_local_roles = $GLOBALS['DIC']['rbacreview']->getRolesOfObject($this->getCurrentObject()->getRefId());
                $arr_remove_roles = array_diff(array_keys($a_roles), $arr_local_roles);

                foreach ($arr_remove_roles as $role_id) {
                    unset($a_roles[$role_id]);
                }

                return $a_roles;

            // only true local role defined at current position
            case ilObjectRolePermissionTableGUI::ROLE_FILTER_LOCAL_OBJECT:

                $arr_local_roles = $GLOBALS['DIC']['rbacreview']->getRolesOfObject($this->getCurrentObject()->getRefId(), true);
                $arr_remove_roles = array_diff(array_keys($a_roles), $arr_local_roles);

                foreach ($arr_remove_roles as $role_id) {
                    unset($a_roles[$role_id]);
                }

                return $a_roles;

            default:
                return $a_roles;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

blockRoles()

ilPermissionGUI::blockRoles (   $roles )

protected

Block role.

Returns

void

Definition at line 518 of file class.ilPermissionGUI.php.

References $DIC, and getCurrentObject().

Referenced by modifyBlockRoles().

    {
        global $DIC;

        $rbacadmin = $DIC['rbacadmin'];
        $rbacreview = $DIC['rbacreview'];

        foreach ($roles as $role) {
            // Set assign to 'y' only if it is a local role
            $assign = $rbacreview->isAssignable($role, $this->getCurrentObject()->getRefId()) ? 'y' : 'n';

            // Delete permissions
            $rbacadmin->revokeSubtreePermissions($this->getCurrentObject()->getRefId(), $role);

            // Delete template permissions
            $rbacadmin->deleteSubtreeTemplates($this->getCurrentObject()->getRefId(), $role);


            $rbacadmin->assignRoleToFolder(
                $role,
                $this->getCurrentObject()->getRefId(),
                $assign
            );

            // finally set blocked status
            $rbacadmin->setBlockedStatus(
                $role,
                $this->getCurrentObject()->getRefId(),
                true
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmTemplateSwitch()

ilPermissionGUI::confirmTemplateSwitch ( )

protected

Called after toolbar action applyTemplateSwitch.

Definition at line 112 of file class.ilPermissionGUI.php.

    {
        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateGUI.php';
        $this->ctrl->setReturn($this, 'perm');
        $this->ctrl->setCmdClass('ildidactictemplategui');
        $dtpl_gui = new ilDidacticTemplateGUI($this->gui_obj);
        $this->ctrl->forwardCommand($dtpl_gui, 'confirmTemplateSwitch');
    }

displayAddRoleForm()

ilPermissionGUI::displayAddRoleForm ( )

protected

Show add role form.

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

References $GLOBALS, and initRoleForm().

    {
        $GLOBALS['DIC']['ilTabs']->clearTargets();

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

Here is the call graph for this function:

displayImportRoleForm()

ilPermissionGUI::displayImportRoleForm ( ilPropertyFormGUI  $form = null )

protected

Show import form.

Parameters

ilPropertyFormGUI

$form

Definition at line 570 of file class.ilPermissionGUI.php.

References $GLOBALS, and initImportForm().

Referenced by doImportRole().

    {
        $GLOBALS['DIC']['ilTabs']->clearTargets();

        if (!$form) {
            $form = $this->initImportForm();
        }
        $GLOBALS['DIC']['tpl']->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doImportRole()

ilPermissionGUI::doImportRole ( )

protected

Perform import.

Definition at line 583 of file class.ilPermissionGUI.php.

References $DIC, Vendor\Package\$e, displayImportRoleForm(), getCurrentObject(), initImportForm(), and ilUtil\sendFailure().

    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];

        $form = $this->initImportForm();
        if ($form->checkInput()) {
            try {
                include_once './Services/Export/classes/class.ilImport.php';

                // For global roles set import id to parent of current ref_id (adm)
                $imp = new ilImport($this->getCurrentObject()->getRefId());
                $imp->getMapping()->addMapping(
                    'Services/AccessControl',
                    'rolf',
                    0,
                    $this->getCurrentObject()->getRefId()
                );

                $imp->importObject(
                    null,
                    $_FILES["importfile"]["tmp_name"],
                    $_FILES["importfile"]["name"],
                    'role'
                );
                ilUtil::sendSuccess($this->lng->txt('rbac_role_imported'), true);
                $this->ctrl->redirect($this, 'perm');
                return;
            } catch (Exception $e) {
                ilUtil::sendFailure($e->getMessage());
                $form->setValuesByPost();
                $this->displayImportRoleForm($form);
                return;
            }
        }
        $form->setValuesByPost();
        ilUtil::sendFailure($this->lng->txt('err_check_input'));
        $this->displayImportRoleForm($form);
    }

Here is the call graph for this function:

executeCommand()

ilPermissionGUI::executeCommand

(

)

Execute command.

Returns

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

References $_GET, $DIC, $ret, and ilPermission2GUI\__initSubTabs().

    {
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];

        // access to all functions in this class are only allowed if edit_permission is granted
        if (!$rbacsystem->checkAccess("edit_permission", $this->gui_obj->object->getRefId())) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->ctrl->redirect($this->gui_obj);
        }

        $next_class = $this->ctrl->getNextClass($this);

        switch ($next_class) {
            case "ilobjrolegui":
                $this->ctrl->setReturn($this, 'perm');
                include_once("Services/AccessControl/classes/class.ilObjRoleGUI.php");
                $this->gui_obj = new ilObjRoleGUI("", (int) $_GET["obj_id"], false, false);
                $ret = $this->ctrl->forwardCommand($this->gui_obj);
                break;

            case 'ildidactictemplategui':
                $this->ctrl->setReturn($this, 'perm');
                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateGUI.php';
                $did = new ilDidacticTemplateGUI($this->gui_obj);
                $this->ctrl->forwardCommand($did);
                break;

            case 'ilrepositorysearchgui':
                // used for owner autocomplete
                include_once('./Services/Search/classes/class.ilRepositorySearchGUI.php');
                $rep_search = new ilRepositorySearchGUI();
                $this->ctrl->forwardCommand($rep_search);
                break;

            case 'ilobjectpermissionstatusgui':
                $this->__initSubTabs("perminfo");
                include_once('./Services/AccessControl/classes/class.ilObjectPermissionStatusGUI.php');
                $perm_stat = new ilObjectPermissionStatusGUI($this->gui_obj->object);
                $this->ctrl->forwardCommand($perm_stat);
                break;

            default:
                $cmd = $this->ctrl->getCmd();
                $this->$cmd();
                break;
        }

        return true;
    }

Here is the call graph for this function:

getCurrentObject()

ilPermissionGUI::getCurrentObject

(

)

Get current object.

Returns

ilObject

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

Referenced by addRole(), applyFilter(), applyRoleFilter(), blockRoles(), doImportRole(), getModifiedBlockedSettings(), initRoleForm(), isAdministrationObject(), isAdminRoleFolder(), isInAdministration(), perm(), permPositions(), resetFilter(), savePermissions(), savePositionsPermissions(), and unblockRoles().

    {
        return $this->gui_obj->object;
    }

Here is the caller graph for this function:

getModifiedBlockedSettings()

ilPermissionGUI::getModifiedBlockedSettings ( )

protected

Parameters

type

$a_blocked_info

Definition at line 825 of file class.ilPermissionGUI.php.

References $_POST, $DIC, and getCurrentObject().

Referenced by savePermissions().

    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];

        $blocked_info['new_blocked'] = array();
        $blocked_info['new_unblocked'] = array();
        $blocked_info['num'] = 0;
        foreach ((array) $_POST['visible_block'] as $role => $one) {
            $blocked = $rbacreview->isBlockedAtPosition($role, $this->getCurrentObject()->getRefId());
            if (isset($_POST['block'][$role]) && !$blocked) {
                $blocked_info['new_blocked'][] = $role;
                $blocked_info['num']++;
            }
            if (!isset($_POST['block'][$role]) && $blocked) {
                $blocked_info['new_unblocked'][] = $role;
                $blocked_info['num']++;
            }
        }
        return $blocked_info;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasContainerCommands()

static ilPermissionGUI::hasContainerCommands (   $a_type )

static

Check if container commands are possible for the current object type.

Parameters

object

$a_type

Returns

Definition at line 557 of file class.ilPermissionGUI.php.

References $DIC.

Referenced by ilObjectRolePermissionTableGUI\parse(), and savePermissions().

    {
        global $DIC;

        $objDefinition = $DIC['objDefinition'];

        return $objDefinition->isContainer($a_type) and $a_type != 'root' and $a_type != 'adm' and $a_type != 'rolf';
    }

Here is the caller graph for this function:

initImportForm()

ilPermissionGUI::initImportForm ( )

protected

init import form

Definition at line 627 of file class.ilPermissionGUI.php.

References ilFileInputGUI\setSuffixes().

Referenced by displayImportRoleForm(), and doImportRole().

    {
        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('rbac_import_role'));
        $form->addCommandButton('doImportRole', $this->lng->txt('import'));
        $form->addCommandButton('perm', $this->lng->txt('cancel'));

        $zip = new ilFileInputGUI($this->lng->txt('import_file'), 'importfile');
        $zip->setSuffixes(array('zip'));
        $form->addItem($zip);

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initRoleForm()

ilPermissionGUI::initRoleForm ( )

protected

Shoew add role type $rbacreview type $objDefinition.

Returns

ilPropertyFormGUI

Definition at line 649 of file class.ilPermissionGUI.php.

References $DIC, ilObjRole\_getTranslation(), ilUtil\_sortIds(), getCurrentObject(), isInAdministration(), ilTextAreaInputGUI\setCols(), ilFormPropertyGUI\setInfo(), and SYSTEM_ROLE_ID.

Referenced by addRole(), and displayAddRoleForm().

    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];
        $objDefinition = $DIC['objDefinition'];

        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('role_new'));
        $form->addCommandButton('addrole', $this->lng->txt('role_new'));
        $form->addCommandButton('perm', $this->lng->txt('cancel'));

        $title = new ilTextInputGUI($this->lng->txt('title'), 'title');
        $title->setValidationRegexp('/^(?!il_).*$/');
        $title->setValidationFailureMessage($this->lng->txt('msg_role_reserved_prefix'));
        $title->setSize(40);
        $title->setMaxLength(70);
        $title->setRequired(true);
        $form->addItem($title);

        $desc = new ilTextAreaInputGUI($this->lng->txt('description'), 'desc');
        $desc->setCols(40);
        $desc->setRows(3);
        $form->addItem($desc);

        $pro = new ilCheckboxInputGUI($this->lng->txt('role_protect_permissions'), 'pro');
        $pro->setInfo($this->lng->txt('role_protect_permissions_desc'));
        $pro->setValue(1);
        $form->addItem($pro);

        $pd = new ilCheckboxInputGUI($this->lng->txt('rbac_add_recommended_content'), 'desktop');
        $pd->setInfo(
            str_replace(
                "%1",
                $this->getCurrentObject()->getTitle(),
                $this->lng->txt('rbac_add_recommended_content_info')
            )
        );
        $pd->setValue(1);
        $form->addItem($pd);


        if (!$this->isInAdministration()) {
            $rights = new ilRadioGroupInputGUI($this->lng->txt("rbac_role_rights_copy"), 'rights');
            $option = new ilRadioOption($this->lng->txt("rbac_role_rights_copy_empty"), 0);
            $rights->addOption($option);

            $parent_role_ids = $rbacreview->getParentRoleIds($this->gui_obj->object->getRefId(), true);
            $ids = array();
            foreach ($parent_role_ids as $id => $tmp) {
                $ids[] = $id;
            }

            // Sort ids
            $sorted_ids = ilUtil::_sortIds($ids, 'object_data', 'type DESC,title', 'obj_id');

            $key = 0;
            foreach ($sorted_ids as $id) {
                $par = $parent_role_ids[$id];
                if ($par["obj_id"] != SYSTEM_ROLE_ID) {
                    include_once './Services/AccessControl/classes/class.ilObjRole.php';
                    $option = new ilRadioOption(($par["type"] == 'role' ? $this->lng->txt('obj_role') : $this->lng->txt('obj_rolt')) . ": " . ilObjRole::_getTranslation($par["title"]), $par["obj_id"]);
                    $option->setInfo($par["desc"]);
                    $rights->addOption($option);
                }
                $key++;
            }
            $form->addItem($rights);
        }

        // Local policy only for containers
        if ($objDefinition->isContainer($this->getCurrentObject()->getType())) {
            $check = new ilCheckboxInputGui($this->lng->txt("rbac_role_rights_copy_change_existing"), 'existing');
            $check->setInfo($this->lng->txt('rbac_change_existing_objects_desc_new_role'));
            $form->addItem($check);
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAdministrationObject()

ilPermissionGUI::isAdministrationObject ( )

protected

Definition at line 175 of file class.ilPermissionGUI.php.

References getCurrentObject().

Referenced by perm().

    {
        return $this->getCurrentObject()->getType() == 'adm';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isAdminRoleFolder()

ilPermissionGUI::isAdminRoleFolder ( )

protected

Check of current location is administration (main) role folder.

Returns

Definition at line 170 of file class.ilPermissionGUI.php.

References getCurrentObject(), and ROLE_FOLDER_ID.

Referenced by perm().

    {
        return $this->getCurrentObject()->getRefId() == ROLE_FOLDER_ID;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isInAdministration()

ilPermissionGUI::isInAdministration ( )

protected

Check if node is subobject of administration folder.

Returns

type

Definition at line 184 of file class.ilPermissionGUI.php.

References $GLOBALS, getCurrentObject(), and SYSTEM_FOLDER_ID.

Referenced by initRoleForm().

    {
        return (bool) $GLOBALS['DIC']['tree']->isGrandChild(SYSTEM_FOLDER_ID, $this->getCurrentObject()->getRefId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

modifyBlockRoles()

ilPermissionGUI::modifyBlockRoles ( )

protected

Definition at line 474 of file class.ilPermissionGUI.php.

References $_POST, blockRoles(), ilUtil\sendInfo(), and unblockRoles().

    {
        $this->blockRoles((array) $_POST['new_block']);
        $this->unblockRoles((array) $_POST['new_unblock']);

        ilUtil::sendInfo($this->lng->txt('settings_saved'));
        $this->ctrl->redirect($this, 'perm');
    }

Here is the call graph for this function:

perm()

ilPermissionGUI::perm

(

ilTable2GUI

$table = null

)

show permission table

Returns

Definition at line 126 of file class.ilPermissionGUI.php.

References $DIC, ilPermission2GUI\__initSubTabs(), getCurrentObject(), isAdministrationObject(), and isAdminRoleFolder().

Referenced by applyFilter(), and resetFilter().

    {
        global $DIC;

        $objDefinition = $DIC['objDefinition'];
        $ilToolbar = $DIC['ilToolbar'];

        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateGUI.php';
        $dtpl = new ilDidacticTemplateGUI($this->gui_obj);
        if ($dtpl->appendToolbarSwitch(
            $ilToolbar,
            $this->getCurrentObject()->getType(),
            $this->getCurrentObject()->getRefId()
        )) {
            $ilToolbar->addSeparator();
        }

        if ($objDefinition->hasLocalRoles($this->getCurrentObject()->getType()) and
            !$this->isAdministrationObject()
        ) {
            $ilToolbar->setFormAction($this->ctrl->getFormAction($this));

            if (!$this->isAdminRoleFolder()) {
                $ilToolbar->addButton($this->lng->txt('rbac_add_new_local_role'), $this->ctrl->getLinkTarget($this, 'displayAddRoleForm'));
            }
            $ilToolbar->addButton($this->lng->txt('rbac_import_role'), $this->ctrl->getLinkTarget($this, 'displayImportRoleForm'));
        }

        $this->__initSubTabs("perm");

        if (!$table instanceof ilTable2GUI) {
            include_once './Services/AccessControl/classes/class.ilObjectRolePermissionTableGUI.php';
            $table = new ilObjectRolePermissionTableGUI($this, 'perm', $this->getCurrentObject()->getRefId());
        }
        $table->parse();
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

permPositions()

ilPermissionGUI::permPositions ( )

protected

Definition at line 853 of file class.ilPermissionGUI.php.

References ilPermission2GUI\__initSubTabs(), and getCurrentObject().

    {
        $perm = self::CMD_PERM_POSITIONS;
        $this->__initSubTabs($perm);

        $ref_id = $this->getCurrentObject()->getRefId();
        $table = new ilOrgUnitPermissionTableGUI($this, $perm, $ref_id);
        $table->collectData();
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

resetFilter()

ilPermissionGUI::resetFilter ( )

protected

Reset filter.

Returns

Definition at line 207 of file class.ilPermissionGUI.php.

References getCurrentObject(), and perm().

    {
        include_once './Services/AccessControl/classes/class.ilObjectRolePermissionTableGUI.php';
        $table = new ilObjectRolePermissionTableGUI($this, 'perm', $this->getCurrentObject()->getRefId());
        $table->resetOffset();
        $table->resetFilter();

        return $this->perm($table);
    }

Here is the call graph for this function:

savePermissions()

ilPermissionGUI::savePermissions ( )

protected

Save permissions.

Returns

Definition at line 294 of file class.ilPermissionGUI.php.

References $_POST, $DIC, $log, ilRbacLog\add(), applyRoleFilter(), ilRbacLog\diffFaPa(), ilRbacLog\EDIT_PERMISSIONS, ilRbacLog\gatherFaPa(), getCurrentObject(), ilObjectFactory\getInstanceByObjId(), ilLoggerFactory\getLogger(), getModifiedBlockedSettings(), hasContainerCommands(), ilRbacReview\lookupCreateOperationIds(), and showConfirmBlockRole().

    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];
        $objDefinition = $DIC['objDefinition'];
        $rbacadmin = $DIC['rbacadmin'];

        include_once './Services/AccessControl/classes/class.ilObjectRolePermissionTableGUI.php';
        $table = new ilObjectRolePermissionTableGUI($this, 'perm', $this->getCurrentObject()->getRefId());

        $roles = $this->applyRoleFilter(
            $rbacreview->getParentRoleIds($this->getCurrentObject()->getRefId()),
            $table->getFilterItemByPostVar('role')->getValue()
        );

        // Log history
        include_once "Services/AccessControl/classes/class.ilRbacLog.php";
        $log_old = ilRbacLog::gatherFaPa($this->getCurrentObject()->getRefId(), array_keys((array) $roles));


        # all possible create permissions
        $possible_ops_ids = $rbacreview->getOperationsByTypeAndClass(
            $this->getCurrentObject()->getType(),
            'create'
        );

        # createable (activated) create permissions
        $create_types = $objDefinition->getCreatableSubObjects(
            $this->getCurrentObject()->getType()
        );
        $createable_ops_ids = ilRbacReview::lookupCreateOperationIds(array_keys((array) $create_types));

        foreach ((array) $roles as $role => $role_data) {
            if ($role_data['protected']) {
                continue;
            }

            $new_ops = array_keys((array) $_POST['perm'][$role]);
            $old_ops = $rbacreview->getRoleOperationsOnObject(
                $role,
                $this->getCurrentObject()->getRefId()
            );

            // Add operations which were enabled and are not activated.
            foreach ($possible_ops_ids as $create_ops_id) {
                if (in_array($create_ops_id, $createable_ops_ids)) {
                    continue;
                }
                if (in_array($create_ops_id, $old_ops)) {
                    $new_ops[] = $create_ops_id;
                }
            }

            $rbacadmin->revokePermission(
                $this->getCurrentObject()->getRefId(),
                $role
            );

            $rbacadmin->grantPermission(
                $role,
                array_unique($new_ops),
                $this->getCurrentObject()->getRefId()
            );
        }

        if (ilPermissionGUI::hasContainerCommands($this->getCurrentObject()->getType())) {
            foreach ($roles as $role) {
                // No action for local roles
                if ($role['parent'] == $this->getCurrentObject()->getRefId() and $role['assign'] == 'y') {
                    continue;
                }
                // Nothing for protected roles
                if ($role['protected']) {
                    continue;
                }
                // Stop local policy
                if (
                    $role['parent'] == $this->getCurrentObject()->getRefId() and
                    !isset($_POST['inherit'][$role['obj_id']]) and
                    !$rbacreview->isBlockedAtPosition($role['obj_id'], $this->getCurrentObject()->getRefId())
                ) {
                    ilLoggerFactory::getLogger('ac')->debug('Stop local policy for: ' . $role['obj_id']);
                    $role_obj = ilObjectFactory::getInstanceByObjId($role['obj_id']);
                    $role_obj->setParent($this->getCurrentObject()->getRefId());
                    $role_obj->delete();
                    continue;
                }
                // Add local policy
                if ($role['parent'] != $this->getCurrentObject()->getRefId() and isset($_POST['inherit'][$role['obj_id']])) {
                    ilLoggerFactory::getLogger('ac')->debug('Create local policy');
                    $rbacadmin->copyRoleTemplatePermissions(
                        $role['obj_id'],
                        $role['parent'],
                        $this->getCurrentObject()->getRefId(),
                        $role['obj_id']
                    );
                    ilLoggerFactory::getLogger('ac')->debug('Assign role to folder');
                    $rbacadmin->assignRoleToFolder($role['obj_id'], $this->getCurrentObject()->getRefId(), 'n');
                }
            }
        }

        // Protect permissions
        if (ilPermissionGUI::hasContainerCommands($this->getCurrentObject()->getType())) {
            foreach ($roles as $role) {
                if ($rbacreview->isAssignable($role['obj_id'], $this->getCurrentObject()->getRefId())) {
                    if (isset($_POST['protect'][$role['obj_id']]) and
                        !$rbacreview->isProtected($this->getCurrentObject()->getRefId(), $role['obj_id'])) {
                        $rbacadmin->setProtected($this->getCurrentObject()->getRefId(), $role['obj_id'], 'y');
                    } elseif (!isset($_POST['protect'][$role['obj_id']]) and
                        $rbacreview->isProtected($this->getCurrentObject()->getRefId(), $role['obj_id'])) {
                        $rbacadmin->setProtected($this->getCurrentObject()->getRefId(), $role['obj_id'], 'n');
                    }
                }
            }
        }

        $log_new = ilRbacLog::gatherFaPa($this->getCurrentObject()->getRefId(), array_keys((array) $roles));
        $log = ilRbacLog::diffFaPa($log_old, $log_new);
        ilRbacLog::add(ilRbacLog::EDIT_PERMISSIONS, $this->getCurrentObject()->getRefId(), $log);

        $blocked_info = $this->getModifiedBlockedSettings();
        ilLoggerFactory::getLogger('ac')->debug('Blocked settings: ' . print_r($blocked_info, true));
        if ($blocked_info['num'] > 0) {
            return $this->showConfirmBlockRole($blocked_info);
        }


        ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'perm');
        #$this->perm();
    }

Here is the call graph for this function:

savePositionsPermissions()

ilPermissionGUI::savePositionsPermissions ( )

protected

Definition at line 865 of file class.ilPermissionGUI.php.

References $_POST, ilPermission2GUI\__initSubTabs(), ilOrgUnitOperationQueries\findById(), ActiveRecord\getArray(), and getCurrentObject().

    {
        $this->__initSubTabs(self::CMD_PERM_POSITIONS);

        $positions = ilOrgUnitPosition::getArray(null, 'id');
        $ref_id = $this->getCurrentObject()->getRefId();

        // handle local sets
        foreach ($positions as $position_id) {
            if (isset($_POST['local'][$position_id])) {
                ilOrgUnitPermissionQueries::findOrCreateSetForRefId($ref_id, $position_id);
            } else {
                ilOrgUnitPermissionQueries::removeLocalSetForRefId($ref_id, $position_id);
            }
        }

        if ($_POST['position_perm']) {
            foreach ($_POST['position_perm'] as $position_id => $ops) {
                if (!isset($_POST['local'][$position_id])) {
                    continue;
                }
                $ilOrgUnitPermission = ilOrgUnitPermissionQueries::getSetForRefId($ref_id, $position_id);
                $new_ops = [];
                foreach ($ops as $op_id => $op) {
                    $new_ops[] = ilOrgUnitOperationQueries::findById($op_id);
                }
                $ilOrgUnitPermission->setOperations($new_ops);
                $ilOrgUnitPermission->save();
            }
        }
        ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, self::CMD_PERM_POSITIONS);
    }

Here is the call graph for this function:

showConfirmBlockRole()

ilPermissionGUI::showConfirmBlockRole (   $a_blocked_info )

protected

Show block role confirmation screen.

Parameters

array

$a_roles

Returns

Definition at line 433 of file class.ilPermissionGUI.php.

References ilObjRole\_getTranslation(), ilObject\_lookupTitle(), and ilUtil\sendInfo().

Referenced by savePermissions().

    {
        $info = '';
        if ($a_blocked_info['new_blocked']) {
            $info .= $this->lng->txt('role_confirm_block_role_info');
            if ($a_blocked_info['new_unblocked']) {
                $info .= '<br /><br />';
            }
        }
        if ($a_blocked_info['new_unblocked']) {
            $info .= ('<br />' . $this->lng->txt('role_confirm_unblock_role_info'));
        }

        ilUtil::sendInfo($info);

        include_once './Services/Utilities/classes/class.ilConfirmationGUI.php';
        $confirm = new ilConfirmationGUI();
        $confirm->setFormAction($this->ctrl->getFormAction($this));
        $confirm->setHeaderText($this->lng->txt('role_confirm_block_role_header'));
        $confirm->setConfirm($this->lng->txt('role_confirm_block_role'), 'modifyBlockRoles');
        $confirm->setCancel($this->lng->txt('cancel'), 'perm');

        foreach ($a_blocked_info['new_blocked'] as $role_id) {
            include_once './Services/AccessControl/classes/class.ilObjRole.php';
            $confirm->addItem(
                'new_block[]',
                $role_id,
                ilObjRole::_getTranslation(ilObject::_lookupTitle($role_id)) . ' ' . $this->lng->txt('role_blocked')
            );
        }
        foreach ($a_blocked_info['new_unblocked'] as $role_id) {
            include_once './Services/AccessControl/classes/class.ilObjRole.php';
            $confirm->addItem(
                'new_unblock[]',
                $role_id,
                ilObjRole::_getTranslation(ilObject::_lookupTitle($role_id)) . ' ' . $this->lng->txt('role_unblocked')
            );
        }
        $this->tpl->setContent($confirm->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

unblockRoles()

ilPermissionGUI::unblockRoles (   $roles )

protected

Definition at line 486 of file class.ilPermissionGUI.php.

References $DIC, getCurrentObject(), ilObjectFactory\getInstanceByObjId(), ilLoggerFactory\getLogger(), and ilObjRole\MODE_UNPROTECTED_KEEP_LOCAL_POLICIES.

Referenced by modifyBlockRoles().

    {
        global $DIC;

        $rbacadmin = $DIC['rbacadmin'];

        foreach ($roles as $role) {
            // delete local policy
            ilLoggerFactory::getLogger('ac')->debug('Stop local policy for: ' . $role);
            $role_obj = ilObjectFactory::getInstanceByObjId($role);
            $role_obj->setParent($this->getCurrentObject()->getRefId());
            $role_obj->delete();

            $role_obj->changeExistingObjects(
                $this->getCurrentObject()->getRefId(),
                ilObjRole::MODE_UNPROTECTED_KEEP_LOCAL_POLICIES,
                array('all')
            );

            // finally set blocked status
            $rbacadmin->setBlockedStatus(
                $role,
                $this->getCurrentObject()->getRefId(),
                false
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$current_obj

ilPermissionGUI::$current_obj = null

protected

Definition at line 24 of file class.ilPermissionGUI.php.

$recommended_content_manager

ilPermissionGUI::$recommended_content_manager

protected

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

CMD_PERM_POSITIONS

const ilPermissionGUI::CMD_PERM_POSITIONS = 'permPositions'

Definition at line 21 of file class.ilPermissionGUI.php.

Referenced by ilPermission2GUI\__initSubTabs().

CMD_SAVE_POSITIONS_PERMISSIONS

const ilPermissionGUI::CMD_SAVE_POSITIONS_PERMISSIONS = 'savePositionsPermissions'

Definition at line 22 of file class.ilPermissionGUI.php.

Referenced by ilOrgUnitPermissionTableGUI\__construct().

---

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

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