ilPersonalSkillExplorerGUI Class Reference

Explorer for selecting a personal skill. More...

Inheritance diagram for ilPersonalSkillExplorerGUI:

Collaboration diagram for ilPersonalSkillExplorerGUI:

Public Member Functions
	__construct ( $a_parent_obj, string $a_parent_cmd, $a_select_gui, string $a_select_cmd, string $a_select_par="node_id")
	getHasSelectableNodes ()
	buildSelectableTree (int $a_node_id)
	getChildsOfNode ($a_parent_node_id)
	Get childs of node (selectable tree) More...
	getOriginalChildsOfNode (int $a_parent_id)
	Get original childs of node (whole tree) More...
	getNodeHref ($a_node)
	getNodeContent ($a_node)
	isNodeClickable ($a_node)
	getNodeIcon ($a_node)
	get image path (may be overwritten by derived classes) More...
	getNodeIconAlt ($a_node)
Public Member Functions inherited from ilTreeExplorerGUI
	__construct (string $a_expl_id, $a_parent_obj, string $a_parent_cmd, ilTree $a_tree, string $a_node_parameter_name="node_id")
	getTree ()
	setOrderField (string $a_val, bool $a_numeric=false)
	getOrderField ()
	setTypeWhiteList (array $a_val)
	Set type white list. More...
	getTypeWhiteList ()
	Get type white list. More...
	setTypeBlackList (array $a_val)
	Set type black list. More...
	getTypeBlackList ()
	Get type black list. More...
	setPreloadChilds (bool $a_val)
	getPreloadChilds ()
	getSuccessorNode ( $a_node_id, string $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 ($new=false)
	Get HTML. More...
	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)
	getTreeLabel ()
	getTreeComponent ()
	toggleExplorerNodeState ()
	Should be called by an ilCtrl-enabled command class if a tree node toggle action should be processed. More...
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
	getRootId ()
	setHasSelectableNodes (bool $a_val)
Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	matches ($node)
	Does a node match a search term (or is search term empty) More...
	getRootId ()
	createNode (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record)
	Creates at tree node, can be overwritten in derivatives if another node type should be used. More...
	getNodeStateToggleCmdClasses ($record)
	Should return an array of ilCtrl-enabled command classes which should be used to build the URL for the expand/collapse actions applied on a tree node. More...
	render ()
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 = ""
array	$all_nodes = []
array	$node = []
array	$child_nodes = []
array	$parent = []
array	$selectable = []
array	$selectable_child_nodes = []
bool	$has_selectable_nodes = false
SkillTreeFactory	$skill_tree_factory
ilSkillTreeRepository	$tree_repo
SkillTreeManager	$skill_tree_manager
Protected Attributes inherited from ilTreeExplorerGUI
ilLanguage	$lng
Psr Http Message ServerRequestInterface	$httpRequest
ilTree	$tree = null
string	$tree_label = ""
string	$order_field = ""
bool	$order_field_numeric = false
array	$type_white_list = array()
array	$type_black_list = array()
array	$childs = array()
bool	$preloaded = false
bool	$preload_childs = false
array	$root_node_data = null
array	$all_childs = array()
	$root_id = 0
ILIAS DI UIServices	$ui
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

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

Author

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

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

Constructor & Destructor Documentation

__construct()

