Taxonomy explorer GUI class. More...

Inheritance diagram for ilTaxonomyExplorerGUI:

Collaboration diagram for ilTaxonomyExplorerGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_tax_id, $a_target_gui, $a_target_cmd, $a_id="")
	Constructor.
	getNodeContent ($a_node)
	Get content of node.
	getNodeHref ($a_node)
	Get node href.
	getNodeIcon ($a_node)
	Get node icon.
	isNodeHighlighted ($a_node)
Public Member Functions inherited from ilTreeExplorerGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd, $a_tree)
	Constructor.
	getTree ()
	Get tree.
	setOrderField ($a_val, $a_numeric=false)
	Set order field.
	getOrderField ()
	Get order field.
	setTypeWhiteList ($a_val)
	Set type white list.
	getTypeWhiteList ()
	Get type white list.
	setTypeBlackList ($a_val)
	Set type black list.
	getTypeBlackList ()
	Get type black list.
	setPreloadChilds ($a_val)
	Set preload childs.
	getPreloadChilds ()
	Get preload childs.
	getSuccessorNode ($a_node_id, $a_type="")
	Get successor node (currently only(!) based on lft/rgt tree values)
	getChildsOfNode ($a_parent_node_id)
	Get childs of node.
	getNodeId ($a_node)
	Get id for node.
	getNodeIconAlt ($a_node)
	Get node icon alt attribute.
	getRootNode ()
	Get root node.
	setPathOpen ($a_id)
	Set node path to be opened.
	getHTML ()
	Get HTML.
Public Member Functions inherited from ilExplorerBaseGUI
	__construct ($a_expl_id, $a_parent_obj, $a_parent_cmd)
	Constructor.
	nodeHasVisibleChilds ($a_node)
	Node has childs?
	sortChilds ($a_childs, $a_parent_node_id)
	Sort childs.
	getNodeTarget ($a_node)
	Get node target (frame) attribute.
	getNodeOnClick ($a_node)
	Get node onclick attribute.
	isNodeVisible ($a_node)
	Is node visible?
	isNodeClickable ($a_node)
	Is node clickable?
	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.
	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.
	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.
Protected Member Functions inherited from ilTreeExplorerGUI
	preloadChilds ()
	Preload childs.
Protected Attributes inherited from ilTreeExplorerGUI
	$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()
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

Taxonomy explorer GUI class.

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

Constructor & Destructor Documentation

ilTaxonomyExplorerGUI::__construct	(	$a_parent_obj,
		$a_parent_cmd,
		$a_tax_id,
		$a_target_gui,
		$a_target_cmd,
		$a_id = `""`
	)

Constructor.

Parameters

@return

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

References ilObjTaxonomy\lookupSortingMode(), ilTreeExplorerGUI\setOrderField(), ilTreeExplorerGUI\setPreloadChilds(), and ilObjTaxonomy\SORT_ALPHABETICAL.

        {
                include_once("./Services/Taxonomy/classes/class.ilTaxonomyTree.php");
                $this->tax_tree = new ilTaxonomyTree($a_tax_id);
                if ($a_id != "")
                {
                        $this->id = $a_id;
                }
                else
                {
                        $this->id = "tax_expl_".$this->tax_tree->getTreeId();
                }
                include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
                if (ilObjTaxonomy::lookupSortingMode($a_tax_id) == ilObjTaxonomy::SORT_ALPHABETICAL)
                {
                        $this->setOrderField("title");
                }
                else
                {
                        $this->setOrderField("order_nr", true);
                }
                $this->setPreloadChilds(true);
                $this->target_gui = $a_target_gui; 
                $this->target_cmd = $a_target_cmd;
                //$this->setOrderField("title");
                parent::__construct($this->id, $a_parent_obj, $a_parent_cmd, $this->tax_tree);
        }

Here is the call graph for this function:

Member Function Documentation

ilTaxonomyExplorerGUI::getNodeContent ( $a_node )

Get content of node.

Parameters

@return

Reimplemented from ilExplorerBaseGUI.

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

References ilObject\_lookupTitle(), and ilTreeExplorerGUI\getRootNode().

        {
                $rn = $this->getRootNode();
                if ($rn["child"] == $a_node["child"])
                {
                        return ilObject::_lookupTitle($this->tax_tree->getTreeId());
                }
                else
                {
                        return $a_node["title"];
                }
        }

Here is the call graph for this function:

ilTaxonomyExplorerGUI::getNodeHref ( $a_node )

Get node href.

Parameters

@return

Reimplemented from ilExplorerBaseGUI.

Definition at line 77 of file class.ilTaxonomyExplorerGUI.php.

References $_GET, and $ilCtrl.

        {
                global $ilCtrl;
                
                $ilCtrl->setParameterByClass($this->target_gui, "tax_node", $a_node["child"]);
                $href = $ilCtrl->getLinkTargetByClass($this->target_gui, $this->target_cmd);
                $ilCtrl->setParameterByClass($this->target_gui, "tax_node", $_GET["tax_node"]);
                return $href;
        }

ilTaxonomyExplorerGUI::getNodeIcon ( $a_node )

Get node icon.

Parameters

@return

Reimplemented from ilExplorerBaseGUI.

Definition at line 93 of file class.ilTaxonomyExplorerGUI.php.

References ilUtil\getImagePath().

        {
                return ilUtil::getImagePath("icon_taxn_s.png");
        }

Here is the call graph for this function:

ilTaxonomyExplorerGUI::isNodeHighlighted ( $a_node )

Parameters

@return

Reimplemented from ilExplorerBaseGUI.

Definition at line 104 of file class.ilTaxonomyExplorerGUI.php.

References $_GET.

        {
                if ($a_node["child"] == $_GET["tax_node"])
                {
                        return true;
                }
                return false;
        }

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

Services/Taxonomy/classes/class.ilTaxonomyExplorerGUI.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation