ilSkillExplorer Class Reference

Explorer for skill management. More...

Inheritance diagram for ilSkillExplorer:

Collaboration diagram for ilSkillExplorer:

Public Member Functions
	ilSkillExplorer ($a_target, $a_templates=false)
	Constructor public.
	setForceOpenPath ($a_path)
	set force open path
	formatHeader (&$tpl, $a_obj_id, $a_option)
	overwritten method from base class public
	formatObject (&$tpl, $a_node_id, $a_option, $a_obj_id=0)
	overwritten method from base class private
	isClickable ($a_type, $a_obj_id=0)
	check if links for certain object type are activated
	buildLinkTarget ($a_node_id, $a_type)
	build link target
	buildTitle ($a_title, $a_id, $a_type)
	standard implementation for title, may be overwritten by derived classes
	forceExpanded ($a_obj_id)
	force expansion of node
	buildFrameTarget ($a_type, $a_child=0, $a_obj_id=0)
	Get frame target.
	getImage ($a_name, $a_type="", $a_obj_id="")
	get image path (may be overwritten by derived classes)
	getChildsOfNode ($a_parent_id)
	Get childs of node.
Public Member Functions inherited from ilExplorer
	ilExplorer ($a_target)
	Constructor public.
	setAsynchExpanding ($a_val)
	Set asynch expanding.
	getAsynchExpanding ()
	Get asynch expanding.
	initItemCounter ($a_number)
	Init item counter.
	setTitle ($a_val)
	Set title.
	setTitleLength ($a_length)
	Set max title length.
	getTitleLength ()
	Get max title length.
	getTitle ()
	Get title.
	setRoot ($a_root_id)
	Set root node.
	getRoot ()
	get root id
	setOrderColumn ($a_column)
	set the order column public
	setOrderDirection ($a_direction)
	set the order direction public
	setTargetGet ($a_target_get)
	set the varname in Get-string public
	setParamsGet ($a_params_get)
	set additional params to be passed in Get-string public
	setExpandTarget ($a_exp_target)
	target script for expand icons
	setFrameUpdater ($a_up_frame, $a_up_script, $a_params="")
	Set Explorer Updater.
	highlightNode ($a_id)
	set highlighted node
	checkPermissions ($a_check)
	check permissions via rbac
	setSessionExpandVariable ($a_var_name="expand")
	set name of expand session variable
	outputIcons ($a_icons)
	output icons
	setClickable ($a_type, $a_clickable)
	(de-)activates links for a certain object type
	isVisible ($a_ref_id, $a_type)
	setTreeLead ($a_val)
	Set tree leading content.
	getTreeLead ()
	Get tree leading content.
	setPostSort ($a_sort)
	process post sorting
	setFilterMode ($a_mode=IL_FM_NEGATIVE)
	set filter mode
	getFilterMode ()
	get filter mode
	setUseStandardFrame ($a_val)
	Set use standard frame.
	getUseStandardFrame ()
	Get use standard explorer frame.
	setOutput ($a_parent_id, $a_depth=1, $a_obj_id=0, $a_highlighted_subtree=false)
	Creates output for explorer view in admin menue recursive method public.
	modifyChilds ($a_parent_id, $a_objects)
	showChilds ($a_parent_id)
	determines wether the childs of an object should be shown or not note: this standard implementation always returns true but it could be overwritten by derived classes (e.g.
	getMaximumTreeDepth ()
	Get maximum tree depth.
	getOutput ()
	Creates output recursive method public.
	handleListEndTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list end tags ( and )
	handleListStartTags (&$a_tpl_tree, $a_cur_depth, $a_item_depth)
	handle list start tags (
	getImageAlt ($a_default_text, $a_type="", $a_obj_id="")
	get image alt text
	getNodeStyleClass ($a_id, $a_type)
	get style class for node
	buildOnClick ($a_node_id, $a_type, $a_title)
	get onclick event handling (may be overwritten by derived classes)
	buildDescription ($a_desc, $a_id, $a_type)
	standard implementation for description, may be overwritten by derived classes
	buildSelect ($a_node_id, $a_type)
	standard implementation for adding an option select box between image and title
	createTarget ($a_type, $a_node_id, $a_highlighted_subtree=false, $a_append_anch=true)
	Creates Get Parameter private.
	setFrameTarget ($a_target)
	set target frame or not frame?
	createLines ($a_depth)
	Creates lines for explorer view private.
	is_in_array ($a_start, $a_depth)
	DESCRIPTION MISSING private.
	getIndex ($a_data)
	get index of format_options array from specific ref_id,parent_id private
	addFilter ($a_item)
	adds item to the filter public
	delFilter ($a_item)
	removes item from the filter public
	setExpand ($a_node_id)
	set the expand option this value is stored in a SESSION variable to save it different view (lo view, frm view,...) private
	forceExpandAll ($a_mode, $a_show_minus=true)
	force expandAll.
	setFiltered ($a_bool)
	active/deactivate the filter public
	checkFilter ($a_item)
	check if item is in filter private
	sortNodes ($a_nodes, $a_parent_obj_id)
	sort nodes and put adm object to the end of sorted array private

Data Fields
	$root_id
	$slm_obj
	$output
Data Fields inherited from ilExplorer
	$ilias
	$output
	$format_options
	$tree
	$target
	$target_get
	$params_get
	$expanded
	$order_column
	$order_direction = "asc"
	$expand_target
	$rbac_check
	$output_icons
	$expand_variable
	$is_clickable
	$post_sort
	$filtered = false
	$filter_mode
	$expand_all = false
	$root_id = null
	$use_standard_frame = false

Detailed Description

Explorer for skill management.

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

Member Function Documentation

ilSkillExplorer::buildFrameTarget	(		$a_type,
			$a_child = 0,
			$a_obj_id = 0
	)

Get frame target.

Reimplemented from ilExplorer.

Definition at line 254 of file class.ilSkillExplorer.php.

        {
                return "";
        }

ilSkillExplorer::buildLinkTarget	(		$a_node_id,
			$a_type
	)

build link target

Reimplemented from ilExplorer.

Definition at line 169 of file class.ilSkillExplorer.php.

References $_GET, $ilCtrl, and $ret.

        {
                global $ilCtrl;
                
                switch($a_type)
                {
                        // category
                        case "scat":
                                $ilCtrl->setParameterByClass("ilskillcategorygui", "obj_id", $a_node_id);
                                $ret = $ilCtrl->getLinkTargetByClass("ilskillcategorygui", "listItems");
                                $ilCtrl->setParameterByClass("ilskillcategorygui", "obj_id", $_GET["obj_id"]);
                                return $ret;
                                break;
                                
                        // skill template reference
                        case "sktr":
                                $ilCtrl->setParameterByClass("ilskilltemplatereferencegui", "obj_id", $a_node_id);
                                $ret = $ilCtrl->getLinkTargetByClass("ilskilltemplatereferencegui", "listItems");
                                $ilCtrl->setParameterByClass("ilskilltemplatereferencegui", "obj_id", $_GET["obj_id"]);
                                return $ret;
                                break;
                                
                        // skill
                        case "skll":
                                $ilCtrl->setParameterByClass("ilbasicskillgui", "obj_id", $a_node_id);
                                $ret = $ilCtrl->getLinkTargetByClass("ilbasicskillgui", "edit");
                                $ilCtrl->setParameterByClass("ilbasicskillgui", "obj_id", $_GET["obj_id"]);
                                return $ret;
                                break;
                                
                        // --------
                                
                        // template
                        case "sktp":
                                $ilCtrl->setParameterByClass("ilbasicskilltemplategui", "obj_id", $a_node_id);
                                $ret = $ilCtrl->getLinkTargetByClass("ilbasicskilltemplategui", "edit");
                                $ilCtrl->setParameterByClass("ilbasicskilltemplategui", "obj_id", $_GET["obj_id"]);
                                return $ret;
                                break;

                        // template category
                        case "sctp":
                                $ilCtrl->setParameterByClass("ilskilltemplatecategorygui", "obj_id", $a_node_id);
                                $ret = $ilCtrl->getLinkTargetByClass("ilskilltemplatecategorygui", "listItems");
                                $ilCtrl->setParameterByClass("ilskilltemplatecategorygui", "obj_id", $_GET["obj_id"]);
                                return $ret;
                                break;
                }
        }

ilSkillExplorer::buildTitle	(		$a_title,
			$a_id,
			$a_type
	)

standard implementation for title, may be overwritten by derived classes

Reimplemented from ilExplorer.

Definition at line 222 of file class.ilSkillExplorer.php.

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

        {
                if ($a_type == "sktr")
                {
                        include_once("./Services/Skill/classes/class.ilSkillTemplateReference.php");
                        $tid = ilSkillTemplateReference::_lookupTemplateId($a_id);
                        $a_title.= " (".ilSkillTreeNode::_lookupTitle($tid).")";
                }
                
                if (ilSkillTreeNode::_lookupSelfEvaluation($a_id))
                {
                        $a_title = "<u>".$a_title."</u>";
                }
                
                return $a_title;
        }

Here is the call graph for this function:

ilSkillExplorer::forceExpanded

(

$a_obj_id

)

force expansion of node

Reimplemented from ilExplorer.

Definition at line 242 of file class.ilSkillExplorer.php.

        {
                if (in_array($a_obj_id, $this->force_open_path))
                {
                        return true;
                }
                return false;
        }

ilSkillExplorer::formatHeader	(	&	$tpl,
			$a_obj_id,
			$a_option
	)

overwritten method from base class public

Parameters

integer	obj_id
integer	array options

Returns

string

Reimplemented from ilExplorer.

Definition at line 82 of file class.ilSkillExplorer.php.

References $_GET, $ilCtrl, ilExplorer\$ilias, $lng, $tpl, and ilUtil\getImagePath().

        {
                global $lng, $ilias, $ilCtrl;

                $ilCtrl->setParameterByClass("ilskillrootgui", "obj_id",
                        $this->tree->readRootId());
                
                if ($this->templates)
                {
                        $tpl->setCurrentBlock("icon");
                        $tpl->setVariable("ICON_IMAGE" , ilUtil::getImagePath("icon_sctp_s.gif"));
                        $tpl->setVariable("TXT_ALT_IMG", $lng->txt("skmg_skill_templates"));
                        $tpl->parseCurrentBlock();

                        $tpl->setCurrentBlock("link");
                        $tpl->setVariable("TITLE", $lng->txt("skmg_skill_templates"));
                        if ($this->highlighted == $this->tree->readRootId())
                        {
                                $tpl->setVariable("A_CLASS", "class='il_HighlightedNode'");
                        }
                        $tpl->setVariable("LINK_TARGET",
                                $ilCtrl->getLinkTargetByClass("ilskillrootgui", "listTemplates"));
                        $tpl->parseCurrentBlock();
                }
                else
                {
                        $tpl->setCurrentBlock("icon");
                        $tpl->setVariable("ICON_IMAGE" , ilUtil::getImagePath("icon_scat_s.gif"));
                        $tpl->setVariable("TXT_ALT_IMG", $lng->txt("skmg_skills"));
                        $tpl->parseCurrentBlock();

                        $tpl->setCurrentBlock("link");
                        $tpl->setVariable("TITLE", $lng->txt("skmg_skills"));
                        if ($this->highlighted == $this->tree->readRootId())
                        {
                                $tpl->setVariable("A_CLASS", "class='il_HighlightedNode'");
                        }
                        $tpl->setVariable("LINK_TARGET",
                                $ilCtrl->getLinkTargetByClass("ilskillrootgui", "listSkills"));
                        $tpl->parseCurrentBlock();
                }
                
                $tpl->touchBlock("element");

                $ilCtrl->setParameterByClass("ilskillrootgui", "obj_id",
                        $_GET["obj_id"]);

        }

Here is the call graph for this function:

ilSkillExplorer::formatObject	(	&	$tpl,
			$a_node_id,
			$a_option,
			$a_obj_id = 0
	)

overwritten method from base class private

Parameters

integer
array

Returns

string

Reimplemented from ilExplorer.

Definition at line 138 of file class.ilSkillExplorer.php.

References $lng, and $tpl.

        {
                global $lng;
                
/*              $tpl->setCurrentBlock("icon");
                $tpl->setVariable("ICON_IMAGE" , $this->getImage("icon_".$a_option["type"]."_s.gif", $a_option["type"], $a_obj_id));
                $tpl->setVariable("TARGET_ID" , "iconid_".$a_node_id);
                $this->iconList[] = "iconid_".$a_node_id;
                $tpl->setVariable("TXT_ALT_IMG", $lng->txt($a_option["desc"]));
                $tpl->parseCurrentBlock();
                
                $this->outputIcons(false);*/
                parent::formatObject($tpl, $a_node_id,$a_option,$a_obj_id);
        }

ilSkillExplorer::getChildsOfNode

(

$a_parent_id

)

Get childs of node.

Parameters

int

$a_parent_id

parent id

Returns

array childs

Reimplemented from ilExplorer.

Definition at line 277 of file class.ilSkillExplorer.php.

References ilSkillTreeNode\_lookupDraft().

        {
                $childs =  $this->tree->getChilds($a_parent_id, $this->order_column);
                
                foreach ($childs as $c)
                {
                        $this->parent[$c["child"]] = $c["parent"];
                        if ($this->draft[$c["parent"]])
                        {
                                $this->draft[$c["child"]] = true;
                        }
                        else
                        {
                                $this->draft[$c["child"]] = ilSkillTreeNode::_lookupDraft($c["child"]);
                        }
                }
                return $childs;
        }

Here is the call graph for this function:

ilSkillExplorer::getImage	(		$a_name,
			$a_type = "",
			$a_obj_id = ""
	)

get image path (may be overwritten by derived classes)

Reimplemented from ilExplorer.

Definition at line 262 of file class.ilSkillExplorer.php.

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

        {
                if (in_array($a_type, array("skll", "scat", "sctr", "sktr")))
                {
                        return ilSkillTreeNode::getIconPath($a_obj_id, $a_type, "_s", $this->draft[$a_obj_id]);
                }
                return ilUtil::getImagePath($a_name);
        }

Here is the call graph for this function:

ilSkillExplorer::ilSkillExplorer	(		$a_target,
			$a_templates = false
	)

Constructor public.

Parameters

string	scriptname
int	user_id

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

References ilExplorer\addFilter(), ilExplorer\checkPermissions(), IL_FM_POSITIVE, ilExplorer\ilExplorer(), ilExplorer\setFilterMode(), ilExplorer\setOrderColumn(), ilExplorer\setPostSort(), and ilExplorer\setSessionExpandVariable().

        {
                $this->templates = $a_templates;
                
                parent::ilExplorer($a_target);
                
                $this->setFilterMode(IL_FM_POSITIVE);
                if ($a_templates)
                {
                        $this->addFilter("skrt");
                        $this->addFilter("sktp");
                        $this->addFilter("sctp");
                }
                else
                {
                        $this->addFilter("skrt");
                        $this->addFilter("skll");
                        $this->addFilter("scat");
                        $this->addFilter("sktr");
                }
                
                include_once("./Services/Skill/classes/class.ilSkillTree.php");
                $this->tree = new ilSkillTree();
                $this->root_id = $this->tree->readRootId();
                
                $this->setSessionExpandVariable("skexpand");
                $this->checkPermissions(false);
                $this->setPostSort(false);
                
                $this->setOrderColumn("order_nr");
//              $this->textwidth = 200;

                $this->force_open_path = array();
        }

Here is the call graph for this function:

ilSkillExplorer::isClickable	(		$a_type,
			$a_obj_id = 0
	)

check if links for certain object type are activated

Parameters

string

$a_type

object type

Returns

boolean true if linking is activated

Reimplemented from ilExplorer.

Definition at line 160 of file class.ilSkillExplorer.php.

        {
                global $ilUser;
                return true;
        }

ilSkillExplorer::setForceOpenPath

(

$a_path

)

set force open path

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

        {
                $this->force_open_path = $a_path;
        }

Field Documentation

ilSkillExplorer::$output

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

ilSkillExplorer::$root_id

Definition at line 22 of file class.ilSkillExplorer.php.

ilSkillExplorer::$slm_obj

Definition at line 23 of file class.ilSkillExplorer.php.

---

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

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