Explorer class that works on tree objects (Services/Tree) More...

Inheritance diagram for ilSkillTreeExplorerGUI:

Collaboration diagram for ilSkillTreeExplorerGUI:

Public Member Functions
	__construct ($a_parent_obj, string $a_parent_cmd, int $tree_id=0)

	getNodeContent ($a_node)

	getNodeIcon ($a_node)

	isNodeHighlighted ($a_node)

	getNodeHref ($a_node)

	isNodeClickable ($a_node)

Public Member Functions inherited from ilVirtualSkillTreeExplorerGUI
	__construct (string $a_id, $a_parent_obj, string $a_parent_cmd, int $tree_id=0)

	setShowDraftNodes (bool $a_val)

	getShowDraftNodes ()

	setShowOutdatedNodes (bool $a_val)

	getShowOutdatedNodes ()

	getRootNode ()

	getNodeId ($a_node)

	getDomNodeIdForNodeId ($a_node_id)

	getNodeIdForDomNodeId (string $a_dom_node_id)

	getChildsOfNode ($a_parent_node_id)

	getNodeContent ($a_node)

	getNodeIcon ($a_node)

	getNodeHref ($a_node)

	isNodeClickable ($a_node)

	getNodeIconAlt ($a_node)

Public Member Functions inherited from ilExplorerBaseGUI
	setChildLimit (int $a_val)

	getChildLimit ()

	setSearchTerm (string $a_val)

	getSearchTerm ()

	setMainTemplate (?ilGlobalTemplateInterface $a_main_tpl=null)

	getRootNode ()
	Get root node. More...

	getChildsOfNode ($a_parent_node_id)
	Get children of node. More...

	getNodeContent ($a_node)
	Get content of a node. More...

	getNodeId ($a_node)
	Get id of a node. More...

	getNodeHref ($a_node)
	Get href for node. More...

	nodeHasVisibleChilds ($a_node)
	Node has children Please note that this standard method may not be optimal depending on what a derived class does in isNodeVisible. More...

	sortChilds (array $a_childs, $a_parent_node_id)
	Sort childs. More...

	getNodeIcon ($a_node)
	Get node icon path. More...

	getNodeIconAlt ($a_node)
	Get node icon alt attribute. More...

	getNodeTarget ($a_node)
	Get node target (frame) attribute. More...

	getNodeOnClick ($a_node)
	Get node onclick attribute. More...

	isNodeVisible ($a_node)
	Is node visible? More...

	isNodeHighlighted ($a_node)
	Is node highlighted? More...

	isNodeClickable ($a_node)
	Is node clickable? More...

	getId ()
	Get id of explorer element. More...

	setSkipRootNode (bool $a_val)

	getSkipRootNode ()

	setAjax (bool $a_val)

	getAjax ()

	setSecondaryHighlightedNodes (array $a_val)
	Set secondary (background) highlighted nodes. More...

	getSecondaryHighlightedNodes ()
	Get secondary (background) highlighted nodes. More...

	setNodeOpen ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour) More...

	setSelectMode (string $a_postvar, bool $a_multi=false)
	Set select mode (to deactivate, pass an empty string as postvar) More...

	setNodeSelected ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour) More...

	setOfflineMode (bool $a_val)

	getOfflineMode ()

	handleCommand ()
	Handle explorer internal command. More...

	getContainerId ()

	openNode ()
	Open node. More...

	closeNode ()
	Close node. More...

	getNodeAsync ()
	Get node asynchronously. More...

	beforeRendering ()
	Before rendering. More...

	getOnLoadCode ()
	Get on load code. More...

	getHTML ()

	renderNode ($a_node, ilTemplate $tpl)
	Render node. More...

	renderChilds ($a_node_id, ilTemplate $tpl)
	Render childs. More...

	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id. More...

	getNodeIdForDomNodeId (string $a_dom_node_id)
	Get node id for dom node id. More...

	listItemStart (ilTemplate $tpl, $a_node)
	List item start. More...

	listItemEnd (ilTemplate $tpl)

	listStart (ilTemplate $tpl)

	listEnd (ilTemplate $tpl)

	isNodeOnclickEnabled ()

	setNodeOnclickEnabled (bool $nodeOnclickEnabled)

	isEnableDnd ()

	setEnableDnd (bool $enable_dnd)

Protected Attributes
ilLanguage	$lng

SkillAdminGUIRequest	$admin_gui_request

int	$requested_skill_node_id = 0

int	$requested_tref_id = 0

Protected Attributes inherited from ilVirtualSkillTreeExplorerGUI
ilLanguage	$lng

