ilSkillTreeExplorerGUI Class Reference

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

Inheritance diagram for ilSkillTreeExplorerGUI:

Collaboration diagram for ilSkillTreeExplorerGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd)
	Constructor.
	getNodeContent ($a_node)
	Get node content.
	getNodeIcon ($a_node)
	Get node content.
	isNodeHighlighted ($a_node)
	Is node highlighted?
	getNodeHref ($a_node)
	Get href for node.
	isNodeClickable ($a_node)
	Is clickable.
Public Member Functions inherited from ilVirtualSkillTreeExplorerGUI
	__construct ($a_id, $a_parent_obj, $a_parent_cmd)
	Constructor.
	setShowDraftNodes ($a_val)
	Set show draft nodes.
	getShowDraftNodes ()
	Get show draft nodes.
	setShowOutdatedNodes ($a_val)
	Set show outdated nodes.
	getShowOutdatedNodes ()
	Get show outdated nodes.
	getRootNode ()
	Get root node.
	getNodeId ($a_node)
	Get node id.
	getChildsOfNode ($a_parent_id)
	Get childs of node.
Public Member Functions inherited from ilExplorerBaseGUI
	nodeHasVisibleChilds ($a_node)
	Node has childs?
	sortChilds ($a_childs, $a_parent_node_id)
	Sort childs.
	getNodeIconAlt ($a_node)
	Get node icon alt attribute.
	getNodeTarget ($a_node)
	Get node target (frame) attribute.
	getNodeOnClick ($a_node)
	Get node onclick attribute.
	isNodeVisible ($a_node)
	Is node visible?
	getId ()
	Get id of explorer element.
	setSkipRootNode ($a_val)
	Set skip root node.
	getSkipRootNode ()
	Get skip root node.
	setAjax ($a_val)
	Set ajax.
	getAjax ()
	Get ajax.
	setSecondaryHighlightedNodes ($a_val)
	Set secondary (background) highlighted nodes.
	getSecondaryHighlightedNodes ()
	Get secondary (background) highlighted nodes.
	setNodeOpen ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour)
	setSelectMode ($a_postvar, $a_multi=false)
	Set select mode (to deactivate, pass an empty string as postvar)
	setNodeSelected ($a_id)
	Set node to be opened (additional custom opened node, not standard expand behaviour)
	setOfflineMode ($a_val)
	Set offline mode.
	getOfflineMode ()
	Get offline mode.
	handleCommand ()
	Handle explorer internal command.
	getContainerId ()
	Get container id.
	openNode ()
	Open node.
	closeNode ()
	Close node.
	getNodeAsync ()
	Get node asynchronously.
	beforeRendering ()
	Before rendering.
	getOnLoadCode ()
	Get on load code.
	getHTML ()
	Get HTML.
	renderNode ($a_node, $tpl)
	Render node.
	renderChilds ($a_node_id, $tpl)
	Render childs.
	getDomNodeIdForNodeId ($a_node_id)
	Get DOM node id for node id.
	getNodeIdForDomNodeId ($a_dom_node_id)
	Get node id for dom node id.
	listItemStart ($tpl, $a_node)
	List item start.
	listItemEnd ($tpl)
	List item end.
	listStart ($tpl)
	List start.
	listEnd ($tpl)
	List end.

Additional Inherited Members
Static Public Member Functions inherited from ilExplorerBaseGUI
static	getLocalExplorerJsPath ()
	Get local path of explorer js.
static	getLocalJsTreeJsPath ()
	Get local path of jsTree js.
static	createHTMLExportDirs ($a_target_dir)
	Create html export directories.
static	init ()
	Init JS.
Protected Member Functions inherited from ilExplorerBaseGUI
	getNodeToggleOnClick ($a_node)
	Get onclick attribute for node toggling.
	getSelectOnClick ($a_node)
	Get onclick attribute for selecting radio/checkbox.
Protected Attributes inherited from ilVirtualSkillTreeExplorerGUI
	$show_draft_nodes = false
	$show_outdated_nodes = false
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

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

Constructor & Destructor Documentation

ilSkillTreeExplorerGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd
	)

Constructor.

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

References ilExplorerBaseGUI\setAjax(), ilVirtualSkillTreeExplorerGUI\setShowDraftNodes(), ilVirtualSkillTreeExplorerGUI\setShowOutdatedNodes(), and ilExplorerBaseGUI\setSkipRootNode().

        {
                parent::__construct("skill_exp", $a_parent_obj, $a_parent_cmd);
                
                $this->setSkipRootNode(false);
                $this->setAjax(false);
                $this->setShowDraftNodes(true);
                $this->setShowOutdatedNodes(true);
        }

Here is the call graph for this function:

Member Function Documentation

ilSkillTreeExplorerGUI::getNodeContent

(

$a_node

)

Get node content.

Parameters

array

$a_node

node data

Returns

string content

Reimplemented from ilVirtualSkillTreeExplorerGUI.

Definition at line 36 of file class.ilSkillTreeExplorerGUI.php.

