Bookmark explorer GUI class. More...

Inheritance diagram for ilBookmarkExplorerGUI:

Collaboration diagram for ilBookmarkExplorerGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_user_id=0)
	Constructor.
	getNodeContent ($a_node)
	Get node content.
	getNodeIcon ($a_node)
	Get node icon.
	getNodeIconAlt ($a_node)
	Get node icon alt attribute.
	isNodeHighlighted ($a_node)
	Is node highlighted?
	getNodeHref ($a_node)
	Get href for 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.
	getRootNode ()
	Get root node.
	setPathOpen ($a_id)
	Set node path to be opened.
	getHTML ()
	Get HTML.
Public Member Functions inherited from ilExplorerBaseGUI
	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

Bookmark 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.ilBookmarkExplorerGUI.php.

Constructor & Destructor Documentation

ilBookmarkExplorerGUI::__construct	(	$a_parent_obj,
		$a_parent_cmd,
		$a_user_id = `0`
	)

Constructor.

Reimplemented from ilExplorerBaseGUI.

Reimplemented in ilBookmarkBlockExplorerGUI.

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

References $ilUser, ilTreeExplorerGUI\$tree, ilExplorerBaseGUI\setAjax(), ilTreeExplorerGUI\setOrderField(), ilExplorerBaseGUI\setSkipRootNode(), and ilTreeExplorerGUI\setTypeWhiteList().

        {
                global $ilUser;
                
                if ($a_user_id == 0)
                {
                        $a_user_id = $ilUser->getId();
                }
                include_once("./Services/Bookmarks/classes/class.ilBookmarkTree.php");
                $tree = new ilBookmarkTree($a_user_id);
                parent::__construct("bm_exp", $a_parent_obj, $a_parent_cmd, $tree);
                $this->setTypeWhiteList(array("bmf", "dum"));
                
                $this->setSkipRootNode(false);
                $this->setAjax(false);
                $this->setOrderField("title");
        }

Here is the call graph for this function:

Member Function Documentation

ilBookmarkExplorerGUI::getNodeContent ( $a_node )

Get node content.

Parameters

array

Returns

Reimplemented from ilExplorerBaseGUI.

Definition at line 44 of file class.ilBookmarkExplorerGUI.php.

References $lng, ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

        {
                global $lng;
                
                if ($a_node["child"] == $this->getNodeId($this->getRootNode()))
                {
                        return $lng->txt("bookmarks");
                }
                                
                return $a_node["title"];
        }

Here is the call graph for this function:

ilBookmarkExplorerGUI::getNodeHref ( $a_node )

Get href for node.

Parameters

mixed $a_node node object/array

Returns: string href attribute

Reimplemented from ilExplorerBaseGUI.

Reimplemented in ilBookmarkBlockExplorerGUI, and ilBookmarkMoveExplorerGUI.

Definition at line 105 of file class.ilBookmarkExplorerGUI.php.

References $_GET, $ilCtrl, and $ret.

        {
                global $ilCtrl;
                
                switch($a_node["type"])
                {
                        // bookmark folder
                        case "bmf":
                        // dummy root
                        case "dum":
                                $ilCtrl->setParameterByClass("ilbookmarkadministrationgui", "bmf_id", $a_node["child"]);
                                $ret = $ilCtrl->getLinkTargetByClass("ilbookmarkadministrationgui", "");
                                $ilCtrl->setParameterByClass("ilbookmarkadministrationgui", "bmf_id", $_GET["bmf_id"]);
                                return $ret;
                                break;
                }
        }

ilBookmarkExplorerGUI::getNodeIcon ( $a_node )

Get node icon.

Parameters

array

Returns

Reimplemented from ilExplorerBaseGUI.

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

References ilUtil\getImagePath().

        {
                $icon = ilUtil::getImagePath("icon_".$a_node["type"]."_s.png");
                
                return $icon;
        }

Here is the call graph for this function:

ilBookmarkExplorerGUI::getNodeIconAlt ( $a_node )

Get node icon alt attribute.

Parameters

mixed $a_node node object/array

Returns: string image alt attribute

Reimplemented from ilTreeExplorerGUI.

Definition at line 75 of file class.ilBookmarkExplorerGUI.php.

References $lng.

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

ilBookmarkExplorerGUI::isNodeHighlighted ( $a_node )

Is node highlighted?

Parameters

mixed $a_node node object/array

Returns: boolean node visible true/false

Reimplemented from ilExplorerBaseGUI.

Reimplemented in ilBookmarkBlockExplorerGUI, and ilBookmarkMoveExplorerGUI.

Definition at line 89 of file class.ilBookmarkExplorerGUI.php.

References $_GET, ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

        {
                if ($a_node["child"] == $_GET["bmf_id"] ||
                        ($_GET["bmf_id"] == "" && $a_node["child"] == $this->getNodeId($this->getRootNode())))
                {
                        return true;
                }
                return false;
        }       

Here is the call graph for this function:

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

Services/Bookmarks/classes/class.ilBookmarkExplorerGUI.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation