ilBookmarkBlockExplorerGUI Class Reference

Bookmark block explorer GUI class. More...

Inheritance diagram for ilBookmarkBlockExplorerGUI:

Collaboration diagram for ilBookmarkBlockExplorerGUI:

Public Member Functions
	__construct ($a_parent_obj, $a_parent_cmd, $a_user_id=0)
	Constructor.
	isNodeHighlighted ($a_node)
	Is node highlighted?
	getNodeHref ($a_node)
	Get href for node.
	getNodeTarget ($a_node)
	Get target for node.
	getNodeOnClick ($a_node)
	Get onclick for node.
Public Member Functions inherited from ilBookmarkExplorerGUI
	getNodeContent ($a_node)
	Get node content.
	getNodeIcon ($a_node)
	Get node icon.
	getNodeIconAlt ($a_node)
	Get node icon alt attribute.
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.
	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 block explorer GUI class.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Todo:

: target, onclick

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

Constructor & Destructor Documentation

ilBookmarkBlockExplorerGUI::__construct	(		$a_parent_obj,
			$a_parent_cmd,
			$a_user_id = 0
	)

Constructor.

Reimplemented from ilBookmarkExplorerGUI.

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

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

        {
                global $ilUser;
                
                parent::__construct($a_parent_obj, $a_parent_cmd, $a_user_id);

                $this->setTypeWhiteList(array("bmf", "dum", "bm"));
                $this->setOrderField("type DESC, title");
                $this->setSkipRootNode(true);
        }

Here is the call graph for this function:

Member Function Documentation

ilBookmarkBlockExplorerGUI::getNodeHref

(

$a_node

)

Get href for node.

Parameters

mixed

$a_node

node object/array

Returns

string href attribute

Reimplemented from ilBookmarkExplorerGUI.

Definition at line 49 of file class.ilBookmarkBlockExplorerGUI.php.

References $ilCtrl.

        {
                global $ilCtrl;
                
                switch($a_node["type"])
                {
                        // bookmark folder
                        case "bmf":
                                return "#";
                                break;
                                
                        // bookmark
                        case "bm":
                                return $a_node["target"];
                                break;
                }
        }

ilBookmarkBlockExplorerGUI::getNodeOnClick

(

$a_node

)

Get onclick for node.

Parameters

mixed

$a_node

node object/array

Returns

string onclick attribute

Reimplemented from ilExplorerBaseGUI.

Definition at line 88 of file class.ilBookmarkBlockExplorerGUI.php.

References ilExplorerBaseGUI\getNodeToggleOnClick().

        {
                if ($a_node["type"] == "bmf")
                {
                        return $this->getNodeToggleOnClick($a_node);
                }
                return "";
        }

Here is the call graph for this function:

ilBookmarkBlockExplorerGUI::getNodeTarget

(

$a_node

)

Get target for node.

Parameters

mixed

$a_node

node object/array

Returns

string target

Reimplemented from ilExplorerBaseGUI.

Definition at line 73 of file class.ilBookmarkBlockExplorerGUI.php.

        {
                if ($a_node["type"] == "bm")
                {
                        return "_blank";
                }
                return "";
        }

ilBookmarkBlockExplorerGUI::isNodeHighlighted

(

$a_node

)

Is node highlighted?

Parameters

mixed

$a_node

node object/array

Returns

boolean node visible true/false

Reimplemented from ilBookmarkExplorerGUI.

Definition at line 38 of file class.ilBookmarkBlockExplorerGUI.php.

        {
                return false;
        }       

---

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

• Services/Bookmarks/classes/class.ilBookmarkBlockExplorerGUI.php