ilPersonalSkillExplorerGUI::__construct	(		$a_parent_obj,
		string	$a_parent_cmd,
			$a_select_gui,
		string	$a_select_cmd,
		string	$a_select_par = "node_id"
	)

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

      {
        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->skill_tree_factory = $DIC->skills()->internal()->factory()->tree();
        $this->tree_repo = $DIC->skills()->internal()->repo()->getTreeRepo();
        $this->skill_tree_manager = $DIC->skills()->internal()->manager()->getTreeManager();
 
        $this->lng->loadLanguageModule("skmg");
 
        $this->tree = $this->skill_tree_factory->getGlobalTree();
        $this->root_id = $this->tree->readRootId();
 
        parent::__construct("pskill_sel", $a_parent_obj, $a_parent_cmd, $this->tree);
        $this->setSkipRootNode(true);
 
        $this->all_nodes = [];
 
        foreach ($this->tree->getChilds(0) as $c) {
            $node_id = (int) $c["child"];
            $tree_id = $this->tree_repo->getTreeIdForNodeId($node_id);
            $tree = $this->skill_tree_factory->getTreeById($tree_id);
            $all_nodes = $tree->getSubTree($tree->getNodeData($node_id));
            foreach ($all_nodes as $n) {
                $this->node[$n["child"]] = $n;
                $this->child_nodes[$n["parent"]][] = $n;
                $this->parent[$n["child"]] = $n["parent"];
                $this->all_nodes[] = $n;
            }
        }
 
 
        //              $this->setTypeWhiteList(array("skrt", "skll", "scat", "sktr"));
        $this->buildSelectableTree(0);
    }

References $all_nodes, $c, $DIC, ilTreeExplorerGUI\$tree, ILIAS\GlobalScreen\Provider\__construct(), buildSelectableTree(), ILIAS\Repository\ctrl(), ilTree\getNodeData(), ilTree\getSubTree(), ILIAS\Repository\int(), ILIAS\Repository\lng(), and ilExplorerBaseGUI\setSkipRootNode().

Here is the call graph for this function:

Member Function Documentation

buildSelectableTree()

ilPersonalSkillExplorerGUI::buildSelectableTree

(

int

$a_node_id

)

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

                                                       : void
    {
        if (in_array(ilSkillTreeNode::_lookupStatus($a_node_id), array(ilSkillTreeNode::STATUS_DRAFT, ilSkillTreeNode::STATUS_OUTDATED))) {
            if ($a_node_id != 0 && ilSkillTreeNode::_lookupType($a_node_id) !== "skrt") {
                return;
            }
        }
 
        $this->selectable[$a_node_id] = false;
        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) {
            $this->buildSelectableTree((int) $n["child"]);
        }
        if ($this->selectable[$a_node_id]) {
            $this->setHasSelectableNodes(true);
            if (isset($this->node[$a_node_id])) {
                $this->selectable_child_nodes[$this->node[$a_node_id]["parent"]][] =
                    $this->node[$a_node_id];
            }
        }
    }

References ilSkillTreeNode\_lookupSelfEvaluation(), ilSkillTreeNode\_lookupStatus(), ilSkillTreeNode\_lookupType(), buildSelectableTree(), getOriginalChildsOfNode(), setHasSelectableNodes(), ilSkillTreeNode\STATUS_DRAFT, and ilSkillTreeNode\STATUS_OUTDATED.

Referenced by __construct(), and buildSelectableTree().

Here is the call graph for this function:

Here is the caller graph for this function:

getChildsOfNode()

ilPersonalSkillExplorerGUI::getChildsOfNode

(

$a_parent_node_id

)

Get childs of node (selectable tree)

Parameters

int

$a_parent_node_id

parent id

Returns

array childs

Reimplemented from ilTreeExplorerGUI.

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

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

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

Here is the call graph for this function:

getHasSelectableNodes()

ilPersonalSkillExplorerGUI::getHasSelectableNodes

(

)

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

                                           : bool
    {
        return $this->has_selectable_nodes;
    }

References $has_selectable_nodes.

getNodeContent()

ilPersonalSkillExplorerGUI::getNodeContent

(

$a_node

)

Parameters

object | array

$a_node

Returns

string

Reimplemented from ilExplorerBaseGUI.

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

                                           : string
    {
        $lng = $this->lng;
 
        // title
        if ((int) $a_node["parent"] == 0) {
            $tree_obj = $this->skill_tree_manager->getTree((int) $a_node["skl_tree_id"]);
            $title = $tree_obj->getTitle();
        } else {
            $title = $a_node["title"];
        }
 
        return $title;
    }

References ilTreeExplorerGUI\$lng.

getNodeHref()

ilPersonalSkillExplorerGUI::getNodeHref

(

$a_node

)

Parameters

object | array

$a_node

