ilTreeExplorerGUI Class Reference

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

Inheritance diagram for ilTreeExplorerGUI:

Collaboration diagram for ilTreeExplorerGUI:

Public Member Functions
	__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...
	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...
	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
	preloadChilds ()
	Preload childs. More...
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...
	getJSTreePlugins ()

Protected Attributes
	$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
	$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

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	createHTMLExportDirs ($a_target_dir)
	Create html export directories. More...
static	init ()
	Init JS. More...
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.ilTreeExplorerGUI.php.

Constructor & Destructor Documentation

__construct()

ilTreeExplorerGUI::__construct	(		$a_expl_id,
			$a_parent_obj,
			$a_parent_cmd,
			$a_tree
	)

Constructor.

Definition at line 30 of file class.ilTreeExplorerGUI.php.

        {
                parent::__construct($a_expl_id, $a_parent_obj, $a_parent_cmd);
                $this->tree = $a_tree;
        }

Member Function Documentation

getChildsOfNode()

ilTreeExplorerGUI::getChildsOfNode

(

$a_parent_node_id

)

Get childs of node.

Parameters

int

$a_parent_node_id

parent id

Returns

array childs

Definition at line 216 of file class.ilTreeExplorerGUI.php.

References $childs, getOrderField(), getTypeBlackList(), and getTypeWhiteList().

