ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilSkillSelectorGUI Class Reference

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

+ Inheritance diagram for ilSkillSelectorGUI:
+ Collaboration diagram for ilSkillSelectorGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $a_select_gui, $a_select_cmd, $a_select_par="selected_skill")
 Constructor. More...
 
 setSkillSelected ($a_id)
 Set skill to be opened. More...
 
 getSelectedSkills ()
 Get selected skills (from POST) More...
 
 getNodeHref ($a_node)
 Get href for node. More...
 
 isNodeClickable ($a_node)
 Is clickable. More...
 
- Public Member Functions inherited from ilVirtualSkillTreeExplorerGUI
 __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 Member Functions

 isNodeSelectable ($a_node)
 
- 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 ()
 

Protected Attributes

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

Private Member Functions

 nodeHasAction ($a_node)
 

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

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

Constructor & Destructor Documentation

◆ __construct()

ilSkillSelectorGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $a_select_gui,
  $a_select_cmd,
  $a_select_par = "selected_skill" 
)

Constructor.

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

References $DIC, and ilExplorerBaseGUI\setSkipRootNode().

25  {
26  global $DIC;
27 
28  $this->ctrl = $DIC->ctrl();
29  parent::__construct("skill_sel", $a_parent_obj, $a_parent_cmd);
30  $this->select_gui = (is_object($a_select_gui))
31  ? strtolower(get_class($a_select_gui))
32  : $a_select_gui;
33  $this->select_cmd = $a_select_cmd;
34  $this->select_par = $a_select_par;
35  $this->setSkipRootNode(true);
36  }
global $DIC
Definition: saml.php:7
setSkipRootNode($a_val)
Set skip root node.
+ Here is the call graph for this function:

Member Function Documentation

◆ getNodeHref()

ilSkillSelectorGUI::getNodeHref (   $a_node)

Get href for node.

Parameters
mixed$a_nodenode object/array
Returns
string href attribute

Definition at line 69 of file class.ilSkillSelectorGUI.php.

References $ctrl, $ilCtrl, and $ret.

70  {
71  if ($this->select_multi) {
72  return "#";
73  }
74 
76 
77  // we have a tree id like <skl_tree_id>:<skl_template_tree_id>
78  // and make a "common" skill id in format <skill_id>:<tref_id>
79 
80  $id_parts = explode(":", $a_node["id"]);
81  if ($id_parts[1] == 0) {
82  // skill in main tree
83  $skill_id = $a_node["id"];
84  } else {
85  // skill in template
86  $skill_id = $id_parts[1] . ":" . $id_parts[0];
87  }
88 
89  $ilCtrl->setParameterByClass($this->select_gui, $this->select_par, $skill_id);
90  $ret = $ilCtrl->getLinkTargetByClass($this->select_gui, $this->select_cmd);
91  $ilCtrl->setParameterByClass($this->select_gui, $this->select_par, "");
92 
93  return $ret;
94  }
global $ilCtrl
Definition: ilias.php:18
$ret
Definition: parser.php:6

◆ getSelectedSkills()

ilSkillSelectorGUI::getSelectedSkills ( )

Get selected skills (from POST)

Definition at line 51 of file class.ilSkillSelectorGUI.php.

References $_POST, and ilExplorerBaseGUI\$select_postvar.

52  {
53  $skills = array();
55  if (is_array($pa)) {
56  foreach ($pa as $p) {
57  $skills[] = $this->vtree->getCSkillIdForVTreeId($p);
58  }
59  }
60  return $skills;
61  }
$_POST["username"]

◆ isNodeClickable()

ilSkillSelectorGUI::isNodeClickable (   $a_node)

Is clickable.

Parameters

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

References nodeHasAction().

103  {
104  return $this->nodeHasAction($a_node);
105  }
+ Here is the call graph for this function:

◆ isNodeSelectable()

ilSkillSelectorGUI::isNodeSelectable (   $a_node)
protected

Definition at line 107 of file class.ilSkillSelectorGUI.php.

References nodeHasAction().

108  {
109  return $this->nodeHasAction($a_node);
110  }
+ Here is the call graph for this function:

◆ nodeHasAction()

ilSkillSelectorGUI::nodeHasAction (   $a_node)
private

Definition at line 112 of file class.ilSkillSelectorGUI.php.

References ilSkillTreeNode\_lookupType().

Referenced by isNodeClickable(), and isNodeSelectable().

113  {
114  if (in_array($a_node["type"], array("skll", "sktp"))) {
115  return true;
116  }
117  // references that refer directly to a (basic) skill template
118  if ($a_node["type"] == "sktr" && ilSkillTreeNode::_lookupType($a_node["skill_id"]) == "sktp") {
119  return true;
120  }
121 
122  return false;
123  }
static _lookupType($a_obj_id)
Lookup Type.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setSkillSelected()

ilSkillSelectorGUI::setSkillSelected (   $a_id)

Set skill to be opened.

Parameters

Definition at line 43 of file class.ilSkillSelectorGUI.php.

References ilExplorerBaseGUI\setNodeSelected().

44  {
45  $this->setNodeSelected($this->vtree->getCSkillIdForVTreeId($a_id));
46  }
setNodeSelected($a_id)
Set node to be opened (additional custom opened node, not standard expand behaviour) ...
+ Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilSkillSelectorGUI::$ctrl
protected

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

Referenced by getNodeHref().


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