class.ilVirtualSkillTreeExplorerGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Skill\Tree\SkillTreeManager;
use ILIAS\Skill\Service\SkillInternalFactoryService;

class ilVirtualSkillTreeExplorerGUI extends ilExplorerBaseGUI implements \ILIAS\UI\Component\Tree\TreeRecursion
{
    protected \ILIAS\DI\UIServices $ui;
    protected ilLanguage $lng;
    protected ilVirtualSkillTree $vtree;
    protected SkillTreeManager $skill_tree_manager;
    protected SkillInternalFactoryService $tree_factory;

    protected bool $show_draft_nodes = false;
    protected bool $show_outdated_nodes = false;

    public function __construct(string $a_id, $a_parent_obj, string $a_parent_cmd, int $tree_id = 0)
    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->ui = $DIC->ui();
        parent::__construct($a_id, $a_parent_obj, $a_parent_cmd);

        $this->skill_tree_manager = $DIC->skills()->internal()->manager()->getTreeManager();
        $this->tree_factory = $DIC->skills()->internal()->factory();

        if ($tree_id == 0) {
            $this->vtree = $this->tree_factory->tree()->getGlobalVirtualTree();
        } else {
            $this->vtree = $this->tree_factory->tree()->getVirtualTreeById($tree_id);
        }

