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 (object $a_gui_obj)
	executeCommand ()
	Execute command. More...
	getCurrentObject ()
	perm (ilTable2GUI $table=null)
	applyRoleFilter (array $a_roles, int $a_filter_id)
Public Member Functions inherited from ilPermission2GUI
	__construct (object $a_gui_obj)
	owner ()
	changeOwner ()
	__initSubTabs (string $a_cmd)
	log ()
	applyLogFilter ()
	resetLogFilter ()

Static Public Member Functions
static	hasContainerCommands (string $a_type)

Data Fields
const	CMD_SAVE_POSITIONS_PERMISSIONS = 'savePositionsPermissions'

Protected Member Functions
	confirmTemplateSwitch ()
	Called after toolbar action applyTemplateSwitch. More...
	isAdminRoleFolder ()
	isAdministrationObject ()
	isInAdministration ()
	Check if node is subobject of administration folder. More...
	applyFilter ()
	resetFilter ()
	savePermissions ()
	showConfirmBlockRole (array $a_blocked_info)
	modifyBlockRoles ()
	unblockRoles ($roles)
	blockRoles ($roles)
	displayImportRoleForm (ilPropertyFormGUI $form=null)
	doImportRole ()
	initImportForm ()
	init import form More...
	initRoleForm ()
	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
const	CMD_PERM_POSITIONS = 'permPositions'
object	$current_obj
ilRecommendedContentManager	$recommended_content_manager
ilToolbarGUI	$toolbar
UIFactory	$ui_factory
ILIAS HTTP Wrapper WrapperFactory	$wrapper
ilOrgUnitPositionDBRepository	$positionRepo
ilOrgUnitPermissionDBRepository	$permissionRepo
ilOrgUnitOperationDBRepository	$operationRepo
Protected Attributes inherited from ilPermission2GUI
object	$gui_obj
ilErrorHandling	$ilErr
ilCtrl	$ctrl
ilLanguage	$lng
ilObjectDefinition	$objDefinition
ilGlobalTemplateInterface	$tpl
ilRbacSystem	$rbacsystem
ilRbacReview	$rbacreview
ilRbacAdmin	$rbacadmin
ilObjectDataCache	$objectDataCache
ilTabsGUI	$tabs
GlobalHttpState	$http
Factory	$refinery

Private Member Functions
	getPositionRepo ()
	getPermissionRepo ()
	getOperationRepo ()

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 34 of file class.ilPermissionGUI.php.

Constructor & Destructor Documentation

__construct()

ilPermissionGUI::__construct

