ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
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, string $a_parent_cmd, $a_select_gui, string $a_select_cmd, string $a_select_par="selected_skill", int $a_skill_tree_id=0)
 
 setSkillSelected (string $a_id)
 
 getSelectedSkills ()
 
 getNodeHref ($a_node)
 
Parameters
array | object$a_node
Returns
string
More...
 
 isNodeClickable ($a_node)
 
Parameters
array | object$a_node
Returns
bool
More...
 
- Public Member Functions inherited from ilVirtualSkillTreeExplorerGUI
 __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)
 Get DOM node id for node id.
Parameters
string$a_node_id
More...
 
 getNodeIdForDomNodeId (string $a_dom_node_id)
 Get node id for dom node id. More...
 
 getChildsOfNode ($a_parent_node_id)
 
 getNodeContent ($a_node)
 
 getNodeIcon ($a_node)
 
 getNodeHref ($a_node)
 
 isNodeClickable ($a_node)
 
 getNodeIconAlt ($a_node)
 
 getHTML ()
 
 getTreeComponent ()
 
 getChildren ($record, $environment=null)
 Get a list of records (that list can also be empty). More...
 
 build (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record, $environment=null)
 
- 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)
 
- Public Member Functions inherited from ILIAS\UI\Component\Tree\TreeRecursion
 getChildren ( $record, $environment=null)
 Get a list of records (that list can also be empty). More...
 
 build (Node\Factory $factory, $record, $environment=null)
 Build and return a Node. More...
 

Protected Member Functions

 isNodeSelectable ($a_node)
 Is node selectable?
Parameters
object | array$a_nodenode
Returns
bool node selectable true/false
More...
 
- Protected Member Functions inherited from ilVirtualSkillTreeExplorerGUI
 render ()
 
 createNode (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record)
 
- 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)
 

Protected Attributes

string $select_gui = ""
 
string $select_cmd = ""
 
string $select_par = ""
 
SkillAdminGUIRequest $admin_gui_request
 
- Protected Attributes inherited from ilVirtualSkillTreeExplorerGUI
ILIAS DI UIServices $ui
 
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
 

Private Member Functions

 nodeHasAction ($a_node)
 

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)
 
- 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 = "assets/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

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

Constructor & Destructor Documentation

◆ __construct()

ilSkillSelectorGUI::__construct (   $a_parent_obj,
string  $a_parent_cmd,
  $a_select_gui,
string  $a_select_cmd,
string  $a_select_par = "selected_skill",
int  $a_skill_tree_id = 0 
)

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

42 {
43 global $DIC;
44
45 $this->ctrl = $DIC->ctrl();
46 $this->admin_gui_request = $DIC->skills()->internal()->gui()->admin_request();
47 parent::__construct("skill_sel", $a_parent_obj, $a_parent_cmd, $a_skill_tree_id);
48 $this->select_gui = (is_object($a_select_gui))
49 ? strtolower(get_class($a_select_gui))
50 : $a_select_gui;
51 $this->select_cmd = $a_select_cmd;
52 $this->select_par = $a_select_par;
53 $this->setSkipRootNode(true);
54 }
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
global $DIC
Definition: shib_login.php:26

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

+ Here is the call graph for this function:

Member Function Documentation

◆ getNodeHref()

ilSkillSelectorGUI::getNodeHref (   $a_node)

Parameters
array | object$a_node
Returns
string

Reimplemented from ilVirtualSkillTreeExplorerGUI.

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

76 : string
77 {
78 if ($this->select_multi) {
79 return "#";
80 }
81
82 $ilCtrl = $this->ctrl;
83
84 // we have a tree id like <skl_tree_id>:<skl_template_tree_id>
85 // and make a "common" skill id in format <skill_id>:<tref_id>
86
87 $id_parts = explode(":", (string) $a_node["id"]);
88 if (!isset($id_parts[1]) || $id_parts[1] == 0) {
89 // skill in main tree
90 $skill_id = $a_node["id"];
91 } else {
92 // skill in template
93 $skill_id = $id_parts[1] . ":" . $id_parts[0];
94 }
95
96 $ilCtrl->setParameterByClass($this->select_gui, $this->select_par, $skill_id);
97 $ret = $ilCtrl->getLinkTargetByClass($this->select_gui, $this->select_cmd);
98 $ilCtrl->setParameterByClass($this->select_gui, $this->select_par, "");
99
100 return $ret;
101 }

References ilExplorerBaseGUI\$ctrl.

◆ getSelectedSkills()

ilSkillSelectorGUI::getSelectedSkills ( )

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

61 : array
62 {
63 $skills = [];
64 $pa = $this->admin_gui_request->getSelectedIds($this->select_postvar);
65 if (!empty($pa)) {
66 foreach ($pa as $p) {
67 $skills[] = $this->vtree->getCSkillIdForVTreeId($p);
68 }
69 }
70 return $skills;
71 }

◆ isNodeClickable()

ilSkillSelectorGUI::isNodeClickable (   $a_node)

Parameters
array | object$a_node
Returns
bool

Reimplemented from ilVirtualSkillTreeExplorerGUI.

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

106 : bool
107 {
108 return $this->nodeHasAction($a_node);
109 }

References nodeHasAction().

+ Here is the call graph for this function:

◆ isNodeSelectable()

ilSkillSelectorGUI::isNodeSelectable (   $a_node)
protected

Is node selectable?

Parameters
object | array$a_nodenode
Returns
bool node selectable true/false

Reimplemented from ilExplorerBaseGUI.

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

114 : bool
115 {
116 return $this->nodeHasAction($a_node);
117 }

References nodeHasAction().

+ Here is the call graph for this function:

◆ nodeHasAction()

ilSkillSelectorGUI::nodeHasAction (   $a_node)
private
Parameters
array | object$a_node
Returns
bool

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

123 : bool
124 {
125 if (in_array($a_node["type"], array("skll", "sktp"))) {
126 return true;
127 }
128 // references that refer directly to a (basic) skill template
129 if ($a_node["type"] == "sktr" && ilSkillTreeNode::_lookupType((int) $a_node["skill_id"]) == "sktp") {
130 return true;
131 }
132
133 return false;
134 }
static _lookupType(int $a_obj_id)

References ilSkillTreeNode\_lookupType().

Referenced by isNodeClickable(), and isNodeSelectable().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setSkillSelected()

ilSkillSelectorGUI::setSkillSelected ( string  $a_id)

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

56 : void
57 {
58 $this->setNodeSelected($this->vtree->getCSkillIdForVTreeId($a_id));
59 }
setNodeSelected($a_id)
Set node to be opened (additional custom opened node, not standard expand behaviour)

References ilExplorerBaseGUI\setNodeSelected().

+ Here is the call graph for this function:

Field Documentation

◆ $admin_gui_request

SkillAdminGUIRequest ilSkillSelectorGUI::$admin_gui_request
protected

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

◆ $select_cmd

string ilSkillSelectorGUI::$select_cmd = ""
protected

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

◆ $select_gui

string ilSkillSelectorGUI::$select_gui = ""
protected

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

◆ $select_par

string ilSkillSelectorGUI::$select_par = ""
protected

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


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