class.ilRoleAssignmentTableGUI.php

Go to the documentation of this file.

<?php

class ilRoleAssignmentTableGUI extends ilTable2GUI
{
    protected ilPathGUI $path_gui;
    protected array $filter; // Missing array type.
    protected \ILIAS\UI\Factory $factory;
    protected \ILIAS\UI\Renderer $renderer;

    protected ilObjectDefinition $objectDefinition;
    protected bool $edit_access;

    public function __construct(
        object $a_parent_obj,
        string $a_parent_cmd
    ) {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
        $rbacsystem = $DIC['rbacsystem'];
        $this->objectDefinition = $DIC['objDefinition'];
        $this->factory = $DIC->ui()->factory();
        $this->renderer = $DIC->ui()->renderer();


        $lng->loadLanguageModule('rbac');
        $this->setId("usrroleass");

        parent::__construct($a_parent_obj, $a_parent_cmd);

        $this->setTitle($lng->txt("role_assignment"));
        $this->setDefaultOrderField("title");
        $this->setDefaultOrderDirection("asc");
        $this->setDisableFilterHiding(true);
        $this->addColumn("", "", "1", true);
        $this->addColumn($this->lng->txt("role"), "title");
        $this->addColumn($this->lng->txt("description"), "description");
        $this->addColumn($this->lng->txt("context"), "context");
        $this->addColumn($this->lng->txt('path'), 'path');
        $this->edit_access = $rbacsystem->checkAccess("edit_roleassignment", USER_FOLDER_ID);
        $this->initFilter();
        $this->setEnableHeader(true);
        $this->setRowTemplate("tpl.role_assignment_row.html", "Services/User");
        $this->setEnableTitle(true);

        if ($this->edit_access) {
            $this->setSelectAllCheckbox("role_id[]");
            $this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
            $this->addMultiCommand("assignSave", $lng->txt("change_assignment"));
        }

        $this->path_gui = new ilPathGUI();
        $this->getPathGUI()->enableTextOnly(false);
        $this->getPathGUI()->enableHideLeaf(false);
    }

    public function getPathGUI(): ilPathGUI
    {
        return $this->path_gui;
    }

    public function initFilter(): void
    {
        global $DIC;

        $lng = $DIC['lng'];

        // roles
        $option[0] = $lng->txt('assigned_roles');
        $option[1] = $lng->txt('all_roles');
        $option[2] = $lng->txt('all_global_roles');
        $option[3] = $lng->txt('all_local_roles');
        $option[4] = $lng->txt('internal_local_roles_only');
        $option[5] = $lng->txt('non_internal_local_roles_only');

        if ($this->edit_access) {
            $si = new ilSelectInputGUI($lng->txt("roles"), "role_filter");
            $si->setOptions($option);
            $this->addFilterItem($si);
            $si->readFromSession();
            $this->filter["role_filter"] = $si->getValue();
        } else {
            $this->filter["role_filter"] = 0;
        }
    }

    protected function fillRow(array $a_set): void // Missing array type.
    {
        if ($this->edit_access) {
            if (isset($a_set['checkbox']['id'])) {
                $this->tpl->setVariable('VAL_ID', $a_set['checkbox']['id']);
                if ($a_set['checkbox']['disabled']) {
                    $this->tpl->setVariable('VAL_DISABLED', 'disabled="disabled"');
                }
                if ($a_set['checkbox']['checked']) {
                    $this->tpl->setVariable('VAL_CHECKED', 'checked="checked"');
                }
            }
        }

        $this->ctrl->setParameterByClass("ilobjrolegui", "ref_id", $a_set['ref_id']);
        $this->ctrl->setParameterByClass("ilobjrolegui", "obj_id", $a_set["obj_id"]);

        $this->tpl->setVariable(
            'ROLE',
            $this->renderer->render(
                $this->factory->link()->standard(
                    ilObjRole::_getTranslation($a_set['title']),
                    $this->ctrl->getLinkTargetByClass(ilObjRoleGUI::class, 'perm')
                )
            )
        );
        $this->tpl->setVariable('DESCRIPTION', $a_set['description']);
        // Add link to objector local Rores
        $context = $a_set['context'];
        if ($a_set['role_type'] === 'local') {
            $context = $this->renderer->render(
                $this->factory->link()->standard(
                    $context,
                    ilLink::_getLink(
                        $a_set['ref_id'],
                        ilObject::_lookupType(ilObject::_lookupObjId($a_set['ref_id']))
                    )
                )
            );
        }
        $this->tpl->setVariable('CONTEXT', $context);
        $this->tpl->setVariable('PATH', $a_set['path']);
    }

