ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f87
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. More...
 
 isNodeHighlighted ($a_node)
 Is node highlighted? More...
 
 getNodeHref ($a_node)
 Get href for node. More...
 
 getNodeTarget ($a_node)
 Get target for node. More...
 
 getNodeOnClick ($a_node)
 Get onclick for node. More...
 
 getHTML ()
 Get HTML. More...
 
- Public Member Functions inherited from ilBookmarkExplorerGUI
 __construct ($a_parent_obj, $a_parent_cmd, $a_user_id=0)
 Constructor. More...
 
 getNodeContent ($a_node)
 Get node content. More...
 
 getNodeIcon ($a_node)
 Get node icon. More...
 
 getNodeIconAlt ($a_node)
 Get node icon alt attribute. More...
 
 isNodeHighlighted ($a_node)
 Is node highlighted? More...
 
 getNodeHref ($a_node)
 Get href for node. More...
 
- Public Member Functions inherited from ilTreeExplorerGUI
 __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...
 

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...
 
- Protected Member Functions inherited from ilTreeExplorerGUI
 preloadChilds ()
 Preload childs. More...
 
- Protected Member Functions inherited from ilExplorerBaseGUI
 getNodeToggleOnClick ($a_node)
 Get onclick attribute for node toggling. More...
 
 getSelectOnClick ($a_node)
 Get onclick attribute for selecting radio/checkbox. More...
 
- 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()
 
- 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()
 
- 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

◆ __construct()

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

Constructor.

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

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

22  {
23  global $ilUser;
24 
25  parent::__construct($a_parent_obj, $a_parent_cmd, $a_user_id);
26 
27  $this->setTypeWhiteList(array("bmf", "dum", "bm"));
28  $this->setOrderField("type DESC, title");
29  $this->setSkipRootNode(true);
30  }
setSkipRootNode($a_val)
Set skip root node.
setTypeWhiteList($a_val)
Set type white list.
global $ilUser
Definition: imgupload.php:15
setOrderField($a_val, $a_numeric=false)
Set order field.
+ Here is the call graph for this function:

Member Function Documentation

◆ getHTML()

ilBookmarkBlockExplorerGUI::getHTML ( )

Get HTML.

Parameters

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

References $ilCtrl.

104  {
105  global $ilCtrl;
106 
107  $add = "";
108  if ($ilCtrl->isAsynch())
109  {
110  $add = "<script>".$this->getOnLoadCode()."</script>";
111  }
112 
113  return parent::getHTML().$add;
114 
115  }
global $ilCtrl
Definition: ilias.php:18

◆ getNodeHref()

ilBookmarkBlockExplorerGUI::getNodeHref (   $a_node)

Get href for node.

Parameters
mixed$a_nodenode object/array
Returns
string href attribute

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

References $ilCtrl.

50  {
51  global $ilCtrl;
52 
53  switch($a_node["type"])
54  {
55  // bookmark folder
56  case "bmf":
57  return "#";
58  break;
59 
60  // bookmark
61  case "bm":
62  return $a_node["target"];
63  break;
64  }
65  }
global $ilCtrl
Definition: ilias.php:18

◆ getNodeOnClick()

ilBookmarkBlockExplorerGUI::getNodeOnClick (   $a_node)

Get onclick for node.

Parameters
mixed$a_nodenode object/array
Returns
string onclick attribute

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

References ilExplorerBaseGUI\getNodeToggleOnClick().

89  {
90  if ($a_node["type"] == "bmf")
91  {
92  return $this->getNodeToggleOnClick($a_node);
93  }
94  return "";
95  }
getNodeToggleOnClick($a_node)
Get onclick attribute for node toggling.
+ Here is the call graph for this function:

◆ getNodeTarget()

ilBookmarkBlockExplorerGUI::getNodeTarget (   $a_node)

Get target for node.

Parameters
mixed$a_nodenode object/array
Returns
string target

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

74  {
75  if ($a_node["type"] == "bm")
76  {
77  return "_blank";
78  }
79  return "";
80  }

◆ isNodeHighlighted()

ilBookmarkBlockExplorerGUI::isNodeHighlighted (   $a_node)

Is node highlighted?

Parameters
mixed$a_nodenode object/array
Returns
boolean node visible true/false

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

39  {
40  return false;
41  }

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