Virtual skill tree explorer. More...

Inheritance diagram for ilVirtualSkillTreeExplorerGUI:

Collaboration diagram for ilVirtualSkillTreeExplorerGUI:

Public Member Functions
	__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

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 = "./Services/UIComponent/Explorer2/js/Explorer2.js"

Detailed Description

Virtual skill tree explorer.

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.ilVirtualSkillTreeExplorerGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 38 of file class.ilVirtualSkillTreeExplorerGUI.php.

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

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
         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);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getChildsOfNode()

ilVirtualSkillTreeExplorerGUI::getChildsOfNode ( $a_parent_node_id )

Parameters

string $a_parent_node_id

Returns: array{cskill_id: string, id: string, skill_id: string, tref_id: string, parent: string}[]

Definition at line 119 of file class.ilVirtualSkillTreeExplorerGUI.php.

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

◆ getDomNodeIdForNodeId()

ilVirtualSkillTreeExplorerGUI::getDomNodeIdForNodeId ( $a_node_id )

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

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

◆ getNodeContent()

ilVirtualSkillTreeExplorerGUI::getNodeContent ( $a_node )

Parameters

array | object $a_node

Returns: string

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

References $lng, ILIAS\Repository\int(), and ilLanguage\txt().

                                            : 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;
     }

Here is the call graph for this function:

◆ getNodeHref()

ilVirtualSkillTreeExplorerGUI::getNodeHref ( $a_node )

Parameters

array | object $a_node

Returns: string

Definition at line 185 of file class.ilVirtualSkillTreeExplorerGUI.php.

References ilExplorerBaseGUI\$ctrl.

                                         : 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 "";
     }

◆ getNodeIcon()

ilVirtualSkillTreeExplorerGUI::getNodeIcon ( $a_node )

Parameters

array | object $a_node

Returns: string

Definition at line 156 of file class.ilVirtualSkillTreeExplorerGUI.php.

References $type, ilSkillTreeNode\_lookupType(), ilUtil\getImagePath(), and ILIAS\Repository\int().

                                         : 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("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("icon_" . $type . ".svg");
         }
 
         return $icon;
     }

Here is the call graph for this function:

◆ getNodeIconAlt()

ilVirtualSkillTreeExplorerGUI::getNodeIconAlt ( $a_node )

Parameters

array | object $a_node

Returns: string

Definition at line 216 of file class.ilVirtualSkillTreeExplorerGUI.php.

References $lng, ilLanguage\exists(), and ilLanguage\txt().

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

Here is the call graph for this function:

◆ getNodeId()

ilVirtualSkillTreeExplorerGUI::getNodeId ( $a_node )

Parameters

array | object $a_node

Returns: string

Definition at line 93 of file class.ilVirtualSkillTreeExplorerGUI.php.

                                       : string
     {
         return $a_node["id"];
     }

◆ getNodeIdForDomNodeId()

ilVirtualSkillTreeExplorerGUI::getNodeIdForDomNodeId ( string $a_dom_node_id )

Definition at line 109 of file class.ilVirtualSkillTreeExplorerGUI.php.

References ilExplorerBaseGUI\$id.

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

◆ getRootNode()

ilVirtualSkillTreeExplorerGUI::getRootNode ( )

Returns: array{id: string, cskill_id: string}

Definition at line 84 of file class.ilVirtualSkillTreeExplorerGUI.php.

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

◆ getShowDraftNodes()

ilVirtualSkillTreeExplorerGUI::getShowDraftNodes ( )

Definition at line 65 of file class.ilVirtualSkillTreeExplorerGUI.php.

References $show_draft_nodes.

                                        : bool
     {
         return $this->show_draft_nodes;
     }

◆ getShowOutdatedNodes()

ilVirtualSkillTreeExplorerGUI::getShowOutdatedNodes ( )

Definition at line 76 of file class.ilVirtualSkillTreeExplorerGUI.php.

References $show_outdated_nodes.

                                           : bool
     {
         return $this->show_outdated_nodes;
     }

◆ isNodeClickable()

ilVirtualSkillTreeExplorerGUI::isNodeClickable ( $a_node )

Parameters

array | object $a_node

Returns: bool

Definition at line 207 of file class.ilVirtualSkillTreeExplorerGUI.php.

                                             : bool
     {
         return false;
     }

◆ setShowDraftNodes()

ilVirtualSkillTreeExplorerGUI::setShowDraftNodes ( bool $a_val )

Definition at line 59 of file class.ilVirtualSkillTreeExplorerGUI.php.

Referenced by ilSkillTreeExplorerGUI\__construct().

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

Here is the caller graph for this function:

◆ setShowOutdatedNodes()

ilVirtualSkillTreeExplorerGUI::setShowOutdatedNodes ( bool $a_val )

Definition at line 70 of file class.ilVirtualSkillTreeExplorerGUI.php.

Referenced by ilSkillTreeExplorerGUI\__construct().

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

Here is the caller graph for this function: