class.ilOrgUnitExplorerGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

use ILIAS\UI\Component\Tree\TreeRecursion;

class ilOrgUnitExplorerGUI extends ilTreeExplorerGUI implements TreeRecursion
{
    protected const ORGU = "orgu";
    protected array $stay_with_command = array('', 'render', 'view', 'infoScreen', 'showStaff', 'performPaste', 'cut');
    protected ?ilTree $tree = null;
    protected ilAccessHandler $access;
    private ilSetting $settings;
    protected ILIAS\HTTP\Wrapper\RequestWrapper $http_post;
    protected ILIAS\HTTP\Wrapper\RequestWrapper $http_query;
    protected ILIAS\Refinery\Factory $refinery;

    public function __construct($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree, \ilAccessHandler $access = null)
    {
        global $DIC;
        parent::__construct($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree);
        $this->setAjax(true);
        $this->setTypeWhiteList(array(self::ORGU));
        $this->tree->initLangCode();
        $this->access = $DIC->access();
        $this->settings = $DIC->settings();
        $this->http_post = $DIC->http()->wrapper()->post();
        $this->http_query = $DIC->http()->wrapper()->query();
        $this->refinery = $DIC["refinery"];
    }

    public function getNodeContent($a_node): string
    {
        $node = $this->getNodeArrayRepresentation($a_node);

        if ($node['title'] === '__OrgUnitAdministration') {
            $node['title'] = $this->lng->txt('objs_orgu');
        }
        if ((int) $node['child'] === (int) $_GET['ref_id']) {
            return "<span class='ilExp2NodeContent ilHighlighted'>" . $node['title'] . '</span>';
        }

        return ilUtil::secureString($node['title']);
    }

    public function getRootNode(): array
    {
        return $this->getTree()->getNodeData(ilObjOrgUnit::getRootOrgRefId());
    }

    public function getNodeIcon($a_node): string
    {
        $node = $this->getNodeArrayRepresentation($a_node);

        $obj_id = 0;
        if ($this->settings->get('custom_icons')) {
            $icons_cache = ilObjOrgUnit::getIconsCache();
            $obj_id = ilObject::_lookupObjId($node["child"]);
            if (isset($icons_cache[$obj_id])) {
                return $icons_cache[$obj_id];
            }
        }

        return ilObject::_getIcon($obj_id, "tiny", $node["type"]);
    }

    public function getNodeHref($a_node): string
    {
        $node = $this->getNodeArrayRepresentation($a_node);

        if ($this->select_postvar) {
            return '#';
        }

        if ($this->ctrl->getCmd() === 'performPaste') {
            $this->ctrl->setParameterByClass(ilObjOrgUnitGUI::class, 'target_node', $node['child']);
        }
        $array = $this->ctrl->getParameterArrayByClass(ilObjOrgUnitGUI::class);
        $temp = $array['ref_id'];

        $this->ctrl->setParameterByClass(ilObjOrgUnitGUI::class, 'ref_id', $node['child']);
        $this->ctrl->setParameterByClass(ilObjPluginDispatchGUI::class, 'ref_id', $node['child']);

        $link_target = ($node['type'] === self::ORGU) ? $this->getLinkTarget() : $this->getPluginLinkTarget();
        $this->ctrl->setParameterByClass(ilObjOrgUnitGUI::class, 'ref_id', $temp);
        return $link_target;
    }

    protected function getLinkTarget(): string
    {
        if ($this->ctrl->getCmdClass() === strtolower(ilObjOrgUnitGUI::class) && in_array(
            $this->ctrl->getCmd(),
            $this->stay_with_command,
            true
        )) {
            return $this->ctrl->getLinkTargetByClass(
                array(ilAdministrationGUI::class, $this->ctrl->getCmdClass()),
                $this->ctrl->getCmd()
            );
        }

        return $this->ctrl->getLinkTargetByClass(array(ilAdministrationGUI::class, ilObjOrgUnitGUI::class), 'view');
    }

    protected function getPluginLinkTarget(): string
    {
        return $this->ctrl->getLinkTargetByClass(ilObjPluginDispatchGUI::class, 'forward');
    }

    public function isNodeClickable($a_node): bool
    {
        $node = $this->getNodeArrayRepresentation($a_node);

        $node = $this->getNodeArrayRepresentation($a_node);

        if ($this->access->checkAccess('read', '', $node['ref_id'])) {
            return true;
        }

        return false;
    }


    public function isNodeSelectable($a_node): bool
    {
        $r = $this->refinery;
        if ($this->http_post->has("id")) {
            // Node selected via multiselect in "manage".
            $selected_nodes = $this->http_post->retrieve(
                "id",
                $r->kindlyTo()->listOf($r->kindlyTo()->int()),
            );
        } elseif ($this->http_query->has("item_ref_id")) {
            // Node selected via "move"-action.
            $selected_nodes = $this->http_query->retrieve(
                "item_ref_id",
                $r->kindlyTo()->listOf($r->kindlyTo()->int()),
            );
        } else {
            // No node selected.
            return true;
        }

        $node = $this->getNodeArrayRepresentation($a_node);
        foreach ($selected_nodes as $sn) {
            // Can't insert into itself.
            if ($node["child"] == $sn) {
                return false;
            }
            // Can't insert below itself.
            if ($this->tree->isGrandChild($sn, $node["child"])) {
                return false;
            }
        }
        return true;
    }

    private function getNodeArrayRepresentation($a_node): array
    {
        if (is_object($a_node)) {
            return (array) $a_node;
        }

        return $a_node;
    }

    public function getChildsOfNode($a_parent_node_id): array
    {
        $children = parent::getChildsOfNode($a_parent_node_id);
        return $this->filterChildrenByPermission($children);
    }

    protected function filterChildrenByPermission(array $children): array
    {
        return array_filter(
            $children,
            function ($child) {
                return $this->access->checkAccess("visible", "", $child["ref_id"]);
            }
        );
    }
}