    public function parse(int $usr_id): void
    {
        global $DIC;
        $rbacreview = $DIC->rbac()->review();
        $tree = $DIC->repositoryTree();
        $ilUser = $DIC->user();
        $assignable = false;        // @todo: check this

        $assigned_roles = $rbacreview->assignedRoles($usr_id);

        $counter = 0;

        $records = [];
        foreach ($rbacreview->getRolesByFilter((int) $this->filter['role_filter'], $usr_id) as $role) {
            // fetch context path of role
            $rolf = $rbacreview->getFoldersAssignedToRole($role["obj_id"], true);
            $ref_id = $rbacreview->getObjectReferenceOfRole($role['rol_id']);

            // only list roles that are not set to status "deleted"
            if ($rbacreview->isDeleted($rolf[0])) {
                continue;
            }

            $context = "";
            if ($tree->isInTree($rolf[0])) {
                if ($rolf[0] == ROLE_FOLDER_ID) {
                    $context = $this->lng->txt("global");
                } else {
                    $tmpPath = $tree->getPathFull($rolf[0]);
                    $context = $this->getTitleForReference($ref_id);
                }
            } else {
                $context = "<b>Rolefolder " . $rolf[0] . " not found in tree! (Role " . $role["obj_id"] . ")</b>";
            }

            $disabled = false;
            // disable checkbox for system role for the system user
            if (
                ($usr_id === (int) SYSTEM_USER_ID && $role["obj_id"] === (int) SYSTEM_ROLE_ID) ||
                (!in_array(SYSTEM_ROLE_ID, $rbacreview->assignedRoles($ilUser->getId())) && $role["obj_id"] === (int) SYSTEM_ROLE_ID)
            ) {
                $disabled = true;
            }

            // protected admin role
            if ($role['obj_id'] == SYSTEM_ROLE_ID && !$rbacreview->isAssigned($ilUser->getId(), SYSTEM_ROLE_ID)) {
                if (ilSecuritySettings::_getInstance()->isAdminRoleProtected()) {
                    $disabled = true;
                }
            }

            if (strpos($role["title"], "il_") === 0) {
                if (!$assignable) {
                    $rolf_arr = $rbacreview->getFoldersAssignedToRole($role["obj_id"], true);
                    $rolf2 = $rolf_arr[0];
                } else {
                    $rolf2 = $rolf;
                }

                $parent_node = $tree->getNodeData($rolf2);
                if (!isset($parent_node['type']) || !isset($parent_node['obj_id'])) {
                    continue;
                }
                $role['description'] = "{$this->lng->txt("obj_{$parent_node['type']}")}&nbsp;(#{$parent_node['obj_id']})";
            }

            $role_ids[$counter] = $role["obj_id"];

            $checkbox = [
                'id' => $role['obj_id'],
                'disabled' => $disabled,
                'checked' => in_array($role['obj_id'], $assigned_roles)
            ];

            $title = ilObjRole::_getTranslation($role["title"]);

            $records[] = [
                "description" => $role["description"],
                "context" => $context,
                "checkbox" => $checkbox,
                "role_type" => $role["role_type"],
                "ref_id" => $ref_id,
                "obj_id" => $role["obj_id"],
                "title" => $title,
                'path' => $this->getPathGUI()->getPath(ROOT_FOLDER_ID, $ref_id)
            ];
            ++$counter;
        }
        $this->setData($records);
    }

    protected function getTitleForReference(int $ref_id): string
    {
        $type = ilObject::_lookupType($ref_id, true);
        $obj_id = ilObject::_lookupObjId($ref_id);
        $title = ilObject::_lookupTitle($obj_id);

        if ($this->objectDefinition->isAdministrationObject($type)) {
            return $this->lng->txt('obj_' . $type);
        }

        try {
            $list = ilObjectListGUIFactory::_getListGUIByType($type);
            $list->initItem(
                $ref_id,
                $obj_id,
                $type,
                $title
            );

            ilDatePresentation::setUseRelativeDates(false);
            $title = $list->getTitle();
            ilDatePresentation::resetToDefaults();
            return $title;
        } catch (ilObjectException $e) {
            // could be an administration object
        }
        return $title;
    }
}