ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
ilLMEditorExplorerGUI Class Reference

LM editor explorer GUI class. More...

+ Inheritance diagram for ilLMEditorExplorerGUI:
+ Collaboration diagram for ilLMEditorExplorerGUI:

Public Member Functions

 getNodeIcon ($a_node)
 Get node icon. More...
 
 getNodeIconAlt ($a_node)
 Get node icon alt text. More...
 
 getNodeHref ($a_node)
 Get href for node. More...
 
- Public Member Functions inherited from ilLMExplorerGUI
 __construct ($a_parent_obj, $a_parent_cmd, ilObjContentObject $a_lm, $a_id="")
 Constructor. More...
 
 beforeRendering ()
 Before rendering. More...
 
 getNodeContent ($a_node)
 Get node content. More...
 
 isNodeHighlighted ($a_node)
 Is node highlighted? 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...
 
 setRootId ($a_root)
 
 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...
 

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 ilLMExplorerGUI
 checkLPIcon ($a_id)
 Check learning progress icon. More...
 
- Protected Member Functions inherited from ilTreeExplorerGUI
 preloadChilds ()
 Preload childs. More...
 
 getRootId ()
 
- 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 inherited from ilLMExplorerGUI
 $lp_cache
 
 $cnt_lmobj
 
- 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()
 
 $enable_dnd = false
 
- 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

LM editor 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.ilLMEditorExplorerGUI.php.

Member Function Documentation

◆ getNodeHref()

ilLMEditorExplorerGUI::getNodeHref (   $a_node)

Get href for node.

Parameters
mixed$a_nodenode object/array
Returns
string href attribute

Definition at line 115 of file class.ilLMEditorExplorerGUI.php.

References $_GET, $ilCtrl, $ret, and array.

116  {
117  global $ilCtrl;
118 
119  switch($a_node["type"])
120  {
121  case "du":
122 // $ilCtrl->setParameterByClass("ilobjlearningmodulegui", "obj_id", $a_node["child"]);
123  $ret = $ilCtrl->getLinkTargetByClass("ilobjlearningmodulegui", "chapters");
124 // $ilCtrl->setParameterByClass("ilobjlearningmodulegui", "obj_id", $_GET["obj_id"]);
125  return $ret;
126  break;
127 
128  case "pg":
129  $ilCtrl->setParameterByClass("illmpageobjectgui", "obj_id", $a_node["child"]);
130  $ret = $ilCtrl->getLinkTargetByClass(array("ilobjlearningmodulegui", "illmpageobjectgui"), "edit");
131  $ilCtrl->setParameterByClass("illmpageobjectgui", "obj_id", $_GET["obj_id"]);
132  return $ret;
133  break;
134 
135  case "st":
136  $ilCtrl->setParameterByClass("ilstructureobjectgui", "obj_id", $a_node["child"]);
137  $ret = $ilCtrl->getLinkTargetByClass(array("ilobjlearningmodulegui", "ilstructureobjectgui"), "view");
138  $ilCtrl->setParameterByClass("ilstructureobjectgui", "obj_id", $_GET["obj_id"]);
139  return $ret;
140  break;
141  }
142  }
$_GET["client_id"]
global $ilCtrl
Definition: ilias.php:18
Create styles array
The data for the language used.
$ret
Definition: parser.php:6

◆ getNodeIcon()

ilLMEditorExplorerGUI::getNodeIcon (   $a_node)

Get node icon.

Parameters
array$a_nodenode array
Returns
string icon path

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

References $lm_set, ilPageObject\_isScheduledActivation(), ilPageObject\_lookupActive(), ilPageObject\_lookupContainsDeactivatedElements(), ilUtil\getImagePath(), ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

24  {
25  if ($a_node["child"] == $this->getNodeId($this->getRootNode()))
26  {
27  $icon = ilUtil::getImagePath("icon_lm.svg");
28  }
29  else
30  {
31  $a_name = "icon_".$a_node["type"].".svg";
32  if ($a_node["type"] == "pg")
33  {
34  include_once("./Modules/LearningModule/classes/class.ilLMPage.php");
35  $lm_set = new ilSetting("lm");
36  $active = ilLMPage::_lookupActive($a_node["child"], $this->lm->getType(),
37  $lm_set->get("time_scheduled_page_activation"));
38 
39  // is page scheduled?
40  $img_sc = ($lm_set->get("time_scheduled_page_activation") &&
41  ilLMPage::_isScheduledActivation($a_node["child"], $this->lm->getType()))
42  ? "_sc"
43  : "";
44 
45  $a_name = "icon_pg".$img_sc.".svg";
46 
47  if (!$active)
48  {
49  $a_name = "icon_pg_d".$img_sc.".svg";
50  }
51  else
52  {
53  include_once("./Modules/LearningModule/classes/class.ilLMPage.php");
54  $contains_dis = ilLMPage::_lookupContainsDeactivatedElements($a_node["child"],
55  $this->lm->getType());
56  if ($contains_dis)
57  {
58  $a_name = "icon_pg_del".$img_sc.".svg";
59  }
60  }
61  }
62  $icon = ilUtil::getImagePath($a_name);
63  }
64 
65  return $icon;
66  }
ILIAS Setting Class.
static _lookupActive($a_id, $a_parent_type, $a_check_scheduled_activation=false, $a_lang="-")
lookup activation status
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
getNodeId($a_node)
Get id for node.
static _lookupContainsDeactivatedElements($a_id, $a_parent_type, $a_lang="-")
lookup whether page contains deactivated elements
static _isScheduledActivation($a_id, $a_parent_type, $a_lang="-")
Check whether page is activated by time schedule.
getRootNode()
Get root node.
$lm_set
+ Here is the call graph for this function:

◆ getNodeIconAlt()

ilLMEditorExplorerGUI::getNodeIconAlt (   $a_node)

Get node icon alt text.

Parameters
array$a_nodenode array
Returns
string alt text

Definition at line 74 of file class.ilLMEditorExplorerGUI.php.

References $lm_set, $lng, ilPageObject\_lookupActive(), and ilPageObject\_lookupContainsDeactivatedElements().

75  {
76  global $lng;
77 
78  include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
79 
80  if ($a_node["type"] == "du")
81  {
82  $a_node["type"] = "lm";
83  }
84 
85  if ($a_node["type"] == "pg")
86  {
87  include_once("./Modules/LearningModule/classes/class.ilLMPage.php");
88  $lm_set = new ilSetting("lm");
89  $active = ilLMPage::_lookupActive($a_node["child"], $this->lm->getType(),
90  $lm_set->get("time_scheduled_page_activation"));
91 
92  if (!$active)
93  {
94  return $lng->txt("cont_page_deactivated");
95  }
96  else
97  {
98  $contains_dis = ilLMPage::_lookupContainsDeactivatedElements($a_node["child"],
99  $this->lm->getType());
100  if ($contains_dis)
101  {
102  return $lng->txt("cont_page_deactivated_elements");
103  }
104  }
105  }
106  return parent::getNodeIconAlt($a_node);
107  }
ILIAS Setting Class.
static _lookupActive($a_id, $a_parent_type, $a_check_scheduled_activation=false, $a_lang="-")
lookup activation status
static _lookupContainsDeactivatedElements($a_id, $a_parent_type, $a_lang="-")
lookup whether page contains deactivated elements
$lm_set
global $lng
Definition: privfeed.php:17
+ Here is the call graph for this function:

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