class.ilOrgUnitRecursiveUserAssignmentTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Modules\OrgUnit\ARHelper\BaseCommands;
use ILIAS\Modules\OrgUnit\ARHelper\DropdownBuilder;

class ilOrgUnitRecursiveUserAssignmentTableGUI extends ilTable2GUI
{
    private static array $permission_access_staff_recursive = [];
    private static array $permission_view_lp_recursive = [];
    protected ilAccessHandler $access;
    protected DropdownBuilder $dropdownbuilder;
    protected int $orgu_ref_id;

    public function __construct(
        BaseCommands $parent_obj,
        string $parent_cmd,
        protected ilOrgUnitPosition $position
    ) {
        parent::__construct($parent_obj, $parent_cmd);

        $dic = ilOrgUnitLocalDIC::dic();

        $to_int = $dic['refinery']->kindlyTo()->int();
        $this->orgu_ref_id = $dic['query']->retrieve('ref_id', $to_int);

        $this->access = $dic['access'];
        $this->dropdownbuilder = $dic['dropdownbuilder'];

        $this->setPrefix("il_orgu_" . $position->getId());
        $this->setFormName('il_orgu_' . $position->getId());
        $this->setId("il_orgu_" . $position->getId());
        $this->setFormAction($this->ctrl->getFormAction($parent_obj));
        $this->setTableHeaders();
        $this->setTopCommands(true);
        $this->setEnableHeader(true);
        $this->setShowRowsSelector(true);
        $this->setShowTemplates(false);
        $this->setEnableHeader(true);
        $this->setEnableTitle(true);
        $this->setTitle($position->getTitle());
        $this->setRowTemplate("tpl.staff_row.html", "Modules/OrgUnit");
        $this->setData($this->loadData());
    }

    protected function setTableHeaders(): void
    {
        $this->addColumn($this->lng->txt("login"), "login");
        $this->addColumn($this->lng->txt("firstname"), "first_name");
        $this->addColumn($this->lng->txt("lastname"), "last_name");
        $this->addColumn($this->lng->txt("obj_orgu"), "orgus");
        $this->addColumn($this->lng->txt("action"));
    }


    public function loadData(): array
    {
        global $DIC;
        $access = $DIC['ilAccess'];
        $orgu_tree = ilObjOrgUnitTree::_getInstance();
        $data = [];
        // maybe any parent gives us recursive permission
        (int) $root = (int) ilObjOrgUnit::getRootOrgRefId();
        $parent = (int) $orgu_tree->getParent($this->orgu_ref_id);

        while ($parent !== $root) {
            if (ilObjOrgUnitAccess::_checkAccessStaffRec($parent)) {
                array_merge(
                    self::$permission_access_staff_recursive,
                    $orgu_tree->getAllChildren($parent)
                );
            }
            $parent = (int) $orgu_tree->getParent($parent);
        }

        foreach ($orgu_tree->getAllChildren($this->orgu_ref_id) as $ref_id) {
            $recursive = in_array($ref_id, self::$permission_access_staff_recursive);
            if (!$recursive) {
                // ok, so no permission from above, lets check local permissions
                if (ilObjOrgUnitAccess::_checkAccessStaffRec($ref_id)) {
                    // update recursive permissions
                    array_merge(
                        self::$permission_access_staff_recursive,
                        $orgu_tree->getAllChildren($ref_id)
                    );
                } elseif (!ilObjOrgUnitAccess::_checkAccessStaff($ref_id)) {
                    // skip orgus in which one may not view the staff
                    continue;
                }
            }
            $permission_view_lp = $this->mayViewLPIn($ref_id, $orgu_tree);
            foreach ($orgu_tree->getAssignedUsers([$ref_id], $this->position->getId()) as $usr_id) {
                if (!array_key_exists($usr_id, $data)) {
                    $user = new ilObjUser($usr_id);
                    $set = [
                        'login' => $user->getLogin(),
                        'first_name' => $user->getFirstname(),
                        'last_name' => $user->getLastname(),
                        'user_id' => $usr_id,
                        'active' => $user->getActive(),
                        'orgu_assignments' => [],
                        'view_lp' => false
                    ];
                    $data[$usr_id] = $set;
                } else {
                    $data[$usr_id]["active"] = \ilObjUser::_lookupActive($usr_id);
                }
                $data[$usr_id]['orgu_assignments'][] = ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id));
                $data[$usr_id]['view_lp'] = $permission_view_lp || $data[$usr_id]['view_lp'];
            }
        }

        return $data;
    }

    private function mayViewLPIn(int $ref_id, ilObjOrgUnitTree $orgu_tree): bool
    {
        if ($this->access->checkAccess("view_learning_progress", "", $ref_id)) { // admission by local
            return true;
        }
        $current = $ref_id;
        $root = ilObjOrgUnit::getRootOrgRefId();
        $checked_children = [];
        while ($current !== $root) {
            if (!array_key_exists($current, self::$permission_view_lp_recursive)) {
                self::$permission_view_lp_recursive[$current]
                    = $this->access->checkAccess("view_learning_progress_rec", "", $current);
            }
            if (self::$permission_view_lp_recursive[$current]) {
                // if an orgu may be viewed recursively, same holds for all of its children. lets cache this.
                foreach ($checked_children as $child) {
                    self::$permission_view_lp_recursive[$child] = true;
                }

                return true;
            }
            $checked_children[] = $current;
            $current = (int) $orgu_tree->getParent($current);
        }

        return false;
    }

    public function fillRow(array $a_set): void
    {
        $this->tpl->setVariable("LOGIN", $a_set["login"]);
        $this->tpl->setVariable("FIRST_NAME", $a_set["first_name"]);
        $this->tpl->setVariable("LAST_NAME", $a_set["last_name"]);
        if($a_set["active"] === false) {
            $this->tpl->setVariable("INACTIVE", $this->lng->txt('usr_account_inactive'));
        }

        $orgus = $a_set['orgu_assignments'];
        sort($orgus);
        $this->tpl->setVariable("ORG_UNITS", implode(',', $orgus));


        $this->ctrl->setParameterByClass(ilOrgUnitUserAssignmentGUI::class, 'usr_id', $a_set["user_id"]);
        $this->ctrl->setParameterByClass(
            ilOrgUnitUserAssignmentGUI::class,
            'position_id',
            $this->position->getId()
        );

        $dropdownbuilder = $this->dropdownbuilder
            ->withItem(
                'show_learning_progress',
                $this->ctrl->getLinkTargetByClass([
                    ilAdministrationGUI::class,
                    ilObjOrgUnitGUI::class,
                    ilLearningProgressGUI::class,
                    ], ""),
                $a_set['view_lp']
                && ilObjUserTracking::_enabledLearningProgress()
                && ilObjUserTracking::_enabledUserRelatedData()
            )
            ->withItem(
                'remove',
                $this->ctrl->getLinkTargetByClass(
                    ilOrgUnitUserAssignmentGUI::class,
                    ilOrgUnitUserAssignmentGUI::CMD_CONFIRM_RECURSIVE
                ),
                $this->access->checkAccess("write", "", $this->orgu_ref_id)
            );
        $this->tpl->setVariable("ACTIONS", $dropdownbuilder->get());
    }
}