ilVirtualSkillTree	$vtree

SkillTreeManager	$skill_tree_manager

SkillInternalFactoryService	$tree_factory

bool	$show_draft_nodes = false

bool	$show_outdated_nodes = false

Protected Attributes inherited from ilExplorerBaseGUI
string	$node_parameter_name

ilLogger	$log

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

bool	$skip_root_node = false

bool	$ajax = false

array	$custom_open_nodes = array()

array	$selected_nodes = array()

string	$select_postvar = ""

bool	$offline_mode = false

array	$sec_highl_nodes = array()

bool	$enable_dnd = false

string	$search_term = ""

array	$open_nodes = []

ilSessionIStorage	$store

bool	$select_multi = false

	$parent_obj

int	$child_limit = 0

string	$parent_cmd = ''

string	$requested_exp_cmd = ""

string	$requested_exp_cont = ""

string	$requested_searchterm = ""

string	$requested_node_id = ""

string	$id

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()

static	getLocalJsTreeJsPath ()

static	getLocalJsTreeCssPath ()

static	createHTMLExportDirs (string $a_target_dir)

static	init (?ilGlobalTemplateInterface $a_main_tpl=null)

Protected Member Functions inherited from ilExplorerBaseGUI
	isNodeSelectable ($a_node)
	Is node selectable? More...

	getNodeToggleOnClick ($a_node)
	Get onclick attribute for node toggling. More...

	getSelectOnClick ($a_node)
	Get onclick attribute for selecting radio/checkbox. More...

	isNodeOpen ($node_id)
	Get all open nodes. More...

	getJSTreePlugins ()

	isNodeRequested (string $a_node_id)

Static Protected Attributes inherited from ilExplorerBaseGUI
static string	$js_tree_path = "./node_modules/jstree/dist/jstree.js"

static string	$js_tree_path_css = "./node_modules/jstree/dist/themes/default/style.min.css"

static string	$js_expl_path = "assets/js/Explorer2.js"

Detailed Description

Explorer class that works on tree objects (Services/Tree)

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Definition at line 28 of file class.ilSkillTreeExplorerGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilSkillTreeExplorerGUI::__construct	(		$a_parent_obj,
		string	$a_parent_cmd,
		int	$tree_id = `0`
	)

Parameters

	object\|string[]	$a_parent_obj
string	$a_parent_cmd
int	$tree_id

Definition at line 40 of file class.ilSkillTreeExplorerGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilExplorerBaseGUI\setAjax(), ilVirtualSkillTreeExplorerGUI\setShowDraftNodes(), ilVirtualSkillTreeExplorerGUI\setShowOutdatedNodes(), and ilExplorerBaseGUI\setSkipRootNode().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
         $this->admin_gui_request = $DIC->skills()->internal()->gui()->admin_request();
         parent::__construct("skill_exp", $a_parent_obj, $a_parent_cmd, $tree_id);
 
         $this->requested_skill_node_id = $this->admin_gui_request->getNodeId();
         $this->requested_tref_id = $this->admin_gui_request->getTrefId();
 
         // node should be hidden #26849 (not not hidden, see discussion in #26813 and JF 6 Jan 2020)
         $this->setSkipRootNode(false);
         $this->setAjax(false);
         $this->setShowDraftNodes(true);
         $this->setShowOutdatedNodes(true);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getNodeContent()

ilSkillTreeExplorerGUI::getNodeContent ( $a_node )

Definition at line 62 of file class.ilSkillTreeExplorerGUI.php.

