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... | |
| setChildLimit ($a_val) | |
| Set child limit. More... | |
| getChildLimit () | |
| Get child limit. More... | |
| setSearchTerm ($a_val) | |
| Set search term. More... | |
| getSearchTerm () | |
| Get search term. More... | |
| setMainTemplate (ilTemplate $a_main_tpl=null) | |
| Set main template (that is responsible for adding js/css) 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... | |
Protected Attributes | |
| $user | |
| Protected Attributes inherited from ilTreeExplorerGUI | |
| $lng | |
| $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 | |
| $log | |
| $ctrl | |
| $tpl | |
| $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 | |
| $search_term = "" | |
| $child_limit = 0 | |
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 | getLocalJsTreeCssPath () |
| Get local path of jsTree js. More... | |
| static | createHTMLExportDirs ($a_target_dir) |
| Create html export directories. More... | |
| static | init ($a_main_tpl=null) |
| Init JS. More... | |
| Protected Member Functions inherited from ilTreeExplorerGUI | |
| preloadChilds () | |
| Preload childs. More... | |
| matches ($node) | |
| Does a node match a search term (or is search term empty) 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... | |
| isNodeOpen ($node_id) | |
| Get all open nodes. More... | |
| getJSTreePlugins () | |
| Static Protected Attributes inherited from ilExplorerBaseGUI | |
| static | $js_tree_path = "./libs/bower/bower_components/jstree/dist/jstree.js" |
| static | $js_tree_path_css = "./libs/bower/bower_components/jstree/dist/themes/default/style.min.css" |
| static | $js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js" |
Detailed Description
SCORM editor explorer GUI class.
- 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.
Reimplemented from ilExplorerBaseGUI.
Definition at line 24 of file class.ilSCORM2004EditorExplorerGUI.php.
25 {
26 global $DIC;
27
28 $this->user = $DIC->user();
29 $this->lng = $DIC->language();
30 $this->ctrl = $DIC->ctrl();
32
33 $this->slm = $a_slm;
34
38
40
41 //$this->setTypeWhiteList(array("du", "chap", "page"));
44 }
Tree class data representation in hierachical trees using the Nested Set Model with Gaps by Joe Celco...
Definition: class.ilTree.php:25
References $DIC, $ilUser, ilTreeExplorerGUI\$tree, ilExplorerBaseGUI\setAjax(), ilExplorerBaseGUI\setSkipRootNode(), and user().
Here is the call graph for this function:
Member Function Documentation
◆ getNodeContent()
| ilSCORM2004EditorExplorerGUI::getNodeContent | ( | $a_node | ) |
Get node content.
- Parameters
-
array
- Returns
Reimplemented from ilExplorerBaseGUI.
Definition at line 52 of file class.ilSCORM2004EditorExplorerGUI.php.
53 {
55
57 return $this->slm->getTitle();
58 }
59
60 return $a_node["title"];
61 }
References ilTreeExplorerGUI\$lng, ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().
Here is the call graph for this function:
◆ getNodeHref()
| ilSCORM2004EditorExplorerGUI::getNodeHref | ( | $a_node | ) |
Get href for node.
- Parameters
-
mixed $a_node node object/array
- Returns
- string href attribute
Reimplemented from ilExplorerBaseGUI.
Definition at line 118 of file class.ilSCORM2004EditorExplorerGUI.php.
119 {
121
127 }
128
129 switch ($a_node["type"]) {
130 case "page":
135 break;
136
137 case "chap":
142 break;
143
144 case "sco":
149 break;
150
151 case "ass":
156 break;
157 }
158 }
References $_GET, ilExplorerBaseGUI\$ctrl, $ilCtrl, $ret, ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().
Here is the call graph for this function:
◆ getNodeIcon()
| ilSCORM2004EditorExplorerGUI::getNodeIcon | ( | $a_node | ) |
Get node icon.
- Parameters
-
array
- Returns
Reimplemented from ilExplorerBaseGUI.
Definition at line 69 of file class.ilSCORM2004EditorExplorerGUI.php.
70 {
73 } else {
75 }
76
77 return $icon;
78 }
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
Definition: class.ilUtil.php:79
References ilUtil\getImagePath(), ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().
Here is the call graph for this function:
◆ getNodeIconAlt()
| ilSCORM2004EditorExplorerGUI::getNodeIconAlt | ( | $a_node | ) |
Get node icon alt text.
- Parameters
-
array node array
- Returns
- string alt text
Reimplemented from ilTreeExplorerGUI.
Definition at line 86 of file class.ilSCORM2004EditorExplorerGUI.php.
87 {
89
91 return $this->slm->getTitle();
92 }
93
94 return parent::getNodeIconAlt($a_node);
95 }
References ilTreeExplorerGUI\$lng, ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().
Here is the call graph for this function:
◆ isNodeHighlighted()
| ilSCORM2004EditorExplorerGUI::isNodeHighlighted | ( | $a_node | ) |
Is node highlighted?
- Parameters
-
mixed $a_node node object/array
- Returns
- boolean node visible true/false
Reimplemented from ilExplorerBaseGUI.
Definition at line 103 of file class.ilSCORM2004EditorExplorerGUI.php.
104 {
107 return true;
108 }
109 return false;
110 }
References $_GET, ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().
Here is the call graph for this function:
Field Documentation
◆ $user
|
protected |
Definition at line 19 of file class.ilSCORM2004EditorExplorerGUI.php.
The documentation for this class was generated from the following file:
- Modules/Scorm2004/classes/class.ilSCORM2004EditorExplorerGUI.php