Returns

string

Reimplemented from ilExplorerBaseGUI.

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

                                        : string
    {
        $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;
    }

References ilExplorerBaseGUI\$ctrl, and ilCtrl\setParameterByClass().

Here is the call graph for this function:

getNodeIcon()

ilPersonalSkillExplorerGUI::getNodeIcon

(

$a_node

)

get image path (may be overwritten by derived classes)

Parameters

object | array

$a_node

Returns

string

Reimplemented from ilExplorerBaseGUI.

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

                                        : string
    {
        $t = $a_node["type"];
        if ($t == "sktr") {
            return ilUtil::getImagePath("standard/icon_skll.svg");
        }
        return ilUtil::getImagePath("standard/icon_" . $t . ".svg");
    }

References ilUtil\getImagePath().

Here is the call graph for this function:

getNodeIconAlt()

ilPersonalSkillExplorerGUI::getNodeIconAlt

(

$a_node

)

Parameters

object | array

$a_node

Returns

string

Reimplemented from ilTreeExplorerGUI.

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

                                           : string
    {
        $lng = $this->lng;
 
        if ($lng->exists("skmg_" . $a_node["type"])) {
            return $lng->txt("skmg_" . $a_node["type"]);
        }
 
        return $lng->txt($a_node["type"]);
    }

References ilTreeExplorerGUI\$lng, ilLanguage\exists(), and ilLanguage\txt().

Here is the call graph for this function:

getOriginalChildsOfNode()

ilPersonalSkillExplorerGUI::getOriginalChildsOfNode

(

int

$a_parent_id

)

Get original childs of node (whole tree)

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

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

Referenced by buildSelectableTree().

Here is the caller graph for this function:

getRootId()

ilPersonalSkillExplorerGUI::getRootId ( )

protected

Reimplemented from ilTreeExplorerGUI.

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

                                  : int
    {
        return 0;
    }

isNodeClickable()

ilPersonalSkillExplorerGUI::isNodeClickable

(

$a_node

)

Parameters

object | array

$a_node

Returns

bool

Reimplemented from ilExplorerBaseGUI.

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

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

References ilSkillTreeNode\_lookupSelfEvaluation().

Here is the call graph for this function:

setHasSelectableNodes()

ilPersonalSkillExplorerGUI::setHasSelectableNodes ( bool  $a_val )

protected

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

                                                         : void
    {
        $this->has_selectable_nodes = $a_val;
    }

Referenced by buildSelectableTree().

Here is the caller graph for this function:

Field Documentation

$all_nodes

array ilPersonalSkillExplorerGUI::$all_nodes = []

protected

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

Referenced by __construct().

$child_nodes

array ilPersonalSkillExplorerGUI::$child_nodes = []

protected

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

$has_selectable_nodes

bool ilPersonalSkillExplorerGUI::$has_selectable_nodes = false

protected

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

Referenced by getHasSelectableNodes().

$node

array ilPersonalSkillExplorerGUI::$node = []

protected

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

$parent

array ilPersonalSkillExplorerGUI::$parent = []

protected

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

$select_cmd

string ilPersonalSkillExplorerGUI::$select_cmd = ""

protected

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

$select_gui

string ilPersonalSkillExplorerGUI::$select_gui = ""

protected

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

$select_par

string ilPersonalSkillExplorerGUI::$select_par = ""

protected

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

$selectable

array ilPersonalSkillExplorerGUI::$selectable = []

protected

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

$selectable_child_nodes

array ilPersonalSkillExplorerGUI::$selectable_child_nodes = []

protected

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

$skill_tree_factory

SkillTreeFactory ilPersonalSkillExplorerGUI::$skill_tree_factory

protected

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

$skill_tree_manager

SkillTreeManager ilPersonalSkillExplorerGUI::$skill_tree_manager

protected

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

$tree_repo

ilSkillTreeRepository ilPersonalSkillExplorerGUI::$tree_repo

protected

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

---

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

• components/ILIAS/Skill/Personal/class.ilPersonalSkillExplorerGUI.php