(

object

$a_gui_obj

)

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), and ILIAS\Repository\toolbar().

    {
        global $DIC;

        $this->wrapper = $DIC->http()->wrapper();
        $this->toolbar = $DIC['ilToolbar'];
        $this->ui_factory = $DIC['ui.factory'];
        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: change this bahaviour

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

References ILIAS\Repository\ctrl(), getCurrentObject(), initRoleForm(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilObjRole\MODE_PROTECTED_KEEP_LOCAL_POLICIES, and ilObjRole\MODE_UNPROTECTED_KEEP_LOCAL_POLICIES.

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

            $role = new ilObjRole();
            $role->setTitle($new_title);
            $role->setDescription($form->getInput('desc'));
            $role->create();

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

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

            // copy rights
            $right_id_to_copy = (int) $form->getInput("rights");
            if ($right_id_to_copy) {
                $parentRoles = $this->rbacreview->getParentRoleIds($this->getCurrentObject()->getRefId(), true);
                $this->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,
                            ['all']
                        );
                    } else {
                        $role->changeExistingObjects(
                            $this->getCurrentObject()->getRefId(),
                            ilObjRole::MODE_UNPROTECTED_KEEP_LOCAL_POLICIES,
                            ['all']
                        );
                    }
                }
            }

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

            $this->tpl->setOnScreenMessage('success', $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

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

References getCurrentObject(), and perm().

                                    : void
    {
        $table = new ilObjectRolePermissionTableGUI($this, 'perm', $this->getCurrentObject()->getRefId());
        $table->resetOffset();
        $table->writeFilterToSession();
        $this->perm($table);
    }

Here is the call graph for this function:

applyRoleFilter()

ilPermissionGUI::applyRoleFilter	(	array	$a_roles,
		int	$a_filter_id
	)

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

References 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().

                                                                     : array
    {
        // 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 = $this->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 = $this->rbacreview->getGlobalRoles();
                foreach ($arr_global_roles as $role_id) {
                    unset($a_roles[$role_id]);
                }
                return $a_roles;

                // only roles which use a local policy
            case ilObjectRolePermissionTableGUI::ROLE_FILTER_LOCAL_POLICY:
                $arr_local_roles = $this->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 = $this->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

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

References ilPermission2GUI\$roles, and getCurrentObject().

Referenced by modifyBlockRoles().

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

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

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

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

            // finally set blocked status
            $this->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 151 of file class.ilPermissionGUI.php.

References ILIAS\Repository\ctrl().

                                              : void
    {
        $this->ctrl->setReturn($this, 'perm');
        $this->ctrl->setCmdClass('ildidactictemplategui');
        $dtpl_gui = new ilDidacticTemplateGUI($this->gui_obj);
        $this->ctrl->forwardCommand($dtpl_gui);
    }

Here is the call graph for this function:

displayAddRoleForm()

ilPermissionGUI::displayAddRoleForm ( )

protected

Show add role form.

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

References initRoleForm(), and ILIAS\Repository\tabs().

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

Here is the call graph for this function:

displayImportRoleForm()

ilPermissionGUI::displayImportRoleForm ( ilPropertyFormGUI  $form = null )

protected

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

References initImportForm(), and ILIAS\Repository\tabs().

Referenced by doImportRole().

                                                                            : void
    {
        $this->tabs->clearTargets();

        if (!$form) {
            $form = $this->initImportForm();
        }
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doImportRole()

ilPermissionGUI::doImportRole ( )

protected

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

References Vendor\Package\$e, ILIAS\Repository\ctrl(), displayImportRoleForm(), getCurrentObject(), initImportForm(), and ILIAS\Repository\lng().

                                     : void
    {
        $form = $this->initImportForm();
        if ($form->checkInput()) {
            try {
                // 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',
                    (string) $this->getCurrentObject()->getRefId()
                );

                $imp->importObject(
                    null,
                    $_FILES["importfile"]["tmp_name"],
                    $_FILES["importfile"]["name"],
                    'role'
                );
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('rbac_role_imported'), true);
                $this->ctrl->redirect($this, 'perm');
                return;
            } catch (Exception $e) {
                $this->tpl->setOnScreenMessage('failure', $e->getMessage());
                $form->setValuesByPost();
                $this->displayImportRoleForm($form);
                return;
            }
        }
        $form->setValuesByPost();
        $this->tpl->setOnScreenMessage('failure', $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 95 of file class.ilPermissionGUI.php.

References ilPermission2GUI\__initSubTabs(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                    : void
    {
        // access to all functions in this class are only allowed if edit_permission is granted
        if (!$this->rbacsystem->checkAccess("edit_permission", $this->gui_obj->getObject()->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":

                $role_id = 0;
                if ($this->http->wrapper()->query()->has('obj_id')) {
                    $role_id = $this->http->wrapper()->query()->retrieve(
                        'obj_id',
                        $this->refinery->kindlyTo()->int()
                    );
                }
                $this->ctrl->setReturn($this, 'perm');
                $this->gui_obj = new ilObjRoleGUI("", $role_id, false, false);
                $this->ctrl->forwardCommand($this->gui_obj);
                break;

            case 'ildidactictemplategui':
                $this->ctrl->setReturn($this, 'perm');
                $did = new ilDidacticTemplateGUI($this->gui_obj);
                $this->ctrl->forwardCommand($did);
                break;

            case 'ilrepositorysearchgui':
                // used for owner autocomplete
                $rep_search = new ilRepositorySearchGUI();
                $this->ctrl->forwardCommand($rep_search);
                break;

            case 'ilobjectpermissionstatusgui':
                $this->__initSubTabs("perminfo");
                $perm_stat = new ilObjectPermissionStatusGUI($this->gui_obj->getObject());
                $this->ctrl->forwardCommand($perm_stat);
                break;

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

Here is the call graph for this function:

getCurrentObject()

ilPermissionGUI::getCurrentObject

(

)

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

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

                                      : object
    {
        return $this->gui_obj->getObject();
    }

Here is the caller graph for this function:

getModifiedBlockedSettings()

ilPermissionGUI::getModifiedBlockedSettings ( )

protected

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

References $DIC, ilPermission2GUI\$rbacreview, getCurrentObject(), ilRbacReview\isBlockedAtPosition(), and ILIAS\Repository\refinery().

Referenced by savePermissions().

                                                   : array
    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];

        $blocked_info['new_blocked'] = [];
        $blocked_info['new_unblocked'] = [];
        $blocked_info['num'] = 0;
        $visible_block = $this->wrapper->post()->has('visible_block')
            ? $this->wrapper->post()->retrieve(
                'visible_block',
                $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->int())
            )
            : [];
        $block_post = $this->wrapper->post()->has('block')
            ? $this->wrapper->post()->retrieve(
                'block',
                $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->int())
            )
            : [];


        foreach ($visible_block as $role => $one) {
            $blocked = $rbacreview->isBlockedAtPosition($role, $this->getCurrentObject()->getRefId());
            if (isset($block_post[$role]) && !$blocked) {
                $blocked_info['new_blocked'][] = $role;
                $blocked_info['num']++;
            }
            if (!isset($block_post[$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:

getOperationRepo()

ilPermissionGUI::getOperationRepo ( )

private

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

References $dic, $operationRepo, and ilOrgUnitLocalDIC\dic().

Referenced by savePositionsPermissions().

                                       : ilOrgUnitOperationDBRepository
    {
        if (!isset($this->operationRepo)) {
            $dic = ilOrgUnitLocalDIC::dic();
            $this->operationRepo = $dic["repo.Operations"];
        }

        return $this->operationRepo;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPermissionRepo()

ilPermissionGUI::getPermissionRepo ( )

private

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

References $dic, $permissionRepo, and ilOrgUnitLocalDIC\dic().

Referenced by savePositionsPermissions().

                                        : ilOrgUnitPermissionDBRepository
    {
        if (!isset($this->permissionRepo)) {
            $dic = ilOrgUnitLocalDIC::dic();
            $this->permissionRepo = $dic["repo.Permissions"];
        }

        return $this->permissionRepo;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPositionRepo()

ilPermissionGUI::getPositionRepo ( )

private

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

References $dic, $positionRepo, and ilOrgUnitLocalDIC\dic().

Referenced by savePositionsPermissions().

                                      : ilOrgUnitPositionDBRepository
    {
        if (!isset($this->positionRepo)) {
            $dic = ilOrgUnitLocalDIC::dic();
            $this->positionRepo = $dic["repo.Positions"];
        }

        return $this->positionRepo;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasContainerCommands()

static ilPermissionGUI::hasContainerCommands ( string  $a_type )

static

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

References $DIC, ilPermission2GUI\$objDefinition, and ilObjectDefinition\isContainer().

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

                                                               : bool
    {
        global $DIC;

        $objDefinition = $DIC['objDefinition'];
        return $objDefinition->isContainer($a_type) && $a_type != 'root' && $a_type != 'adm' && $a_type != 'rolf';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initImportForm()

ilPermissionGUI::initImportForm ( )

protected

init import form

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

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setRequired().

Referenced by displayImportRoleForm(), and doImportRole().

                                       : ilPropertyFormGUI
    {
        $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->setRequired(true);
        $zip->setSuffixes(['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

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

References $check, $id, ILIAS\LTI\ToolProvider\$key, $rights, ilObjRole\_getTranslation(), ilUtil\_sortIds(), ILIAS\Repository\ctrl(), getCurrentObject(), isInAdministration(), ILIAS\Repository\lng(), ilTextAreaInputGUI\setCols(), ilFormPropertyGUI\setInfo(), and SYSTEM_ROLE_ID.

Referenced by addRole(), and displayAddRoleForm().

                                     : ilPropertyFormGUI
    {
        $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((string) 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"), (string) 0);
            $rights->addOption($option);

            $parent_role_ids = $this->rbacreview->getParentRoleIds($this->gui_obj->getObject()->getRefId(), true);
            $ids = [];
            foreach (array_keys($parent_role_ids) as $id) {
                $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) {
                    $option = new ilRadioOption(
                        ($par["type"] == 'role' ? $this->lng->txt('obj_role') : $this->lng->txt(
                            'obj_rolt'
                        )) . ": " . ilObjRole::_getTranslation($par["title"]),
                        (string) $par["obj_id"]
                    );
                    $option->setInfo($par["desc"] ?? '');
                    $rights->addOption($option);
                }
                $key++;
            }
            $form->addItem($rights);
        }

        // Local policy only for containers
        if ($this->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 203 of file class.ilPermissionGUI.php.

References getCurrentObject().

Referenced by perm().

                                               : bool
    {
        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

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

References getCurrentObject(), and ROLE_FOLDER_ID.

Referenced by perm().

                                          : bool
    {
        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.

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

References $GLOBALS, getCurrentObject(), and SYSTEM_FOLDER_ID.

Referenced by initRoleForm().

                                           : bool
    {
        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 484 of file class.ilPermissionGUI.php.

References blockRoles(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and unblockRoles().

                                         : void
    {
        $this->blockRoles(
            $this->wrapper->post()->has('new_block')
                ? $this->wrapper->post()->retrieve(
                    'new_block',
                    $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->int())
                )
                : []
        );
        $this->unblockRoles($this->wrapper->post()->has('new_unblock')
            ? $this->wrapper->post()->retrieve(
                'new_unblock',
                $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->int())
            )
            : []);

        $this->tpl->setOnScreenMessage('info', $this->lng->txt('settings_saved'));
        $this->ctrl->redirect($this, 'perm');
    }

Here is the call graph for this function:

perm()

ilPermissionGUI::perm

(

ilTable2GUI

$table = null

)

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

References ilPermission2GUI\__initSubTabs(), ILIAS\Repository\ctrl(), getCurrentObject(), isAdministrationObject(), isAdminRoleFolder(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by applyFilter(), and resetFilter().

                                                   : void
    {
        $dtpl = new ilDidacticTemplateGUI($this->gui_obj);
        if ($dtpl->appendToolbarSwitch(
            $this->toolbar,
            $this->getCurrentObject()->getType(),
            $this->getCurrentObject()->getRefId()
        )) {
            $this->toolbar->addSeparator();
        }

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

            if (!$this->isAdminRoleFolder()) {
                $this->toolbar->addComponent(
                    $this->ui_factory->link()->standard(
                        $this->lng->txt('rbac_add_new_local_role'),
                        $this->ctrl->getLinkTarget($this, 'displayAddRoleForm')
                    )
                );
            }
            $this->toolbar->addComponent(
                $this->ui_factory->link()->standard(
                    $this->lng->txt('rbac_import_role'),
                    $this->ctrl->getLinkTarget($this, 'displayImportRoleForm')
                )
            );
        }
        $this->__initSubTabs("perm");

        if (!$table instanceof ilTable2GUI) {
            $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 831 of file class.ilPermissionGUI.php.

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

                                      : void
    {
        $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

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

References getCurrentObject(), and perm().

                                    : void
    {
        $table = new ilObjectRolePermissionTableGUI($this, 'perm', $this->getCurrentObject()->getRefId());
        $table->resetOffset();
        $table->resetFilter();
        $this->perm($table);
    }

Here is the call graph for this function:

savePermissions()

ilPermissionGUI::savePermissions ( )

protected

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

References $DIC, $log, ilPermission2GUI\$objDefinition, ilPermission2GUI\$rbacadmin, ilPermission2GUI\$rbacreview, ilPermission2GUI\$roles, ilRbacLog\add(), applyRoleFilter(), ilRbacAdmin\assignRoleToFolder(), ilRbacAdmin\copyRoleTemplatePermissions(), ILIAS\Repository\ctrl(), ilRbacLog\diffFaPa(), ilRbacLog\EDIT_PERMISSIONS, ilRbacLog\gatherFaPa(), ilObjectDefinition\getCreatableSubObjects(), getCurrentObject(), ilObjectFactory\getInstanceByObjId(), ilLoggerFactory\getLogger(), getModifiedBlockedSettings(), ilRbacReview\getOperationsByTypeAndClass(), ilRbacReview\getParentRoleIds(), ilRbacReview\getRoleOperationsOnObject(), ilRbacAdmin\grantPermission(), hasContainerCommands(), ILIAS\Repository\int(), ilRbacReview\isAssignable(), ilRbacReview\isBlockedAtPosition(), ilRbacReview\isProtected(), ILIAS\Repository\lng(), ilRbacReview\lookupCreateOperationIds(), ILIAS\Repository\refinery(), ilRbacAdmin\revokePermission(), ilRbacAdmin\setProtected(), and showConfirmBlockRole().

                                        : void
    {
        global $DIC;

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

        $table = new ilObjectRolePermissionTableGUI($this, 'perm', $this->getCurrentObject()->getRefId());

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

        // Log history
        $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));

        $post_perm = $this->wrapper->post()->has('perm')
            ? $this->wrapper->post()->retrieve(
                'perm',
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->dictOf(
                        $this->refinery->kindlyTo()->int()
                    )
                )
            )
            : [];

        foreach ($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())) {
            $inherit_post = $this->wrapper->post()->has('inherit')
                ? $this->wrapper->post()->retrieve(
                    'inherit',
                    $this->refinery->kindlyTo()->dictOf(
                        $this->refinery->kindlyTo()->bool()
                    )
                )
                : [];

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

        // Protect permissions
        if (ilPermissionGUI::hasContainerCommands($this->getCurrentObject()->getType())) {
            $protected_post = $this->wrapper->post()->has('protect')
                ? $this->wrapper->post()->retrieve(
                    'protect',
                    $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->int())
                )
                : [];
            foreach ($roles as $role) {
                $obj_id = (int) $role['obj_id'];
                if ($rbacreview->isAssignable($obj_id, $this->getCurrentObject()->getRefId())) {
                    if (isset($protected_post[$obj_id]) &&
                        !$rbacreview->isProtected($this->getCurrentObject()->getRefId(), $obj_id)) {
                        $rbacadmin->setProtected($this->getCurrentObject()->getRefId(), $obj_id, 'y');
                    } elseif (!isset($protected_post[$obj_id]) &&
                        $rbacreview->isProtected($this->getCurrentObject()->getRefId(), $obj_id)) {
                        $rbacadmin->setProtected($this->getCurrentObject()->getRefId(), $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) {
            $this->showConfirmBlockRole($blocked_info);
            return;
        }
        $this->tpl->setOnScreenMessage('success', $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 842 of file class.ilPermissionGUI.php.

References $ref_id, ilPermission2GUI\__initSubTabs(), ILIAS\Repository\ctrl(), getCurrentObject(), getOperationRepo(), getPermissionRepo(), getPositionRepo(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

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

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

        // handle local sets
        $positions_with_local_perms_from_post = $this->wrapper->post()->has('local')
            ? $this->wrapper->post()->retrieve(
                'local',
                $this->refinery->kindlyTo()->dictOf($this->refinery->kindlyTo()->int())
            )
            : [];

        foreach ($positions as $position_id) {
            if (isset($positions_with_local_perms_from_post[$position_id])) {
                $this->getPermissionRepo()->get($ref_id, $position_id);
            } else {
                $this->getPermissionRepo()->delete($ref_id, $position_id);
            }
        }

        $position_perm_post = $this->wrapper->post()->has('position_perm')
            ? $this->wrapper->post()->retrieve(
                'position_perm',
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->dictOf(
                        $this->refinery->kindlyTo()->int()
                    )
                )
            )
            : [];

        foreach ($position_perm_post as $position_id => $ops) {
            if (!isset($positions_with_local_perms_from_post[$position_id])) {
                continue;
            }
            $org_unit_permissions = $this->getPermissionRepo()->getLocalorDefault($ref_id, $position_id);
            if (!$org_unit_permissions->isTemplate()) {
                $new_ops = [];
                foreach ($ops as $op_id => $op) {
                    $new_ops[] = $this->getOperationRepo()->getById($op_id);
                }
                $org_unit_permissions = $this->getPermissionRepo()->store(
                    $org_unit_permissions->withOperations($new_ops)
                );
            }
        }

        foreach (array_keys($positions_with_local_perms_from_post) as $position_id_from_post) {
            if (array_key_exists($position_id_from_post, $position_perm_post)) {
                continue;
            }
            $org_unit_permissions = $this->getPermissionRepo()->find($ref_id, $position_id_from_post);
            if ($org_unit_permissions !== null && !$org_unit_permissions->isTemplate()) {
                $this->getPermissionRepo()->store($org_unit_permissions->withOperations([]));
            }
        }

        $this->tpl->setOnScreenMessage('success', $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 ( array  $a_blocked_info )

protected

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

References ilObjRole\_getTranslation(), ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by savePermissions().

                                                                  : void
    {
        $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'));
        }

        $this->tpl->setOnScreenMessage('info', $info);

        $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) {
            $confirm->addItem(
                'new_block[]',
                (string) $role_id,
                ilObjRole::_getTranslation(ilObject::_lookupTitle($role_id)) . ' ' . $this->lng->txt('role_blocked')
            );
        }
        foreach ($a_blocked_info['new_unblocked'] as $role_id) {
            $confirm->addItem(
                'new_unblock[]',
                (string) $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 508 of file class.ilPermissionGUI.php.

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

Referenced by modifyBlockRoles().

                                           : void
    {
        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,
                ['all']
            );

            // finally set blocked status
            $this->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

object ilPermissionGUI::$current_obj

protected

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

$operationRepo

ilOrgUnitOperationDBRepository ilPermissionGUI::$operationRepo

protected

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

Referenced by getOperationRepo().

$permissionRepo

ilOrgUnitPermissionDBRepository ilPermissionGUI::$permissionRepo

protected

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

Referenced by getPermissionRepo().

$positionRepo

ilOrgUnitPositionDBRepository ilPermissionGUI::$positionRepo

protected

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

Referenced by getPositionRepo().

$recommended_content_manager

ilRecommendedContentManager ilPermissionGUI::$recommended_content_manager

protected

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

$toolbar

ilToolbarGUI ilPermissionGUI::$toolbar

protected

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

$ui_factory

UIFactory ilPermissionGUI::$ui_factory

protected

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

$wrapper

ILIAS HTTP Wrapper WrapperFactory ilPermissionGUI::$wrapper

protected

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

CMD_PERM_POSITIONS

const ilPermissionGUI::CMD_PERM_POSITIONS = 'permPositions'

protected

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

Referenced by ilPermission2GUI\__initSubTabs().

CMD_SAVE_POSITIONS_PERMISSIONS

const ilPermissionGUI::CMD_SAVE_POSITIONS_PERMISSIONS = 'savePositionsPermissions'

Definition at line 37 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