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

Inheritance diagram for ilSkillTemplateTreeExplorerGUI:

Collaboration diagram for ilSkillTemplateTreeExplorerGUI:

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

	getRootNode ()
	Get root node. More...

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

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

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

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

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

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

	getTree ()
	Get tree. More...

	setOrderField ($a_val, $a_numeric=false)
	Set order field. More...

	getOrderField ()
	Get order field. More...

	setTypeWhiteList ($a_val)
	Set type white list. More...

	getTypeWhiteList ()
	Get type white list. More...

	setTypeBlackList ($a_val)
	Set type black list. More...

	getTypeBlackList ()
	Get type black list. More...

	setPreloadChilds ($a_val)
	Set preload childs. More...

	getPreloadChilds ()
	Get preload childs. More...

	getSuccessorNode ($a_node_id, $a_type="")
	Get successor node (currently only(!) based on lft/rgt tree values) More...

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

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

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

	getRootNode ()
	Get root node. More...

	setRootId ($a_root)

	setPathOpen ($a_id)
	Set node path to be opened. More...

	getHTML ()
	Get HTML. More...

Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor. 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...

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	createHTMLExportDirs ($a_target_dir)
	Create html export directories. More...

static	init ()
	Init JS. More...

Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	Preload childs. More...

	getRootId ()

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

	getJSTreePlugins ()

Protected Attributes inherited from ilTreeExplorerGUI
	$tree = null

	$order_field = ""

	$order_field_numeric = false

	$type_white_list = array()

	$type_black_list = array()

	$childs = array()

	$preloaded = false

	$preload_childs = false

	$root_node_data = null

	$all_childs = array()

Protected Attributes inherited from ilExplorerBaseGUI
	$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

Static Protected Attributes inherited from ilExplorerBaseGUI
static	$js_tree_path = "./Services/UIComponent/Explorer2/lib/jstree-v.pre1.0/jquery.jstree.js"

static	$js_expl_path = "./Services/UIComponent/Explorer2/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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilSkillTemplateTreeExplorerGUI::__construct	(	$a_parent_obj,
		$a_parent_cmd
	)

Constructor.

Parameters

object	$a_parent_obj	parent gui object
string	$a_parent_cmd	parent command

Definition at line 22 of file class.ilSkillTemplateTreeExplorerGUI.php.

References ilTreeExplorerGUI\$tree, array, ilExplorerBaseGUI\setAjax(), ilTreeExplorerGUI\setOrderField(), ilExplorerBaseGUI\setSkipRootNode(), and ilTreeExplorerGUI\setTypeWhiteList().

         {
                 include_once("./Services/Skill/classes/class.ilSkillTree.php");
                 $tree = new ilSkillTree();
                 parent::__construct("skill_exp", $a_parent_obj, $a_parent_cmd, $tree);
 
                 $this->setTypeWhiteList(array("skrt", "sktp", "sctp"));
                 
                 $this->setSkipRootNode(false);
                 $this->setAjax(true);
                 $this->setOrderField("order_nr");
         }

Here is the call graph for this function:

Member Function Documentation

◆ getChildsOfNode()

ilSkillTemplateTreeExplorerGUI::getChildsOfNode ( $a_parent_id )

Get childs of node.

Parameters

int $a_parent_id parent id

Returns: array childs

Definition at line 53 of file class.ilSkillTemplateTreeExplorerGUI.php.

References ilTreeExplorerGUI\$childs, ilSkillTreeNode\_lookupStatus(), and ilSkillTreeNode\STATUS_DRAFT.

         {
                 $childs = parent::getChildsOfNode($a_parent_id);
                 
                 include_once("./Services/Skill/classes/class.ilSkillTreeNode.php");
                 foreach ($childs as $c)
                 {
                         $this->parent[$c["child"]] = $c["parent"];
                         if ($this->draft[$c["parent"]])
                         {
                                 $this->draft[$c["child"]] = true;
                         }
                         else
                         {
                                 $this->draft[$c["child"]] = (ilSkillTreeNode::_lookupStatus($c["child"]) == ilSkillTreeNode::STATUS_DRAFT);
                         }
                 }
                 return $childs;
         }

Here is the call graph for this function:

◆ getNodeContent()

ilSkillTemplateTreeExplorerGUI::getNodeContent ( $a_node )

Get node content.

Parameters

array

Returns

Definition at line 79 of file class.ilSkillTemplateTreeExplorerGUI.php.

References $lng, $title, ilSkillTreeNode\_lookupSelfEvaluation(), and ilSkillTemplateReference\_lookupTemplateId().

         {
                 global $lng;
                 
                 // title
                 $title = $a_node["title"];
                 
                 // root?
                 if ($a_node["type"] == "skrt")
                 {
                         $title = $lng->txt("skmg_skill_templates");
                 }
                 else
                 {
                         if ($a_node["type"] == "sktr")
                         {
                                 include_once("./Services/Skill/classes/class.ilSkillTemplateReference.php");
                                 $tid = ilSkillTemplateReference::_lookupTemplateId($a_node["child"]);
                                 $title.= " (".ilSkillTreeNode::_lookupTitle($tid).")";
                         }
                         if (ilSkillTreeNode::_lookupSelfEvaluation($a_node["child"]))
                         {
                                 $title = "<u>".$title."</u>";
                         }
                 }
                 
                 return $title;
         }

Here is the call graph for this function:

◆ getNodeHref()

ilSkillTemplateTreeExplorerGUI::getNodeHref ( $a_node )

Get href for node.

Parameters

mixed $a_node node object/array

Returns: string href attribute

Definition at line 159 of file class.ilSkillTemplateTreeExplorerGUI.php.

References $_GET, $ilCtrl, and $ret.

         {
                 global $ilCtrl;
 
                 switch($a_node["type"])
                 {
                         // root
                         case "skrt":
                                 $ilCtrl->setParameterByClass("ilskillrootgui", "obj_id", $a_node["child"]);
                                 $ret = $ilCtrl->getLinkTargetByClass("ilskillrootgui", "listTemplates");
                                 $ilCtrl->setParameterByClass("ilskillrootgui", "obj_id", $_GET["obj_id"]);
                                 return $ret;
                                 break;
 
                         // template
                         case "sktp":
                                 $ilCtrl->setParameterByClass("ilbasicskilltemplategui", "obj_id", $a_node["child"]);
                                 $ret = $ilCtrl->getLinkTargetByClass("ilbasicskilltemplategui", "edit");
                                 $ilCtrl->setParameterByClass("ilbasicskilltemplategui", "obj_id", $_GET["obj_id"]);
                                 return $ret;
                                 break;
 
                         // template category
                         case "sctp":
                                 $ilCtrl->setParameterByClass("ilskilltemplatecategorygui", "obj_id", $a_node["child"]);
                                 $ret = $ilCtrl->getLinkTargetByClass("ilskilltemplatecategorygui", "listItems");
                                 $ilCtrl->setParameterByClass("ilskilltemplatecategorygui", "obj_id", $_GET["obj_id"]);
                                 return $ret;
                                 break;
         
                 }
         }

◆ getNodeIcon()

ilSkillTemplateTreeExplorerGUI::getNodeIcon ( $a_node )

Get node content.

Parameters

array

Returns

Definition at line 114 of file class.ilSkillTemplateTreeExplorerGUI.php.

References array, ilSkillTreeNode\getIconPath(), and ilUtil\getImagePath().

         {
                 // root?
                 if ($a_node["type"] == "skrt")
                 {
                         $icon = ilUtil::getImagePath("icon_sctp.svg");
                 }
                 else
                 {
                         if (in_array($a_node["type"], array("skll", "scat", "sctr", "sktr")))
                         {
                                 $icon = ilSkillTreeNode::getIconPath($a_node["child"], $a_node["type"], "",
                                         $this->draft[$a_node["child"]]);
                         }
                         else
                         {
                                 $icon = ilUtil::getImagePath("icon_".$a_node["type"].".svg");
                         }
                 }
                 
                 return $icon;
         }

Here is the call graph for this function:

◆ getRootNode()

ilSkillTemplateTreeExplorerGUI::getRootNode ( )

Get root node.

Returns: array node data

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

References $_GET, $path, and ilTreeExplorerGUI\getTree().

         {
                 $path = $this->getTree()->getPathId($_GET["obj_id"]);
                 return $this->getTree()->getNodeData($path[1]);
         }

Here is the call graph for this function:

◆ isNodeHighlighted()

ilSkillTemplateTreeExplorerGUI::isNodeHighlighted ( $a_node )

Is node highlighted?

Parameters

mixed $a_node node object/array

Returns: boolean node visible true/false

Definition at line 143 of file class.ilSkillTemplateTreeExplorerGUI.php.

References $_GET.

         {
                 if ($a_node["child"] == $_GET["obj_id"] ||
                         ($_GET["obj_id"] == "" && $a_node["type"] == "skrt"))
                 {
                         return true;
                 }
                 return false;
         }       

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

Services/Skill/classes/class.ilSkillTemplateTreeExplorerGUI.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getChildsOfNode()

◆ getNodeContent()

◆ getNodeHref()

◆ getNodeIcon()

◆ getRootNode()

◆ isNodeHighlighted()