ilLMEditorExplorerGUI Class Reference
LM editor explorer GUI class. More...
Inheritance diagram for ilLMEditorExplorerGUI:
Collaboration diagram for ilLMEditorExplorerGUI:
Public Member Functions | |
| __construct ($a_parent_obj, $a_parent_cmd, ilObjContentObject $a_lm, $a_id="") | |
| Constructor. More... | |
| 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 ($new=false) | |
| Get HTML. More... | |
| getChildren ($node, $environment=null) | |
Get a list of records (that list can also be empty).Each record will be relayed to $this->build to retrieve a Node. Also, each record will be asked for Sub-Nodes using this function.
| |
| build (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record, $environment=null) | |
| getTreeLabel () | |
| getTreeComponent () | |
| Get Tree UI. More... | |
| toggleExplorerNodeState () | |
| Should be called by an ilCtrl-enabled command class if a tree node toggle action should be processed. 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 ($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... | |
| Public Member Functions inherited from ILIAS\UI\Component\Tree\TreeRecursion | |
| getChildren ( $record, $environment=null) | |
| Get a list of records (that list can also be empty). More... | |
| build (Node\Factory $factory, $record, $environment=null) | |
| Build and return a Node. 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 | 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 ilLMExplorerGUI | |
| checkLPIcon ($a_id) | |
| Check learning progress icon. 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 () | |
| createNode (\ILIAS\UI\Component\Tree\Node\Factory $factory, $record) | |
| Creates at tree node, can be overwritten in derivatives if another node type should be used. More... | |
| getNodeStateToggleCmdClasses ($record) | |
| Should return an array of ilCtrl-enabled command classes which should be used to build the URL for the expand/collapse actions applied on a tree node. More... | |
| render () | |
| Render tree. More... | |
| 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 () | |
| Protected Attributes inherited from ilLMExplorerGUI | |
| $user | |
| $lp_cache | |
| $cnt_lmobj | |
| Protected Attributes inherited from ilTreeExplorerGUI | |
| $lng | |
| $httpRequest | |
| $tree = null | |
| $tree_label = "" | |
| $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() | |
| $ui | |
| 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 = "" | |
| $open_nodes = [] | |
| $store | |
| $parent_obj | |
| $child_limit = 0 | |
| $parent_cmd = '' | |
| Static Protected Attributes inherited from ilExplorerBaseGUI | |
| static | $js_tree_path = "./node_modules/jstree/dist/jstree.js" |
| static | $js_tree_path_css = "./node_modules/jstree/dist/themes/default/style.min.css" |
| static | $js_expl_path = "./Services/UIComponent/Explorer2/js/Explorer2.js" |
Detailed Description
LM editor explorer GUI class.
- Version
- $Id$
Definition at line 13 of file class.ilLMEditorExplorerGUI.php.
Constructor & Destructor Documentation
◆ __construct()
| ilLMEditorExplorerGUI::__construct | ( | $a_parent_obj, | |
| $a_parent_cmd, | |||
| ilObjContentObject | $a_lm, | ||
$a_id = "" |
|||
| ) |
Constructor.
Reimplemented from ilLMExplorerGUI.
Definition at line 19 of file class.ilLMEditorExplorerGUI.php.
20 {
21 global $DIC;
22 parent::__construct($a_parent_obj, $a_parent_cmd, $a_lm, $a_id);
23
24 $this->lng = $DIC->language();
25 $this->ctrl = $DIC->ctrl();
26 }
References $DIC, and ILIAS\GlobalScreen\Provider\__construct().
Here is the call graph for this function:
Member Function Documentation
◆ getNodeHref()
| ilLMEditorExplorerGUI::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.ilLMEditorExplorerGUI.php.
119 {
120 $ilCtrl = $this->ctrl;
121
122 switch ($a_node["type"]) {
123 case "du":
124 $ilCtrl->setParameterByClass("ilobjlearningmodulegui", "obj_id", null);
128 break;
129
130 case "pg":
131 $ilCtrl->setParameterByClass("illmpageobjectgui", "obj_id", $a_node["child"]);
132 $ret = $ilCtrl->getLinkTargetByClass(array("ilobjlearningmodulegui", "illmpageobjectgui"), "edit");
135 break;
136
137 case "st":
138 $ilCtrl->setParameterByClass("ilstructureobjectgui", "obj_id", $a_node["child"]);
139 $ret = $ilCtrl->getLinkTargetByClass(array("ilobjlearningmodulegui", "ilstructureobjectgui"), "view");
142 break;
143 }
144 }
References $_GET, ilExplorerBaseGUI\$ctrl, and $ret.
◆ getNodeIcon()
| ilLMEditorExplorerGUI::getNodeIcon | ( | $a_node | ) |
Get node icon.
- Parameters
-
array $a_node node array
- Returns
- string icon path
Reimplemented from ilExplorerBaseGUI.
Definition at line 35 of file class.ilLMEditorExplorerGUI.php.
36 {
39 } else {
40 $a_name = "icon_" . $a_node["type"] . ".svg";
41 if ($a_node["type"] == "pg") {
43 $active = ilLMPage::_lookupActive(
44 $a_node["child"],
45 $this->lm->getType(),
47 );
48
49 // is page scheduled?
52 ? "_sc"
53 : "";
54
55 $a_name = "icon_pg" . $img_sc . ".svg";
56
57 if (!$active) {
58 $a_name = "icon_pg_d" . $img_sc . ".svg";
59 } else {
60 $contains_dis = ilLMPage::_lookupContainsDeactivatedElements(
61 $a_node["child"],
62 $this->lm->getType()
63 );
64 if ($contains_dis) {
65 $a_name = "icon_pg_del" . $img_sc . ".svg";
66 }
67 }
68 }
69 $icon = ilUtil::getImagePath($a_name);
70 }
71
72 return $icon;
73 }
static _lookupActive($a_id, $a_parent_type, $a_check_scheduled_activation=false, $a_lang="-")
lookup activation status
Definition: class.ilPageObject.php:589
static _lookupContainsDeactivatedElements($a_id, $a_parent_type, $a_lang="-")
lookup whether page contains deactivated elements
Definition: class.ilPageObject.php:4199
static _isScheduledActivation($a_id, $a_parent_type, $a_lang="-")
Check whether page is activated by time schedule.
Definition: class.ilPageObject.php:627
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
Definition: class.ilUtil.php:96
References $lm_set, ilPageObject\_isScheduledActivation(), ilPageObject\_lookupActive(), ilPageObject\_lookupContainsDeactivatedElements(), ilUtil\getImagePath(), ilTreeExplorerGUI\getNodeId(), and ilTreeExplorerGUI\getRootNode().
Here is the call graph for this function:
◆ getNodeIconAlt()
| ilLMEditorExplorerGUI::getNodeIconAlt | ( | $a_node | ) |
Get node icon alt text.
- Parameters
-
array $a_node node array
- Returns
- string alt text
Reimplemented from ilTreeExplorerGUI.
Definition at line 81 of file class.ilLMEditorExplorerGUI.php.
82 {
84
85 if ($a_node["type"] == "du") {
86 $a_node["type"] = "lm";
87 }
88
89 if ($a_node["type"] == "pg") {
91 $active = ilLMPage::_lookupActive(
92 $a_node["child"],
93 $this->lm->getType(),
95 );
96
97 if (!$active) {
99 } else {
100 $contains_dis = ilLMPage::_lookupContainsDeactivatedElements(
101 $a_node["child"],
102 $this->lm->getType()
103 );
104 if ($contains_dis) {
106 }
107 }
108 }
109 return parent::getNodeIconAlt($a_node);
110 }
References $lm_set, ilTreeExplorerGUI\$lng, ilPageObject\_lookupActive(), and ilPageObject\_lookupContainsDeactivatedElements().
Here is the call graph for this function:
The documentation for this class was generated from the following file:
- Modules/LearningModule/classes/class.ilLMEditorExplorerGUI.php
