ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilVirtualSkillTreeExplorerGUI Class Reference

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

Protected Attributes

 $show_draft_nodes = false
 
 $show_outdated_nodes = false
 
- 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
 

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

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.

Reimplemented from ilExplorerBaseGUI.

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

23 {
24 parent::__construct($a_id, $a_parent_obj, $a_parent_cmd);
25
26 include_once("./Services/Skill/classes/class.ilVirtualSkillTree.php");
27 $this->vtree = new ilVirtualSkillTree();
28
29 $this->setSkipRootNode(false);
30 $this->setAjax(false);
31 }
setSkipRootNode($a_val)
Set skip root node.

References ilExplorerBaseGUI\setAjax(), and ilExplorerBaseGUI\setSkipRootNode().

+ 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_idparent id
Returns
array childs

Reimplemented from ilExplorerBaseGUI.

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

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

◆ getNodeContent()

ilVirtualSkillTreeExplorerGUI::getNodeContent (   $a_node)

Get node content.

Parameters
array
Returns

Reimplemented from ilExplorerBaseGUI.

Reimplemented in ilSkillTreeExplorerGUI.

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

114 {
115 global $lng;
116
117 $a_parent_id_parts = explode(":", $a_node["id"]);
118 $a_parent_skl_tree_id = $a_parent_id_parts[0];
119 $a_parent_skl_template_tree_id = $a_parent_id_parts[1];
120
121 // title
122 $title = $a_node["title"];
123
124 // root?
125 if ($a_node["type"] == "skrt")
126 {
127 $lng->txt("skmg_skills");
128 }
129 else
130 {
131 if ($a_node["type"] == "sktr")
132 {
133// include_once("./Services/Skill/classes/class.ilSkillTemplateReference.php");
134// $title.= " (".ilSkillTreeNode::_lookupTitle($a_parent_skl_template_tree_id).")";
135 }
136 }
137
138 return $title;
139 }
global $lng
Definition: privfeed.php:40

References $lng.

◆ getNodeHref()

ilVirtualSkillTreeExplorerGUI::getNodeHref (   $a_node)

Get href for node.

Parameters
mixed$a_nodenode object/array
Returns
string href attribute

Reimplemented from ilExplorerBaseGUI.

Reimplemented in ilSkillSelectorGUI, and ilSkillTreeExplorerGUI.

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

187 {
188 global $ilCtrl;
189
190 // we have a tree id like <skl_tree_id>:<skl_template_tree_id> here
191 // use this, if you want a "common" skill id in format <skill_id>:<tref_id>
192 $id_parts = explode(":", $a_node["id"]);
193 if ($id_parts[1] == 0)
194 {
195 // skill in main tree
196 $skill_id = $a_node["id"];
197 }
198 else
199 {
200 // skill in template
201 $skill_id = $id_parts[1].":".$id_parts[0];
202 }
203
204 return "";
205 }
global $ilCtrl
Definition: ilias.php:18

References $ilCtrl.

◆ getNodeIcon()

ilVirtualSkillTreeExplorerGUI::getNodeIcon (   $a_node)

Get node icon.

Parameters
array
Returns

Reimplemented from ilExplorerBaseGUI.

Reimplemented in ilSkillTreeExplorerGUI.

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

148 {
149 $a_id_parts = explode(":", $a_node["id"]);
150 $a_skl_tree_id = $a_parent_id_parts[0];
151 $a_skl_template_tree_id = $a_id_parts[1];
152
153 // root?
154 if ($a_node["type"] == "skrt")
155 {
156 $icon = ilUtil::getImagePath("icon_scat.svg");
157 }
158 else
159 {
160 $type = $a_node["type"];
161 if ($type == "sktr")
162 {
163 include_once("./Services/Skill/classes/class.ilSkillTreeNode.php");
164 $type = ilSkillTreeNode::_lookupType($a_skl_template_tree_id);
165 }
166 if ($type == "sktp")
167 {
168 $type = "skll";
169 }
170 if ($type == "sctp")
171 {
172 $type = "scat";
173 }
174 $icon = ilUtil::getImagePath("icon_".$type.".svg");
175 }
176
177 return $icon;
178 }
static _lookupType($a_obj_id)
Lookup Type.
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)

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

+ Here is the call graph for this function:

◆ getNodeId()

ilVirtualSkillTreeExplorerGUI::getNodeId (   $a_node)

Get node id.

Parameters
array$a_nodenode data
Returns
string node id

Reimplemented from ilExplorerBaseGUI.

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

92 {
93 return $a_node["id"];
94 }

◆ getRootNode()

ilVirtualSkillTreeExplorerGUI::getRootNode ( )

Get root node.

Returns
array root node data

Reimplemented from ilExplorerBaseGUI.

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

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

◆ getShowDraftNodes()

ilVirtualSkillTreeExplorerGUI::getShowDraftNodes ( )

Get show draft nodes.

Returns
boolean show draft nodes

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

References $show_draft_nodes.

◆ getShowOutdatedNodes()

ilVirtualSkillTreeExplorerGUI::getShowOutdatedNodes ( )

Get show outdated nodes.

Returns
boolean show outdated notes

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

References $show_outdated_nodes.

◆ isNodeClickable()

ilVirtualSkillTreeExplorerGUI::isNodeClickable (   $a_node)

Is clickable.

Parameters

return

Reimplemented from ilExplorerBaseGUI.

Reimplemented in ilSkillSelectorGUI, and ilSkillTreeExplorerGUI.

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

214 {
215 return false;
216 }

◆ setShowDraftNodes()

ilVirtualSkillTreeExplorerGUI::setShowDraftNodes (   $a_val)

Set show draft nodes.

Parameters
boolean$a_valshow draft nodes

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

39 {
40 $this->show_draft_nodes = $a_val;
41 $this->vtree->setIncludeDrafts($a_val);
42 }

Referenced by ilSkillTreeExplorerGUI\__construct().

+ Here is the caller graph for this function:

◆ setShowOutdatedNodes()

ilVirtualSkillTreeExplorerGUI::setShowOutdatedNodes (   $a_val)

Set show outdated nodes.

Parameters
boolean$a_valshow outdated notes

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

60 {
61 $this->show_outdated_nodes = $a_val;
62 $this->vtree->setIncludeOutdated($a_val);
63 }

Referenced by ilSkillTreeExplorerGUI\__construct().

+ Here is the caller graph for this function:

Field Documentation

◆ $show_draft_nodes

ilVirtualSkillTreeExplorerGUI::$show_draft_nodes = false
protected

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

Referenced by getShowDraftNodes().

◆ $show_outdated_nodes

ilVirtualSkillTreeExplorerGUI::$show_outdated_nodes = false
protected

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

Referenced by getShowOutdatedNodes().


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