        $this->setSkipRootNode(false);
        $this->setAjax(false);
    }

    public function setShowDraftNodes(bool $a_val): void
    {
        $this->show_draft_nodes = $a_val;
        $this->vtree->setIncludeDrafts($a_val);
    }

    public function getShowDraftNodes(): bool
    {
        return $this->show_draft_nodes;
    }

    public function setShowOutdatedNodes(bool $a_val): void
    {
        $this->show_outdated_nodes = $a_val;
        $this->vtree->setIncludeOutdated($a_val);
    }

    public function getShowOutdatedNodes(): bool
    {
        return $this->show_outdated_nodes;
    }

    public function getRootNode(): array
    {
        return $this->vtree->getRootNode();
    }

    public function getNodeId($a_node): string
    {
        return (string) $a_node["id"];
    }

    public function getDomNodeIdForNodeId($a_node_id): string
    {
        return parent::getDomNodeIdForNodeId(str_replace(":", "_", $a_node_id));
    }

    public function getNodeIdForDomNodeId(string $a_dom_node_id): string
    {
        $id = parent::getNodeIdForDomNodeId($a_dom_node_id);
        return str_replace("_", ":", $id);
    }

    public function getChildsOfNode($a_parent_node_id): array
    {
        return $this->vtree->getChildsOfNode($a_parent_node_id);
    }

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

        $a_parent_id_parts = explode(":", (string) $a_node["id"]);
        $a_parent_skl_tree_id = (int) $a_parent_id_parts[0];
        $a_parent_skl_template_tree_id = isset($a_parent_id_parts[1]) ? (int) $a_parent_id_parts[1] : 0;

        // title
        if ((int) $a_node["parent"] == 0) {
            $tree_obj = $this->skill_tree_manager->getTree($a_node["skl_tree_id"]);
            $title = $tree_obj->getTitle();
        } else {
            $title = $a_node["title"];
        }

        // root?
        if ($a_node["type"] == "skrt") {
            $lng->txt("skmg_skills");
        }

        return $title;
    }

    public function getNodeIcon($a_node): string
    {
        $a_id_parts = explode(":", (string) $a_node["id"]);
        $a_skl_template_tree_id = isset($a_id_parts[1]) ? (int) $a_id_parts[1] : 0;

        // root?
        if ($a_node["type"] == "skrt") {
            $icon = ilUtil::getImagePath("standard/icon_scat.svg");
        } else {
            $type = $a_node["type"];
            if ($type == "sktr") {
                $type = ilSkillTreeNode::_lookupType($a_skl_template_tree_id);
            }
            if ($type == "sktp") {
                $type = "skll";
            }
            if ($type == "sctp") {
                $type = "scat";
            }
            $icon = ilUtil::getImagePath("standard/icon_" . $type . ".svg");
        }

        return $icon;
    }

    public function getNodeHref($a_node): string
    {
        $ilCtrl = $this->ctrl;

        // we have a tree id like <skl_tree_id>:<skl_template_tree_id> here
        // use this, if you want a "common" skill id in format <skill_id>:<tref_id>
        $id_parts = explode(":", (string) $a_node["id"]);
        if (!isset($id_parts[1]) || $id_parts[1] == 0) {
            // skill in main tree
            $skill_id = $a_node["id"];
        } else {
            // skill in template
            $skill_id = $id_parts[1] . ":" . $id_parts[0];
        }

        return "";
    }

    public function isNodeClickable($a_node): bool
    {
        return false;
    }

    public function getNodeIconAlt($a_node): string
    {
        $lng = $this->lng;

        if ($lng->exists("skmg_" . $a_node["type"])) {
            return $lng->txt("skmg_" . $a_node["type"]);
        }

        return $lng->txt($a_node["type"]);
    }

    public function getHTML(): string
    {
        return $this->render();
    }

    protected function render(): string
    {
        $r = $this->ui->renderer();

        return $r->render([
            $this->getTreeComponent()
        ]);
    }

    public function getTreeComponent(): \ILIAS\UI\Implementation\Component\Tree\Tree
    {
        $f = $this->ui->factory();
        $tree = $this->vtree;

        if (!$this->getSkipRootNode()) {
            $data = array(
                $tree->getRootNode()
            );
        } else {
            $data = $tree->getChildsOfNode((string) ($tree->getRootNode()["id"]));
        }

        //$label = $this->vtree->getNodeTitle($tree->getRootNode());
        //if ($label === "" && $this->getNodeContent($this->getRootNode())) {
        //            $label = $this->getNodeContent($this->getRootNode());
        //}
        $label = "test";

        $tree = $f->tree()->expandable($label, $this)
                  ->withData($data)
                  ->withHighlightOnNodeClick(true);

        return $tree;
    }

    public function getChildren($record, $environment = null): array
    {
        return $this->getChildsOfNode((string) $record["id"]);
    }

    protected function createNode(
        \ILIAS\UI\Component\Tree\Node\Factory $factory,
        $record
    ): \ILIAS\UI\Component\Tree\Node\Node {
        $nodeIconPath = $this->getNodeIcon($record);

        $icon = null;
        if ($nodeIconPath !== '') {
            $icon = $this->ui
                ->factory()
                ->symbol()
                ->icon()
                ->custom($nodeIconPath, $this->getNodeIconAlt($record));
        }

        return $factory->simple($this->getNodeContent($record), $icon);
    }

    public function build(
        \ILIAS\UI\Component\Tree\Node\Factory $factory,
        $record,
        $environment = null
    ): \ILIAS\UI\Component\Tree\Node\Node {
        $node = $this->createNode($factory, $record);

        $href = $this->getNodeHref($record);
        if ($href !== '' && '#' !== $href && $this->isNodeClickable($record)) {
            $node = $node->withLink(new \ILIAS\Data\URI(ILIAS_HTTP_PATH . '/' . $href));
        }

        if ($this->isNodeOpen((int) $this->getNodeId($record))) {
            $node = $node->withExpanded(true);
        }

        /*
        $nodeStateToggleCmdClasses = $this->getNodeStateToggleCmdClasses($record);
        $cmdClass = end($nodeStateToggleCmdClasses);

        if (is_string($cmdClass) && $cmdClass !== '') {
            $node = $node->withAdditionalOnLoadCode(function ($id) use ($record, $nodeStateToggleCmdClasses, $cmdClass): string {
                $serverNodeId = $this->getNodeId($record);

                $this->ctrl->setParameterByClass($cmdClass, $this->node_parameter_name, $serverNodeId);
                $url = $this->ctrl->getLinkTargetByClass($nodeStateToggleCmdClasses, 'toggleExplorerNodeState', '', true, false);
                $this->ctrl->setParameterByClass($cmdClass, $this->node_parameter_name, null);

                $javascript = "il.UI.tree.registerToggleNodeAsyncAction('$id', '$url', 'prior_state');";

                return $javascript;
            });
        }*/

        return $node;
    }
}