References $lng, ilSkillTreeNode\_lookupSelfEvaluation(), ilSkillTemplateReference\_lookupTemplateId(), ilSkillTreeNode\_lookupTitle(), and ILIAS\Repository\int().

                                            : string
     {
         $lng = $this->lng;
 
         $a_parent_id_parts = explode(":", $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
         $title = $a_node["title"];
 
         // root?
         if ($a_node["type"] == "skrt") {
             $tree_obj = $this->skill_tree_manager->getTree($a_node["skl_tree_id"]);
             $title = $tree_obj->getTitle();
         } else {
             if ($a_node["type"] == "sktr") {
                 $tid = ilSkillTemplateReference::_lookupTemplateId($a_parent_skl_tree_id);
                 $title .= " (" . ilSkillTreeNode::_lookupTitle($tid) . ")";
             }
 
             // @todo: fix this if possible for skill/tref_id combination
             if (ilSkillTreeNode::_lookupSelfEvaluation($a_parent_skl_tree_id)) {
                 if ($a_parent_skl_template_tree_id == 0 || $a_node["type"] == "sktr") {
                     $title = "<u>" . $title . "</u>";
                 }
             }
         }
 
         if ($this->vtree->isOutdated($a_node["id"])) {
             $title = "<span class='light'>" . $title . "</span>";
         }
 
         return $title;
     }

Here is the call graph for this function:

◆ getNodeHref()

ilSkillTreeExplorerGUI::getNodeHref ( $a_node )

Definition at line 155 of file class.ilSkillTreeExplorerGUI.php.

References ilExplorerBaseGUI\$ctrl.

                                         : string
     {
         $ilCtrl = $this->ctrl;
 
         $id_parts = explode(":", $a_node["id"]);
         if (!isset($id_parts[1]) || $id_parts[1] == 0) {
             // skill in main tree
             $skill_id = $id_parts[0];
             $tref_id = 0;
         } else {
             // skill in template
             $tref_id = $id_parts[0];
             $skill_id = $id_parts[1];
         }
 
         $gui_class = array(
             "skrt" => "ilskillrootgui",
             "scat" => "ilskillcategorygui",
             "sktr" => "ilskilltemplatereferencegui",
             "skll" => "ilbasicskillgui",
             "sktp" => "ilbasicskilltemplategui",
             "sctp" => "ilskilltemplatecategorygui"
         );
 
         $cmd = array(
             "skrt" => "listSkills",
             "scat" => "listItems",
             "sktr" => "listItems",
             "skll" => "edit",
             "sktp" => "edit",
             "sctp" => "listItems"
         );
 
         $gui_class = $gui_class[$a_node["type"]];
         $cmd = $cmd[$a_node["type"]];
 
         $ilCtrl->setParameterByClass($gui_class, "tref_id", $tref_id);
         $ilCtrl->setParameterByClass($gui_class, "node_id", $skill_id);
         $ret = $ilCtrl->getLinkTargetByClass(["ilAdministrationGUI", "ilObjSkillManagementGUI",
                                               "ilSkillTreeAdminGUI", "ilObjSkillTreeGUI", $gui_class], $cmd);
         $ilCtrl->setParameterByClass($gui_class, "node_id", $this->requested_skill_node_id);
         $ilCtrl->setParameterByClass($gui_class, "tref_id", $this->requested_tref_id);
 
         return $ret;
     }

◆ getNodeIcon()

ilSkillTreeExplorerGUI::getNodeIcon ( $a_node )

Definition at line 101 of file class.ilSkillTreeExplorerGUI.php.

References ilSkillTreeNode\getIconPath(), ilUtil\getImagePath(), and ILIAS\Repository\int().

                                         : string
     {
         $a_parent_id_parts = explode(":", $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;
 
 
         // root?
         if ($a_node["type"] == "skrt") {
             $icon = ilUtil::getImagePath("standard/icon_scat.svg");
         } elseif (in_array($a_node["type"], array("skll", "scat", "sctr", "sktr", "sctp", "sktp"))) {
             $icon = ilSkillTreeNode::getIconPath(
                 $a_parent_skl_tree_id,
                 $a_node["type"],
                 "",
                 (int) ($this->vtree->isDraft($a_node["id"]) || $this->vtree->isOutdated($a_node["id"]))
             );
         } else {
             $icon = ilUtil::getImagePath("standard/icon_" . $a_node["type"] . ".svg");
         }
 
         return $icon;
     }

Here is the call graph for this function:

◆ isNodeClickable()

ilSkillTreeExplorerGUI::isNodeClickable ( $a_node )

Definition at line 204 of file class.ilSkillTreeExplorerGUI.php.

                                             : bool
     {
         return true;
     }

◆ isNodeHighlighted()

ilSkillTreeExplorerGUI::isNodeHighlighted ( $a_node )

Definition at line 128 of file class.ilSkillTreeExplorerGUI.php.

                                               : bool
     {
         $id_parts = explode(":", $a_node["id"]);
         if (!isset($id_parts[1]) || $id_parts[1] == 0) {
             // skill in main tree
             $skill_id = $id_parts[0];
             $tref_id = 0;
         } else {
             // skill in template
             $tref_id = $id_parts[0];
             $skill_id = $id_parts[1];
         }
 
         if ($this->requested_skill_node_id == "" && $a_node["type"] == "skrt") {
             return true;
         }
 
         if ($skill_id == $this->requested_skill_node_id &&
             ($this->requested_tref_id == $tref_id)) {
             return true;
         }
         return false;
     }