Virtual skill tree explorer. More...

Inheritance diagram for ilVirtualSkillTreeExplorerGUI:

Collaboration diagram for ilVirtualSkillTreeExplorerGUI:

Public Member Functions
	__construct ($a_id, $a_parent_obj, $a_parent_cmd)
	Constructor. More...

	setShowDraftNodes ($a_val)
	Set show draft nodes. More...

	getShowDraftNodes ()
	Get show draft nodes. More...

	setShowOutdatedNodes ($a_val)
	Set show outdated nodes. More...

	getShowOutdatedNodes ()
	Get show outdated nodes. More...

	getRootNode ()
	Get root node. More...

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

	getDomNodeIdForNodeId ($node_id)

	getNodeIdForDomNodeId ($a_dom_node_id)

	getChildsOfNode ($a_parent_id)
	Get childs of node. More...

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

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

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

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

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

Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor. More...

	setChildLimit ($a_val)
	Set child limit. More...

	getChildLimit ()
	Get child limit. More...

	setSearchTerm ($a_val)
	Set search term. More...

	getSearchTerm ()
	Get search term. More...

	setMainTemplate (ilTemplate $a_main_tpl=null)
	Set main template (that is responsible for adding js/css) More...

	getRootNode ()
	Get root node. More...

	getChildsOfNode ($a_parent_node_id)
	Get childs 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 childs? More...

	sortChilds ($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 ($a_val)
	Set skip root node. More...

	getSkipRootNode ()
	Get skip root node. More...

	setAjax ($a_val)
	Set ajax. More...

	getAjax ()
	Get ajax. More...

	setSecondaryHighlightedNodes ($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 ($a_postvar, $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 ($a_val)
	Set offline mode. More...

	getOfflineMode ()
	Get offline mode. More...

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

	getContainerId ()
	Get container id. More...

	openNode ()
	Open node. More...

	closeNode ()
	Close node. More...

	getNodeAsync ()
	Get node asynchronously. More...

	beforeRendering ()
	Before rendering. More...

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

	getHTML ()
	Get HTML. More...

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

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

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

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

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

	listItemEnd ($tpl)
	List item end. More...

	listStart ($tpl)
	List start. More...

	listEnd ($tpl)
	List end. More...

	isNodeOnclickEnabled ()

	setNodeOnclickEnabled ($nodeOnclickEnabled)

	isEnableDnd ()

	setEnableDnd ($enable_dnd)
	Enable Drag & Drop functionality. More...

Protected Attributes
	$lng

	$ctrl

	$show_draft_nodes = false

	$show_outdated_nodes = false

Protected Attributes inherited from ilExplorerBaseGUI
	$log

	$ctrl

	$tpl

	$skip_root_node = false

	$ajax = false

	$custom_open_nodes = array()

	$selected_nodes = array()

	$select_postvar = ""

	$offline_mode = false

	$sec_highl_nodes = array()

	$enable_dnd = false

	$search_term = ""

	$child_limit = 0

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()
	Get local path of explorer js. More...

static	getLocalJsTreeJsPath ()
	Get local path of jsTree js. More...

static	getLocalJsTreeCssPath ()
	Get local path of jsTree js. More...

static	createHTMLExportDirs ($a_target_dir)
	Create html export directories. More...

static	init ($a_main_tpl=null)
	Init JS. More...

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 ()

Static Protected Attributes inherited from ilExplorerBaseGUI
static	$js_tree_path = "./libs/bower/bower_components/jstree/dist/jstree.js"

static	$js_tree_path_css = "./libs/bower/bower_components/jstree/dist/themes/default/style.min.css"

static	$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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilVirtualSkillTreeExplorerGUI::__construct	(	$a_id,
		$a_parent_obj,
		$a_parent_cmd
	)

Constructor.

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

References $DIC, 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);
         
         include_once("./Services/Skill/classes/class.ilVirtualSkillTree.php");
         $this->vtree = new ilVirtualSkillTree();
         
         $this->setSkipRootNode(false);
         $this->setAjax(false);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getChildsOfNode()

ilVirtualSkillTreeExplorerGUI::getChildsOfNode ( $a_parent_id )

Get childs of node.

Parameters

int $a_parent_id parent id

Returns: array childs

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

     {
         return $this->vtree->getChildsOfNode($a_parent_id);
     }

◆ getDomNodeIdForNodeId()

ilVirtualSkillTreeExplorerGUI::getDomNodeIdForNodeId ( $node_id )

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

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

◆ getNodeContent()

ilVirtualSkillTreeExplorerGUI::getNodeContent ( $a_node )

Get node content.

Parameters

array

Returns

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

References $lng, and $title.

     {
         $lng = $this->lng;
 
         $a_parent_id_parts = explode(":", $a_node["id"]);
         $a_parent_skl_tree_id = $a_parent_id_parts[0];
         $a_parent_skl_template_tree_id = $a_parent_id_parts[1];
         
         // title
         $title = $a_node["title"];
         
         // root?
         if ($a_node["type"] == "skrt") {
             $lng->txt("skmg_skills");
         } else {
             if ($a_node["type"] == "sktr") {
                 //                              include_once("./Services/Skill/classes/class.ilSkillTemplateReference.php");
 //                              $title.= " (".ilSkillTreeNode::_lookupTitle($a_parent_skl_template_tree_id).")";
             }
         }
         
         return $title;
     }

◆ getNodeHref()

ilVirtualSkillTreeExplorerGUI::getNodeHref ( $a_node )

Get href for node.

Parameters

mixed $a_node node object/array

Returns: string href attribute

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

References $ctrl, and $ilCtrl.

     {
         $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(":", $a_node["id"]);
         if ($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 )

Get node icon.

Parameters

array

Returns

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

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

     {
         $a_id_parts = explode(":", $a_node["id"]);
         $a_skl_template_tree_id = $a_id_parts[1];
 
         // root?
         if ($a_node["type"] == "skrt") {
             $icon = ilUtil::getImagePath("icon_scat.svg");
         } else {
             $type = $a_node["type"];
             if ($type == "sktr") {
                 include_once("./Services/Skill/classes/class.ilSkillTreeNode.php");
                 $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 )

Get node icon alt attribute.

Parameters

mixed $a_node node object/array

Returns: string image alt attribute

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

References $lng.

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

◆ getNodeId()

ilVirtualSkillTreeExplorerGUI::getNodeId ( $a_node )

Get node id.

Parameters

array $a_node node data

Returns: string node id

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

     {
         return $a_node["id"];
     }

◆ getNodeIdForDomNodeId()

ilVirtualSkillTreeExplorerGUI::getNodeIdForDomNodeId ( $a_dom_node_id )

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

References $id.

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

◆ getRootNode()

ilVirtualSkillTreeExplorerGUI::getRootNode ( )

Get root node.

Returns: array root node data

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

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

◆ getShowDraftNodes()

ilVirtualSkillTreeExplorerGUI::getShowDraftNodes ( )

Get show draft nodes.

Returns: boolean show draft nodes

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

References $show_draft_nodes.

     {
         return $this->show_draft_nodes;
     }

◆ getShowOutdatedNodes()

ilVirtualSkillTreeExplorerGUI::getShowOutdatedNodes ( )

Get show outdated nodes.

Returns: boolean show outdated notes

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

References $show_outdated_nodes.

     {
         return $this->show_outdated_nodes;
     }

◆ isNodeClickable()

ilVirtualSkillTreeExplorerGUI::isNodeClickable ( $a_node )

Is clickable.

Parameters

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

     {
         return false;
     }

◆ setShowDraftNodes()

ilVirtualSkillTreeExplorerGUI::setShowDraftNodes ( $a_val )

Set show draft nodes.

Parameters

boolean $a_val show draft nodes

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

Referenced by ilSkillTreeExplorerGUI\__construct().

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

Here is the caller graph for this function:

◆ setShowOutdatedNodes()

ilVirtualSkillTreeExplorerGUI::setShowOutdatedNodes ( $a_val )

Set show outdated nodes.

Parameters

boolean $a_val show outdated notes

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

Referenced by ilSkillTreeExplorerGUI\__construct().

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

Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilVirtualSkillTreeExplorerGUI::$ctrl

protected

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

Referenced by getNodeHref().

◆ $lng

ilVirtualSkillTreeExplorerGUI::$lng

protected

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

Referenced by getNodeContent(), and getNodeIconAlt().

◆ $show_draft_nodes

ilVirtualSkillTreeExplorerGUI::$show_draft_nodes = false

protected

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

Referenced by getShowDraftNodes().

◆ $show_outdated_nodes

ilVirtualSkillTreeExplorerGUI::$show_outdated_nodes = false

protected

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

Referenced by getShowOutdatedNodes().

The documentation for this class was generated from the following file:

Services/Skill/classes/class.ilVirtualSkillTreeExplorerGUI.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getChildsOfNode()

◆ getDomNodeIdForNodeId()

◆ getNodeContent()

◆ getNodeHref()

◆ getNodeIcon()

◆ getNodeIconAlt()

◆ getNodeId()

◆ getNodeIdForDomNodeId()

◆ getRootNode()

◆ getShowDraftNodes()

◆ getShowOutdatedNodes()

◆ isNodeClickable()

◆ setShowDraftNodes()

◆ setShowOutdatedNodes()

Field Documentation

◆ $ctrl

◆ $lng

◆ $show_draft_nodes

◆ $show_outdated_nodes