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

SCORM editor explorer GUI class. More...

+ Inheritance diagram for ilSCORM2004EditorExplorerGUI:
+ Collaboration diagram for ilSCORM2004EditorExplorerGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $a_slm)
 Constructor. More...
 
 getNodeContent ($a_node)
 Get node content. More...
 
 getNodeIcon ($a_node)
 Get node icon. More...
 
 getNodeIconAlt ($a_node)
 Get node icon alt text. 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...
 
 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 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 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

SCORM 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.ilSCORM2004EditorExplorerGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilSCORM2004EditorExplorerGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $a_slm 
)

Constructor.

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

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

20  {
21  global $ilUser;
22 
23  $this->slm = $a_slm;
24 
25  $tree = new ilTree($this->slm->getId());
26  $tree->setTableNames('sahs_sc13_tree','sahs_sc13_tree_node');
27  $tree->setTreeTablePK("slm_id");
28 
29  parent::__construct("scorm_ed_exp", $a_parent_obj, $a_parent_cmd, $tree);
30 
31  //$this->setTypeWhiteList(array("du", "chap", "page"));
32  $this->setSkipRootNode(false);
33  $this->setAjax(false);
34  }
setSkipRootNode($a_val)
Set skip root node.
$ilUser
Definition: imgupload.php:18
Tree class data representation in hierachical trees using the Nested Set Model with Gaps by Joe Celco...
+ Here is the call graph for this function:

Member Function Documentation

◆ getNodeContent()

ilSCORM2004EditorExplorerGUI::getNodeContent (   $a_node)

Get node content.

Parameters
array
Returns

Definition at line 42 of file class.ilSCORM2004EditorExplorerGUI.php.

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

43  {
44  global $lng;
45 
46  if ($a_node["child"] == $this->getNodeId($this->getRootNode()))
47  {
48  return $this->slm->getTitle();
49  }
50 
51  return $a_node["title"];
52  }
getNodeId($a_node)
Get id for node.
getRootNode()
Get root node.
global $lng
Definition: privfeed.php:17
+ Here is the call graph for this function:

◆ getNodeHref()

ilSCORM2004EditorExplorerGUI::getNodeHref (   $a_node)

Get href for node.

Parameters
mixed$a_nodenode object/array
Returns
string href attribute

Definition at line 114 of file class.ilSCORM2004EditorExplorerGUI.php.

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

115  {
116  global $ilCtrl;
117 
118  if ($a_node["child"] == $this->getNodeId($this->getRootNode()))
119  {
120  $ilCtrl->setParameterByClass("ilobjscorm2004learningmodulegui", "obj_id", $a_node["child"]);
121  $ret = $ilCtrl->getLinkTargetByClass("ilobjscorm2004learningmodulegui", "showOrganization");
122  $ilCtrl->setParameterByClass("ilobjscorm2004learningmodulegui", "obj_id", $_GET["obj_id"]);
123  return $ret;
124  }
125 
126  switch($a_node["type"])
127  {
128  case "page":
129  $ilCtrl->setParameterByClass("ilScorm2004PageNodeGUI", "obj_id", $a_node["child"]);
130  $ret = $ilCtrl->getLinkTargetByClass("ilScorm2004PageNodeGUI", "edit");
131  $ilCtrl->setParameterByClass("ilScorm2004PageNodeGUI", "obj_id", $_GET["obj_id"]);
132  return $ret;
133  break;
134 
135  case "chap":
136  $ilCtrl->setParameterByClass("ilScorm2004ChapterGUI", "obj_id", $a_node["child"]);
137  $ret = $ilCtrl->getLinkTargetByClass("ilScorm2004ChapterGUI", "showOrganization");
138  $ilCtrl->setParameterByClass("ilScorm2004ChapterGUI", "obj_id", $_GET["obj_id"]);
139  return $ret;
140  break;
141 
142  case "sco":
143  $ilCtrl->setParameterByClass("ilScorm2004ScoGUI", "obj_id", $a_node["child"]);
144  $ret = $ilCtrl->getLinkTargetByClass("ilScorm2004ScoGUI", "showOrganization");
145  $ilCtrl->setParameterByClass("ilScorm2004ScoGUI", "obj_id", $_GET["obj_id"]);
146  return $ret;
147  break;
148 
149  case "ass":
150  $ilCtrl->setParameterByClass("ilScorm2004AssetGUI", "obj_id", $a_node["child"]);
151  $ret = $ilCtrl->getLinkTargetByClass("ilScorm2004AssetGUI", "showOrganization");
152  $ilCtrl->setParameterByClass("ilScorm2004AssetGUI", "obj_id", $_GET["obj_id"]);
153  return $ret;
154  break;
155  }
156  }
$_GET["client_id"]
global $ilCtrl
Definition: ilias.php:18
getNodeId($a_node)
Get id for node.
getRootNode()
Get root node.
$ret
Definition: parser.php:6
+ Here is the call graph for this function:

◆ getNodeIcon()

ilSCORM2004EditorExplorerGUI::getNodeIcon (   $a_node)

Get node icon.

Parameters
array
Returns

Definition at line 60 of file class.ilSCORM2004EditorExplorerGUI.php.

References ilUtil\getImagePath(), ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().

61  {
62  if ($a_node["child"] == $this->getNodeId($this->getRootNode()))
63  {
64  $icon = ilUtil::getImagePath("icon_sahs.svg");
65  }
66  else
67  {
68  $icon = ilUtil::getImagePath("icon_".$a_node["type"].".svg");
69  }
70 
71  return $icon;
72  }
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.
getRootNode()
Get root node.
+ Here is the call graph for this function:

◆ getNodeIconAlt()

ilSCORM2004EditorExplorerGUI::getNodeIconAlt (   $a_node)

Get node icon alt text.

Parameters
arraynode array
Returns
string alt text

Definition at line 80 of file class.ilSCORM2004EditorExplorerGUI.php.

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

81  {
82  global $lng;
83 
84  if ($a_node["child"] == $this->getNodeId($this->getRootNode()))
85  {
86  return $this->slm->getTitle();
87  }
88 
89  return parent::getNodeIconAlt($a_node);
90  }
getNodeId($a_node)
Get id for node.
getRootNode()
Get root node.
global $lng
Definition: privfeed.php:17
+ Here is the call graph for this function:

◆ isNodeHighlighted()

ilSCORM2004EditorExplorerGUI::isNodeHighlighted (   $a_node)

Is node highlighted?

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

Definition at line 98 of file class.ilSCORM2004EditorExplorerGUI.php.

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

99  {
100  if ($a_node["child"] == $_GET["obj_id"] ||
101  ($_GET["obj_id"] == "" && $a_node["child"] == $this->getNodeId($this->getRootNode())))
102  {
103  return true;
104  }
105  return false;
106  }
$_GET["client_id"]
getNodeId($a_node)
Get id for node.
getRootNode()
Get root node.
+ Here is the call graph for this function:

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