References $lng, ilSkillTreeNode\_lookupSelfEvaluation(), and ilSkillTemplateReference\_lookupTemplateId().

        {
                global $lng;
                
                $a_parent_id_parts = explode(":", $a_node["id"]);
                $a_parent_skl_tree_id = $a_parent_id_parts[0];
                $a_parent_skl_template_tree_id = $a_parent_id_parts[1];
                
                // title
                $title = $a_node["title"];
                
                // root?
                if ($a_node["type"] == "skrt")
                {
                        $title = $lng->txt("skmg_skills");
                }
                else
                {
                        if ($a_node["type"] == "sktr")
                        {
                                include_once("./Services/Skill/classes/class.ilSkillTemplateReference.php");
                                $tid = ilSkillTemplateReference::_lookupTemplateId($a_parent_skl_tree_id);
                                $title.= " (".ilSkillTreeNode::_lookupTitle($tid).")";
                        }
                        
                        // @todo: fix this if possible for skill/tref_id combination
                        if (ilSkillTreeNode::_lookupSelfEvaluation($a_parent_skl_tree_id))
                        {
                                if ($a_parent_skl_template_tree_id == 0 || $a_node["type"] == "sktr")
                                {
                                        $title = "<u>".$title."</u>";
                                }
                        }
                }

                if ($this->vtree->isOutdated($a_node["id"]))
                {
                        $title = "<span class='light'>".$title."</span>";
                }

                return $title;
        }

Here is the call graph for this function:

ilSkillTreeExplorerGUI::getNodeHref

(

$a_node

)

Get href for node.

Parameters

mixed

$a_node

node object/array

Returns

string href attribute

Reimplemented from ilVirtualSkillTreeExplorerGUI.

Definition at line 154 of file class.ilSkillTreeExplorerGUI.php.

References $_GET, $cmd, $ilCtrl, and $ret.

        {
                global $ilCtrl;

                $id_parts = explode(":", $a_node["id"]);
                if ($id_parts[1] == 0)
                {
                        // skill in main tree
                        $skill_id = $a_node["id"];
                        $tref_id = 0;
                }
                else
                {
                        // skill in template
                        $tref_id = $id_parts[0];
                        $skill_id = $id_parts[1];
                }

                $gui_class = array(
                        "skrt" => "ilskillrootgui",
                        "scat" => "ilskillcategorygui",
                        "sktr" => "ilskilltemplatereferencegui",
                        "skll" => "ilbasicskillgui",
                        "sktp" => "ilbasicskilltemplategui",
                        "sctp" => "ilskilltemplatecategorygui"
                );
                
                $cmd = array(
                        "skrt" => "listSkills",
                        "scat" => "listItems",
                        "sktr" => "listItems",
                        "skll" => "edit",
                        "sktp" => "edit",
                        "sctp" => "listItems"
                );
                
                $gui_class = $gui_class[$a_node["type"]];
                $cmd = $cmd[$a_node["type"]];
                
                $ilCtrl->setParameterByClass($gui_class, "tref_id", $tref_id);
                $ilCtrl->setParameterByClass($gui_class, "obj_id", $skill_id);
                $ret = $ilCtrl->getLinkTargetByClass($gui_class, $cmd);
                $ilCtrl->setParameterByClass($gui_class, "obj_id", $_GET["obj_id"]);
                $ilCtrl->setParameterByClass($gui_class, "tref_id", $_GET["tref_id"]);

                return $ret;
        }

ilSkillTreeExplorerGUI::getNodeIcon

(

$a_node

)

Get node content.

Parameters

array

$a_node

node data

Returns

string icon path

Reimplemented from ilVirtualSkillTreeExplorerGUI.

Definition at line 85 of file class.ilSkillTreeExplorerGUI.php.

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

        {
                $a_parent_id_parts = explode(":", $a_node["id"]);
                $a_parent_skl_tree_id = $a_parent_id_parts[0];
                $a_parent_skl_template_tree_id = $a_parent_id_parts[1];

                
                // root?
                if ($a_node["type"] == "skrt")
                {
                        $icon = ilUtil::getImagePath("icon_scat.svg");
                }
                else
                {
                        if (in_array($a_node["type"], array("skll", "scat", "sctr", "sktr", "sctp", "sktp")))
                        {
                                $icon = ilSkillTreeNode::getIconPath($a_parent_skl_tree_id, $a_node["type"], "",
                                        ($this->vtree->isDraft($a_node["id"]) || $this->vtree->isOutdated($a_node["id"])));
                        }
                        else
                        {
                                $icon = ilUtil::getImagePath("icon_".$a_node["type"].".svg");
                        }
                }
                
                return $icon;
        }

Here is the call graph for this function:

ilSkillTreeExplorerGUI::isNodeClickable

(

$a_node

)

Is clickable.

Parameters

array

$a_node

node data

Returns

bool clickable true/false

Reimplemented from ilVirtualSkillTreeExplorerGUI.

Definition at line 208 of file class.ilSkillTreeExplorerGUI.php.

        {
                return true;
        }

ilSkillTreeExplorerGUI::isNodeHighlighted

(

$a_node

)

Is node highlighted?

Parameters

mixed

$a_node

node object/array

Returns

boolean node visible true/false

Reimplemented from ilExplorerBaseGUI.

Definition at line 119 of file class.ilSkillTreeExplorerGUI.php.

References $_GET.

        {
                $id_parts = explode(":", $a_node["id"]);
                if ($id_parts[1] == 0)
                {
                        // skill in main tree
                        $skill_id = $a_node["id"];
                        $tref_id = 0;
                }
                else
                {
                        // skill in template
                        $tref_id = $id_parts[0];
                        $skill_id = $id_parts[1];
                }

                if ($_GET["obj_id"] == "" && $a_node["type"] == "skrt")
                {
                        return true;
                }
                
                if ($skill_id == $_GET["obj_id"] &&
                        ($_GET["tref_id"] == $tref_id))
                {
                        return true;
                }
                return false;
        }       

---

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

• Services/Skill/classes/class.ilSkillTreeExplorerGUI.php