Referenced by ilPublicSectionExplorerGUI\getAllNodes().

        {
                if ($this->preloaded)
                {
                        if (is_array($this->childs[$a_parent_node_id]))
                        {
                                return $this->childs[$a_parent_node_id];
                        }
                        return array();
                }

                $wl = $this->getTypeWhiteList();
                if (is_array($wl) && count($wl) > 0)
                {
                        $childs = $this->tree->getChildsByTypeFilter($a_parent_node_id, $wl, $this->getOrderField());
                }
                else
                {
                        $childs = $this->tree->getChilds($a_parent_node_id, $this->getOrderField());
                }
                
                // apply black list filter
                $bl = $this->getTypeBlackList();
                if (is_array($bl) && count($bl) > 0)
                {
                        $bl_childs = array();
                        foreach($childs as $k => $c)
                        {
                                if (!in_array($c["type"], $bl))
                                {
                                        $bl_childs[$k] = $c;
                                }
                        }
                        return $bl_childs; 
                }
                
                return $childs;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getHTML()

ilTreeExplorerGUI::getHTML

(

)

Get HTML.

Returns

string html

Definition at line 314 of file class.ilTreeExplorerGUI.php.

References getPreloadChilds(), and preloadChilds().

        {
                if ($this->getPreloadChilds())
                {
                        $this->preloadChilds();
                }
                return parent::getHTML();
        }

Here is the call graph for this function:

getNodeIconAlt()

ilTreeExplorerGUI::getNodeIconAlt

(

$a_node

)

Get node icon alt attribute.

Parameters

mixed

$a_node

node object/array

Returns

string image alt attribute

Definition at line 272 of file class.ilTreeExplorerGUI.php.

References $lng.

        {
                global $lng;
                
                return $lng->txt("icon")." ".$lng->txt("obj_".$a_node["type"]);
        }

getNodeId()

ilTreeExplorerGUI::getNodeId

(

$a_node

)

Get id for node.

Parameters

mixed

$a_node

node object/array

Returns

string id

Definition at line 261 of file class.ilTreeExplorerGUI.php.

Referenced by ilPublicSectionExplorerGUI\getAllNodes(), ilMailExplorer\getNodeContent(), ilMediaPoolExplorerGUI\getNodeContent(), ilSCORM2004EditorExplorerGUI\getNodeContent(), ilBookmarkExplorerGUI\getNodeContent(), ilAdministrationExplorerGUI\getNodeContent(), ilRepositorySelectorExplorerGUI\getNodeContent(), ilLMExplorerGUI\getNodeContent(), ilRepositoryExplorerGUI\getNodeContent(), ilPaymentObjectSelector\getNodeContent(), ilLMTOCExplorerGUI\getNodeContent(), ilMailExplorer\getNodeHref(), ilSCORM2004EditorExplorerGUI\getNodeHref(), ilLMEditorExplorerGUI\getNodeIcon(), ilMailExplorer\getNodeIcon(), ilMediaPoolExplorerGUI\getNodeIcon(), ilPublicSectionExplorerGUI\getNodeIcon(), ilSCORM2004EditorExplorerGUI\getNodeIcon(), ilMailExplorer\getNodeIconAlt(), ilSCORM2004EditorExplorerGUI\getNodeIconAlt(), ilAdministrationExplorerGUI\getNodeIconAlt(), ilRepositorySelectorExplorerGUI\getNodeIconAlt(), ilRepositoryExplorerGUI\getNodeIconAlt(), ilMediaPoolExplorerGUI\isNodeHighlighted(), ilBookmarkExplorerGUI\isNodeHighlighted(), ilMailExplorer\isNodeHighlighted(), ilSCORM2004EditorExplorerGUI\isNodeHighlighted(), ilLMExplorerGUI\isNodeHighlighted(), ilAdministrationExplorerGUI\isNodeHighlighted(), ilRepositorySelectorExplorerGUI\isNodeHighlighted(), and ilRepositoryExplorerGUI\isNodeHighlighted().

        {
                return $a_node["child"];
        }

Here is the caller graph for this function:

getOrderField()

ilTreeExplorerGUI::getOrderField

(

)

Get order field.

Returns

string order field key

Definition at line 62 of file class.ilTreeExplorerGUI.php.

References $order_field.

Referenced by ilOrgUnitExplorerGUI\getChildsOfNode(), and getChildsOfNode().

        {
                return $this->order_field;
        }

Here is the caller graph for this function:

getPreloadChilds()

ilTreeExplorerGUI::getPreloadChilds

(

)

Get preload childs.

Returns

boolean preload childs

Definition at line 122 of file class.ilTreeExplorerGUI.php.

References $preload_childs.

Referenced by getHTML().

        {
                return $this->preload_childs;
        }

Here is the caller graph for this function:

getRootNode()

ilTreeExplorerGUI::getRootNode

(

)

Get root node.

Returns

mixed node object/array

Definition at line 284 of file class.ilTreeExplorerGUI.php.

References $root_node_data, and getTree().

Referenced by ilPublicSectionExplorerGUI\getAllNodes(), ilMailExplorer\getNodeContent(), ilMediaPoolExplorerGUI\getNodeContent(), ilSCORM2004EditorExplorerGUI\getNodeContent(), ilBookmarkExplorerGUI\getNodeContent(), ilTaxonomyExplorerGUI\getNodeContent(), ilAdministrationExplorerGUI\getNodeContent(), ilRepositorySelectorExplorerGUI\getNodeContent(), ilLMExplorerGUI\getNodeContent(), ilPaymentObjectSelector\getNodeContent(), ilMailExplorer\getNodeHref(), ilSCORM2004EditorExplorerGUI\getNodeHref(), ilLMEditorExplorerGUI\getNodeIcon(), ilMailExplorer\getNodeIcon(), ilMediaPoolExplorerGUI\getNodeIcon(), ilPublicSectionExplorerGUI\getNodeIcon(), ilSCORM2004EditorExplorerGUI\getNodeIcon(), ilMailExplorer\getNodeIconAlt(), ilSCORM2004EditorExplorerGUI\getNodeIconAlt(), ilAdministrationExplorerGUI\getNodeIconAlt(), ilRepositorySelectorExplorerGUI\getNodeIconAlt(), ilMediaPoolExplorerGUI\isNodeHighlighted(), ilBookmarkExplorerGUI\isNodeHighlighted(), ilMailExplorer\isNodeHighlighted(), ilSCORM2004EditorExplorerGUI\isNodeHighlighted(), ilLMExplorerGUI\isNodeHighlighted(), ilAdministrationExplorerGUI\isNodeHighlighted(), ilRepositorySelectorExplorerGUI\isNodeHighlighted(), and preloadChilds().

        {
                if (isset($this->root_node_data))
                {
                        return $this->root_node_data;
                }
                $root_id = $this->getTree()->readRootId();
                $this->root_node_data =  $this->getTree()->getNodeData($root_id);
                return $this->root_node_data;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getSuccessorNode()

ilTreeExplorerGUI::getSuccessorNode	(		$a_node_id,
			$a_type = ""
	)

Get successor node (currently only(!) based on lft/rgt tree values)

Parameters

integer	$a_node_id	node id
string	$a_type	node type

Returns

mixed node id or false

Definition at line 187 of file class.ilTreeExplorerGUI.php.

References getTree().

Referenced by ilLMTOCExplorerGUI\isNodeClickable().

        {
                if ($this->order_field != "")
                {
                        die("ilTreeExplorerGUI::getSuccessorNode not implemented for order field ".$this->order_field);
                }

                if ($this->preloaded)
                {
                        $next_id = $a_node_id;
                        while (($next_id = $this->all_childs[$next_id]["next_node_id"]) && $a_type != "" &&
                                $this->all_childs[$next_id]["type"] != $a_type);
                        if ($next_id)
                        {
                                return $this->all_childs[$next_id];
                        }
                        return false;
                }
                return $this->getTree()->fetchSuccessorNode($a_node_id, $a_type);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getTree()

ilTreeExplorerGUI::getTree

(

)

Get tree.

Returns

object tree object

Definition at line 41 of file class.ilTreeExplorerGUI.php.

References $tree.

Referenced by ilLMTOCExplorerGUI\getNodeHref(), ilSkillTemplateTreeExplorerGUI\getRootNode(), ilLMTOCExplorerGUI\getRootNode(), ilOrgUnitExplorerGUI\getRootNode(), ilRepositoryExplorerGUI\getRootNode(), getRootNode(), getSuccessorNode(), ilLMTOCExplorerGUI\isNodeClickable(), and setPathOpen().

        {
                return $this->tree;
        }

Here is the caller graph for this function:

getTypeBlackList()

ilTreeExplorerGUI::getTypeBlackList

(

)

Get type black list.

Returns

array array of strings of node types that should be filtered out

Definition at line 102 of file class.ilTreeExplorerGUI.php.

References $type_black_list.

Referenced by ilOrgUnitExplorerGUI\getChildsOfNode(), getChildsOfNode(), and preloadChilds().

        {
                return $this->type_black_list;
        }

Here is the caller graph for this function:

getTypeWhiteList()

ilTreeExplorerGUI::getTypeWhiteList

(

)

Get type white list.

Returns

array array of strings of node types that should be retrieved

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

References $type_white_list.

Referenced by ilIntLinkRepItemExplorerGUI\__construct(), ilOrgUnitExplorerGUI\getChildsOfNode(), getChildsOfNode(), preloadChilds(), ilConditionSelector\setRefId(), and ilRepositorySelectorExplorerGUI\sortChilds().

        {
                return $this->type_white_list;
        }

Here is the caller graph for this function:

preloadChilds()

ilTreeExplorerGUI::preloadChilds ( )

protected

Preload childs.

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

References $childs, getRootNode(), getTypeBlackList(), getTypeWhiteList(), and ilUtil\sortArray().

Referenced by getHTML().

        {
                $subtree = $this->tree->getSubTree($this->getRootNode());
                foreach ($subtree as $s)
                {
                        $wl = $this->getTypeWhiteList();
                        if (is_array($wl) && count($wl) > 0 && !in_array($s["type"], $wl))
                        {
                                continue;
                        }
                        $bl = $this->getTypeBlackList();
                        if (is_array($bl) && count($bl) > 0 && in_array($s["type"], $bl))
                        {
                                continue;
                        }
                        $this->childs[$s["parent"]][] = $s;
                        $this->all_childs[$s["child"]] = $s;
                }

                if ($this->order_field != "")
                {
                        foreach ($this->childs as $k => $childs)
                        {
                                $this->childs[$k] = ilUtil::sortArray($childs, $this->order_field, "asc", $this->order_field_numeric);
                        }
                }

                // sort childs and store prev/next reference
                if ($this->order_field == "")
                {
                        $this->all_childs =
                                ilUtil::sortArray($this->all_childs, "lft", "asc", true, true);
                        $prev = false;
                        foreach ($this->all_childs as $k => $c)
                        {
                                if ($prev)
                                {
                                        $this->all_childs[$prev]["next_node_id"] = $k;
                                }
                                $this->all_childs[$k]["prev_node_id"] = $prev;
                                $this->all_childs[$k]["next_node_id"] = false;
                                $prev = $k;
                        }
                }

                $this->preloaded = true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

setOrderField()

ilTreeExplorerGUI::setOrderField	(		$a_val,
			$a_numeric = false
	)

Set order field.

Parameters

string

$a_val

order field key

Definition at line 51 of file class.ilTreeExplorerGUI.php.

Referenced by ilMailExplorer\__construct(), ilMediaPoolExplorerGUI\__construct(), ilBookmarkExplorerGUI\__construct(), ilBookmarkBlockExplorerGUI\__construct(), ilSkillTemplateTreeExplorerGUI\__construct(), ilTaxonomyExplorerGUI\__construct(), ilAdministrationExplorerGUI\__construct(), ilRepositoryExplorerGUI\__construct(), and ilRepositorySelectorExplorerGUI\__construct().

        {
                $this->order_field = $a_val;
                $this->order_field_numeric = $a_numeric;
        }

Here is the caller graph for this function:

setPathOpen()

ilTreeExplorerGUI::setPathOpen

(

$a_id

)

Set node path to be opened.

Parameters

string

$a_id

node id

Definition at line 300 of file class.ilTreeExplorerGUI.php.

References $path, getTree(), and ilExplorerBaseGUI\setNodeOpen().

Referenced by ilAdministrationExplorerGUI\__construct(), ilRepositoryExplorerGUI\__construct(), ilLMExplorerGUI\__construct(), and ilRepositorySelectorExplorerGUI\__construct().

        {
                $path = $this->getTree()->getPathId($a_id);
                foreach ($path as $id)
                {
                        $this->setNodeOpen($id);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

setPreloadChilds()

ilTreeExplorerGUI::setPreloadChilds

(

$a_val

)

Set preload childs.

Parameters

boolean

$a_val

preload childs

Definition at line 112 of file class.ilTreeExplorerGUI.php.

Referenced by ilTaxonomyExplorerGUI\__construct(), and ilLMExplorerGUI\__construct().

        {
                $this->preload_childs = $a_val;
        }

Here is the caller graph for this function:

setTypeBlackList()

ilTreeExplorerGUI::setTypeBlackList

(

$a_val

)

Set type black list.

Parameters

array

$a_val

array of strings of node types that should be filtered out

Definition at line 92 of file class.ilTreeExplorerGUI.php.

        {
                $this->type_black_list = $a_val;
        }

setTypeWhiteList()

ilTreeExplorerGUI::setTypeWhiteList

(

$a_val

)

Set type white list.

Parameters

array

$a_val

array of strings of node types that should be retrieved

Definition at line 72 of file class.ilTreeExplorerGUI.php.

Referenced by ilMediaPoolExplorerGUI\__construct(), ilBookmarkExplorerGUI\__construct(), ilIntLinkRepItemExplorerGUI\__construct(), ilForumMoveTopicsExplorer\__construct(), ilBookmarkBlockExplorerGUI\__construct(), ilSkillTemplateTreeExplorerGUI\__construct(), ilAdministrationExplorerGUI\__construct(), ilRepositoryExplorerGUI\__construct(), ilLMTOCExplorerGUI\__construct(), ilOrgUnitExplorerGUI\__construct(), ilRepositorySelectorExplorerGUI\__construct(), and ilMaterialExplorer\__construct().

        {
                $this->type_white_list = $a_val;
        }

Here is the caller graph for this function:

Field Documentation

$all_childs

ilTreeExplorerGUI::$all_childs = array()

protected

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

$childs

ilTreeExplorerGUI::$childs = array()

protected

Definition at line 21 of file class.ilTreeExplorerGUI.php.

Referenced by ilSkillTemplateTreeExplorerGUI\getChildsOfNode(), ilPersonalSkillExplorerGUI\getChildsOfNode(), ilOrgUnitExplorerGUI\getChildsOfNode(), getChildsOfNode(), preloadChilds(), ilAdministrationExplorerGUI\sortChilds(), ilRepositorySelectorExplorerGUI\sortChilds(), and ilRepositoryExplorerGUI\sortChilds().

$order_field

ilTreeExplorerGUI::$order_field = ""

protected

Definition at line 17 of file class.ilTreeExplorerGUI.php.

Referenced by getOrderField().

$order_field_numeric

ilTreeExplorerGUI::$order_field_numeric = false

protected

Definition at line 18 of file class.ilTreeExplorerGUI.php.

$preload_childs

ilTreeExplorerGUI::$preload_childs = false

protected

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

Referenced by getPreloadChilds().

$preloaded

ilTreeExplorerGUI::$preloaded = false

protected

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

$root_node_data

ilTreeExplorerGUI::$root_node_data = null

protected

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

Referenced by getRootNode().

$tree

ilTreeExplorerGUI::$tree = null

protected

Definition at line 16 of file class.ilTreeExplorerGUI.php.

Referenced by ilSCORM2004EditorExplorerGUI\__construct(), ilBookmarkExplorerGUI\__construct(), ilSkillTemplateTreeExplorerGUI\__construct(), ilRepositoryExplorerGUI\__construct(), ilAdministrationExplorerGUI\__construct(), ilLMExplorerGUI\__construct(), ilPublicSectionExplorerGUI\__construct(), ilRepositorySelectorExplorerGUI\__construct(), ilMaterialExplorer\__construct(), getTree(), ilAdministrationExplorerGUI\isNodeClickable(), ilRepositoryExplorerGUI\isNodeClickable(), ilConditionSelector\isNodeVisible(), ilRepositorySelectorExplorerGUI\isNodeVisible(), ilRepositoryExplorerGUI\isNodeVisible(), and ilConditionSelector\setRefId().

$type_black_list

ilTreeExplorerGUI::$type_black_list = array()

protected

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

Referenced by getTypeBlackList().

$type_white_list

ilTreeExplorerGUI::$type_white_list = array()

protected

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

Referenced by getTypeWhiteList().

---

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

• Services/UIComponent/Explorer2/classes/class.ilTreeExplorerGUI.php