Explorer for selecting a personal skill. More...

Inheritance diagram for ilPersonalSkillExplorerGUI:

Collaboration diagram for ilPersonalSkillExplorerGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_select_gui, $a_select_cmd, $a_select_par="obj_id")
	Constructor. More...

	getHasSelectableNodes ()
	Get selectable nodes exist? More...

	buildSelectableTree ($a_node_id)
	Build selectable tree. More...

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

	getOriginalChildsOfNode ($a_parent_id)
	Get original childs of node (whole tree) More...

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

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

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

	getNodeIcon ($a_node)
	get image path (may be overwritten by derived classes) More...

	getNodeIconAlt ($a_node)
	Get node icon alt attribute. 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...

	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
	setHasSelectableNodes ($a_val)
	Set selectable nodes exist? More...

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

	matches ($node)
	Does a node match a search term (or is search term empty) 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...

	isNodeOpen ($node_id)
	Get all open nodes. More...

	getJSTreePlugins ()

Protected Attributes
	$ctrl

	$lng

	$selectable = array()

	$selectable_child_nodes = array()

	$has_selectable_nodes = false

Protected Attributes inherited from ilTreeExplorerGUI
	$lng

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

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 for selecting a personal skill.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 15 of file class.ilPersonalSkillExplorerGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPersonalSkillExplorerGUI::__construct	(	$a_parent_obj,
		$a_parent_cmd,
		$a_select_gui,
		$a_select_cmd,
		$a_select_par = `"obj_id"`
	)

Constructor.

Definition at line 34 of file class.ilPersonalSkillExplorerGUI.php.

References $DIC, $n, buildSelectableTree(), and ilExplorerBaseGUI\setSkipRootNode().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         
         $this->select_gui = (is_object($a_select_gui))
             ? strtolower(get_class($a_select_gui))
             : $a_select_gui;
         $this->select_cmd = $a_select_cmd;
         $this->select_par = $a_select_par;
 
         $this->lng->loadLanguageModule("skmg");
         
         include_once("./Services/Skill/classes/class.ilSkillTree.php");
         $this->tree = new ilSkillTree();
         $this->root_id = $this->tree->readRootId();
         
         parent::__construct("pskill_sel", $a_parent_obj, $a_parent_cmd, $this->tree);
         $this->setSkipRootNode(true);
         
         $this->all_nodes = $this->tree->getSubTree($this->tree->getNodeData($this->root_id));
         foreach ($this->all_nodes as $n) {
             $this->node[$n["child"]] = $n;
             $this->child_nodes[$n["parent"]][] = $n;
             $this->parent[$n["child"]] = $n["parent"];
             //echo "-$k-"; var_dump($n);
         }
 
         
         //              $this->setTypeWhiteList(array("skrt", "skll", "scat", "sktr"));
         $this->buildSelectableTree($this->tree->readRootId());
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildSelectableTree()

ilPersonalSkillExplorerGUI::buildSelectableTree ( $a_node_id )

Build selectable tree.

Parameters

int $a_node_id tree id

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

References $n, ilSkillTreeNode\_lookupSelfEvaluation(), ilSkillTreeNode\_lookupStatus(), getOriginalChildsOfNode(), setHasSelectableNodes(), ilSkillTreeNode\STATUS_DRAFT, and ilSkillTreeNode\STATUS_OUTDATED.

Referenced by __construct().

     {
         //echo "<br>-$a_node_id-";
         if (in_array(ilSkillTreeNode::_lookupStatus($a_node_id), array(ilSkillTreeNode::STATUS_DRAFT, ilSkillTreeNode::STATUS_OUTDATED))) {
             return;
         }
 
         if (ilSkillTreeNode::_lookupSelfEvaluation($a_node_id)) {
             $this->selectable[$a_node_id] = true;
             $cid = $a_node_id;
             //$this->selectable[$this->parent[$a_node_id]] = true;
             while (isset($this->parent[$cid])) {
                 $this->selectable[$this->parent[$cid]] = true;
                 $cid = $this->parent[$cid];
             }
         }
         foreach ($this->getOriginalChildsOfNode($a_node_id) as $n) {
             //echo "+".$n["child"]."+";
             $this->buildSelectableTree($n["child"]);
         }
         if ($this->selectable[$a_node_id]) {
             $this->setHasSelectableNodes(true);
             $this->selectable_child_nodes[$this->node[$a_node_id]["parent"]][] =
                 $this->node[$a_node_id];
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildsOfNode()

ilPersonalSkillExplorerGUI::getChildsOfNode ( $a_parent_id )

Get childs of node (selectable tree)

Parameters

int $a_parent_id parent id

Returns: array childs

Definition at line 127 of file class.ilPersonalSkillExplorerGUI.php.

References ilTreeExplorerGUI\$childs, and ilUtil\sortArray().

     {
         if (is_array($this->selectable_child_nodes[$a_parent_id])) {
             $childs = $this->selectable_child_nodes[$a_parent_id];
             $childs = ilUtil::sortArray($childs, "order_nr", "asc", true);
             return $childs;
         }
         return array();
     }

Here is the call graph for this function:

◆ getHasSelectableNodes()

ilPersonalSkillExplorerGUI::getHasSelectableNodes ( )

Get selectable nodes exist?

Returns: bool selectable nodes exist

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

References $has_selectable_nodes.

     {
         return $this->has_selectable_nodes;
     }

◆ getNodeContent()

ilPersonalSkillExplorerGUI::getNodeContent ( $a_node )

Get node content.

Parameters

array

Returns

Definition at line 176 of file class.ilPersonalSkillExplorerGUI.php.

References $lng, and $title.

     {
         $lng = $this->lng;
 
         // title
         $title = $a_node["title"];
 
         return $title;
     }

◆ getNodeHref()

ilPersonalSkillExplorerGUI::getNodeHref ( $a_node )

Get href for node.

Parameters

mixed $a_node node object/array

Returns: string href attribute

Definition at line 157 of file class.ilPersonalSkillExplorerGUI.php.

References $ctrl, $ilCtrl, and $ret.

     {
         $ilCtrl = $this->ctrl;
         
         $skill_id = $a_node["child"];
         
         $ilCtrl->setParameterByClass($this->select_gui, $this->select_par, $skill_id);
         $ret = $ilCtrl->getLinkTargetByClass($this->select_gui, $this->select_cmd);
         $ilCtrl->setParameterByClass($this->select_gui, $this->select_par, "");
         
         return $ret;
     }

◆ getNodeIcon()

ilPersonalSkillExplorerGUI::getNodeIcon ( $a_node )

get image path (may be overwritten by derived classes)

Definition at line 203 of file class.ilPersonalSkillExplorerGUI.php.

References $t, and ilUtil\getImagePath().

     {
         $t = $a_node["type"];
         if (in_array($t, array("sktr"))) {
             return ilUtil::getImagePath("icon_skll.svg");
         }
         return ilUtil::getImagePath("icon_" . $t . ".svg");
     }

Here is the call graph for this function:

◆ getNodeIconAlt()

ilPersonalSkillExplorerGUI::getNodeIconAlt ( $a_node )

Get node icon alt attribute.

Parameters

mixed $a_node node object/array

Returns: string image alt attribute

Definition at line 218 of file class.ilPersonalSkillExplorerGUI.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"]);
     }

◆ getOriginalChildsOfNode()

ilPersonalSkillExplorerGUI::getOriginalChildsOfNode ( $a_parent_id )

Get original childs of node (whole tree)

Parameters

int $a_parent_id parent id

Returns: array childs

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

Referenced by buildSelectableTree().

     {
         if (is_array($this->child_nodes[$a_parent_id])) {
             return $this->child_nodes[$a_parent_id];
         }
         return array();
     }

Here is the caller graph for this function:

◆ isNodeClickable()

ilPersonalSkillExplorerGUI::isNodeClickable ( $a_node )

Is clickable.

Parameters

Definition at line 192 of file class.ilPersonalSkillExplorerGUI.php.

References ilSkillTreeNode\_lookupSelfEvaluation().

     {
         if (!ilSkillTreeNode::_lookupSelfEvaluation($a_node["child"])) {
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ setHasSelectableNodes()

ilPersonalSkillExplorerGUI::setHasSelectableNodes ( $a_val )

protected

Set selectable nodes exist?

Parameters

bool $a_val selectable nodes exist

Definition at line 74 of file class.ilPersonalSkillExplorerGUI.php.

Referenced by buildSelectableTree().

     {
         $this->has_selectable_nodes = $a_val;
     }

Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilPersonalSkillExplorerGUI::$ctrl

protected

Definition at line 20 of file class.ilPersonalSkillExplorerGUI.php.

Referenced by getNodeHref().

◆ $has_selectable_nodes

ilPersonalSkillExplorerGUI::$has_selectable_nodes = false

protected

Definition at line 29 of file class.ilPersonalSkillExplorerGUI.php.

Referenced by getHasSelectableNodes().

◆ $lng

ilPersonalSkillExplorerGUI::$lng

protected

Definition at line 25 of file class.ilPersonalSkillExplorerGUI.php.

Referenced by getNodeContent(), and getNodeIconAlt().

◆ $selectable

ilPersonalSkillExplorerGUI::$selectable = array()

protected

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

◆ $selectable_child_nodes

ilPersonalSkillExplorerGUI::$selectable_child_nodes = array()

protected

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

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

Services/Skill/classes/class.ilPersonalSkillExplorerGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildSelectableTree()

◆ getChildsOfNode()

◆ getHasSelectableNodes()

◆ getNodeContent()

◆ getNodeHref()

◆ getNodeIcon()

◆ getNodeIconAlt()

◆ getOriginalChildsOfNode()

◆ isNodeClickable()

◆ setHasSelectableNodes()

Field Documentation

◆ $ctrl

◆ $has_selectable_nodes

◆ $lng

◆ $selectable

◆ $selectable_child_nodes