ILIAS  release_8 Revision v8.24
ilHelpGUI Class Reference

Help GUI class. More...

+ Inheritance diagram for ilHelpGUI:
+ Collaboration diagram for ilHelpGUI:

Public Member Functions

 __construct ()
 
 setDefaultScreenId (string $a_part, string $a_id)
 
 setScreenId (string $a_id)
 
 setSubScreenId (string $a_id)
 
 setScreenIdComponent (string $a_comp)
 
 getScreenId ()
 
 addHelpSection (string $a_help_id, int $a_level=1)
 
 hasSections ()
 
 getHelpSections ()
 
 setCtrlPar ()
 
 executeCommand ()
 
 showHelp ()
 
 showPage ()
 
 resetCurrentPage ()
 
 getTabTooltipText (string $a_tab_id)
 
 initHelp (ilGlobalTemplateInterface $a_tpl, string $ajax_url)
 
 isHelpPageActive ()
 
 deactivateTooltips ()
 
 activateTooltips ()
 
 getLinkXML (array $a_int_links)
 
 getLinkTargetsXML ()
 Get XMl for Link Targets. More...
 
 search ()
 

Data Fields

const ID_PART_SCREEN = "screen"
 
const ID_PART_SUB_SCREEN = "sub_screen"
 
const ID_PART_COMPONENT = "component"
 
array $help_sections = array()
 
array $def_screen_id = array()
 
array $screen_id = array()
 

Protected Member Functions

 replaceMenuItemTags (string $content)
 
 replaceItemTag (string $content, \ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem $item)
 

Protected Attributes

StandardGUIRequest $help_request
 
ilCtrl $ctrl
 
ilSetting $settings
 
ilLanguage $lng
 
ilObjUser $user
 
string $screen_id_component = ''
 
ILIAS DI UIServices $ui
 
array $raw_menu_items = null
 

Detailed Description

Help GUI class.

Author
Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilHelpGUI: ilLMPageGUI

Definition at line 27 of file class.ilHelpGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilHelpGUI::__construct ( )

Definition at line 45 of file class.ilHelpGUI.php.

46 {
47 global $DIC;
48
49 $this->settings = $DIC->settings();
50 $this->lng = $DIC->language();
51 $this->user = $DIC->user();
52 $ilCtrl = $DIC->ctrl();
53
54 $this->ctrl = $ilCtrl;
55 $this->ui = $DIC->ui();
56 $this->help_request = new StandardGUIRequest(
57 $DIC->http(),
58 $DIC->refinery()
59 );
60 }
global $DIC
Definition: feed.php:28

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

+ Here is the call graph for this function:

Member Function Documentation

◆ activateTooltips()

ilHelpGUI::activateTooltips ( )

Definition at line 342 of file class.ilHelpGUI.php.

342 : void
343 {
345
346 $ilUser->writePref("hide_help_tt", "0");
347 }
ilObjUser $user
$ilUser
Definition: imgupload.php:34

References $ilUser.

◆ addHelpSection()

ilHelpGUI::addHelpSection ( string  $a_help_id,
int  $a_level = 1 
)

Definition at line 109 of file class.ilHelpGUI.php.

112 : void {
113 $this->help_sections[] = array("help_id" => $a_help_id, $a_level);
114 }

◆ deactivateTooltips()

ilHelpGUI::deactivateTooltips ( )

Definition at line 335 of file class.ilHelpGUI.php.

335 : void
336 {
338
339 $ilUser->writePref("hide_help_tt", "1");
340 }

References $ilUser.

◆ executeCommand()

ilHelpGUI::executeCommand ( )

Definition at line 136 of file class.ilHelpGUI.php.

136 : string
137 {
138 $cmd = $this->ctrl->getCmd("showHelp") ?: "showHelp";
139 return (string) $this->$cmd();
140 }

References ILIAS\Repository\ctrl().

+ Here is the call graph for this function:

◆ getHelpSections()

ilHelpGUI::getHelpSections ( )

Definition at line 121 of file class.ilHelpGUI.php.

121 : array
122 {
124 $this->getScreenId(),
125 $this->help_request->getRefId()
126 );
127 }
static getHelpSectionsForId(string $a_screen_id, int $a_ref_id)

References ilHelpMapping\getHelpSectionsForId().

+ Here is the call graph for this function:

◆ getLinkTargetsXML()

ilHelpGUI::getLinkTargetsXML ( )

Get XMl for Link Targets.

Definition at line 393 of file class.ilHelpGUI.php.

393 : string
394 {
395 $link_info = "<LinkTargets>";
396 $link_info .= "<LinkTarget TargetFrame=\"None\" LinkTarget=\"\" OnClick=\"return il.Help.openLink(event);\" />";
397 $link_info .= "</LinkTargets>";
398 return $link_info;
399 }

◆ getLinkXML()

ilHelpGUI::getLinkXML ( array  $a_int_links)

Definition at line 349 of file class.ilHelpGUI.php.

351 : string {
352 $href = "";
353 $link_info = "<IntLinkInfos>";
354 foreach ($a_int_links as $int_link) {
355 $target = $int_link["Target"];
356 if (strpos($target, "il__") === 0) {
357 $target_arr = explode("_", $target);
358 $target_id = $target_arr[count($target_arr) - 1];
359 $type = $int_link["Type"];
360 $targetframe = "None";
361
362 // anchor
363 $anc = $anc_add = "";
364 if (($int_link["Anchor"] ?? "") != "") {
365 $anc = $int_link["Anchor"];
366 $anc_add = "_" . rawurlencode($int_link["Anchor"]);
367 }
368
369 switch ($type) {
370 case "PageObject":
371 case "StructureObject":
372 if ($type === "PageObject") {
373 $href = "#pg_" . $target_id;
374 } else {
375 $href = "#";
376 }
377 break;
378
379 }
380
381 $link_info .= "<IntLinkInfo Target=\"$target\" Type=\"$type\" " .
382 "TargetFrame=\"$targetframe\" LinkHref=\"$href\" LinkTarget=\"\" Anchor=\"\"/>";
383 }
384 }
385 $link_info .= "</IntLinkInfos>";
386
387 return $link_info;
388 }
$target_id
Definition: goto.php:52
$target_arr
Definition: goto.php:50
$type

References $target_arr, $target_id, and $type.

◆ getScreenId()

ilHelpGUI::getScreenId ( )

Definition at line 84 of file class.ilHelpGUI.php.

84 : string
85 {
86 $comp = ($this->screen_id_component != "")
87 ? $this->screen_id_component
88 : ($this->def_screen_id[self::ID_PART_COMPONENT] ?? '');
89
90 if ($comp == "") {
91 return "";
92 }
93
94 $scr_id = (isset($this->screen_id[self::ID_PART_SCREEN]) && $this->screen_id[self::ID_PART_SCREEN] != "")
95 ? $this->screen_id[self::ID_PART_SCREEN]
96 : ($this->def_screen_id[self::ID_PART_SCREEN] ?? '');
97
98 $sub_scr_id = (isset($this->screen_id[self::ID_PART_SUB_SCREEN]) && $this->screen_id[self::ID_PART_SUB_SCREEN] != "")
99 ? $this->screen_id[self::ID_PART_SUB_SCREEN]
100 : ($this->def_screen_id[self::ID_PART_SUB_SCREEN] ?? '');
101
102 $screen_id = $comp . "/" .
103 $scr_id . "/" .
104 $sub_scr_id;
105
106 return $screen_id;
107 }
array $screen_id
const ID_PART_SCREEN
const ID_PART_SUB_SCREEN

◆ getTabTooltipText()

ilHelpGUI::getTabTooltipText ( string  $a_tab_id)

Definition at line 282 of file class.ilHelpGUI.php.

282 : string
283 {
284 if ($this->screen_id_component != "") {
285 return ilHelp::getTooltipPresentationText($this->screen_id_component . "_" . $a_tab_id);
286 }
287 return "";
288 }
static getTooltipPresentationText(string $a_tt_id)

References ilHelp\getTooltipPresentationText().

+ Here is the call graph for this function:

◆ hasSections()

ilHelpGUI::hasSections ( )

Definition at line 116 of file class.ilHelpGUI.php.

116 : bool
117 {
119 }
static hasScreenIdSections(string $a_screen_id)
Has given screen Id any sections? Note: We removed the "ref_id" parameter here, since this method sho...

References ilHelpMapping\hasScreenIdSections().

+ Here is the call graph for this function:

◆ initHelp()

ilHelpGUI::initHelp ( ilGlobalTemplateInterface  $a_tpl,
string  $ajax_url 
)

Definition at line 290 of file class.ilHelpGUI.php.

293 : void {
294 global $DIC;
295
296 $ilUser = $DIC->user();
297 $ilSetting = $DIC->settings();
298 $ctrl = $DIC->ctrl();
299
301 $a_tpl->addJavaScript("./Services/Help/js/ilHelp.js");
302 $a_tpl->addJavaScript("./Services/Accordion/js/accordion.js");
304 $a_tpl->addJavaScript("./Services/COPage/js/ilCOPagePres.js");
305
306 $this->setCtrlPar();
307 $a_tpl->addOnLoadCode(
308 "il.Help.setAjaxUrl('" .
309 $ctrl->getLinkTargetByClass("ilhelpgui", "", "", true)
310 . "');"
311 );
312
313
314 $module_id = (int) $ilSetting->get("help_module");
315
316 if (((int) OH_REF_ID > 0 || $module_id > 0) && $ilUser->getLanguage() === "de") {
317 if (ilSession::get("help_pg") > 0) {
318 $a_tpl->addOnLoadCode("il.Help.showCurrentPage(" . ilSession::get("help_pg") . ");", 3);
319 } else {
320 $a_tpl->addOnLoadCode("il.Help.listHelp(null);", 3);
321 }
322
323
324 if ($ilUser->getPref("hide_help_tt")) {
325 $a_tpl->addOnLoadCode("if (il && il.Help) {il.Help.switchTooltips();}", 3);
326 }
327 }
328 }
getLinkTargetByClass( $a_class, string $a_cmd=null, string $a_anchor=null, bool $is_async=false, bool $has_xml_style=false)
@inheritDoc
static get(string $a_var)
static initConnection(?ilGlobalTemplateInterface $a_main_tpl=null)
Init YUI Connection module.
static initMaphilight()
Inits and add maphilight to the general template.
addJavaScript(string $a_js_file, bool $a_add_version_parameter=true, int $a_batch=2)
Add a javascript file that should be included in the header.
addOnLoadCode(string $a_code, int $a_batch=2)
Add on load code.
global $ilSetting
Definition: privfeed.php:17

◆ isHelpPageActive()

ilHelpGUI::isHelpPageActive ( )

Definition at line 330 of file class.ilHelpGUI.php.

330 : bool
331 {
332 return (ilSession::get("help_pg") > 0);
333 }

References ilSession\get().

+ Here is the call graph for this function:

◆ replaceItemTag()

ilHelpGUI::replaceItemTag ( string  $content,
\ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem  $item 
)
protected

Definition at line 477 of file class.ilHelpGUI.php.

480 : string {
481 global $DIC;
482 $mmc = $DIC->globalScreen()->collector()->mainmenu();
483
484 $id = $item->getProviderIdentification()->getInternalIdentifier();
485 $ws = "[ \t\r\f\v\n]*";
486
487 // menu item path
488 while (preg_match("~\[(menu" . $ws . "path$ws=$ws(\"$id\")$ws)/\]~i", $content, $found)) {
489 $path = "";
490 if ($item instanceof \ILIAS\GlobalScreen\Scope\MainMenu\Factory\isChild) {
491 $parent = $mmc->getItemInformation()->getParent($item);
492 if ($parent !== null) {
493 $parent = $mmc->getSingleItemFromRaw($parent);
494 $path = $this->getTitleForItem($parent) . " > ";
495 }
496 }
497 $path .= $this->getTitleForItem($item);
498 $content = preg_replace(
499 '~\[' . $found[1] . '/\]~i',
500 "<strong>" . $path . "</strong>",
501 $content
502 );
503 }
504 // menu item
505 while (preg_match("~\[(menu" . $ws . "item$ws=$ws(\"$id\")$ws)/\]~i", $content, $found)) {
506 $content = preg_replace(
507 '~\[' . $found[1] . '/\]~i',
508 "<strong>" . $this->getTitleForItem($item) . "</strong>",
509 $content
510 );
511 }
512 return $content;
513 }
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23
$path
Definition: ltiservices.php:32
Class ChatMainBarProvider \MainMenu\Provider.

References $path.

◆ replaceMenuItemTags()

ilHelpGUI::replaceMenuItemTags ( string  $content)
protected

Definition at line 455 of file class.ilHelpGUI.php.

457 : string {
458 global $DIC;
459
460 $mmc = $DIC->globalScreen()->collector()->mainmenu();
461 if ($this->raw_menu_items == null) {
462 $mmc->collectOnce();
463 $this->raw_menu_items = iterator_to_array($mmc->getRawItems());
464 }
465
466 foreach ($this->raw_menu_items as $item) {
467 if ($item instanceof Item\LinkList) {
468 foreach ($item->getLinks() as $link) {
469 $content = $this->replaceItemTag($content, $link);
470 }
471 }
472 $content = $this->replaceItemTag($content, $item);
473 }
474 return $content;
475 }
replaceItemTag(string $content, \ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem $item)

◆ resetCurrentPage()

ilHelpGUI::resetCurrentPage ( )

Definition at line 277 of file class.ilHelpGUI.php.

277 : void
278 {
279 ilSession::clear("help_pg");
280 }
static clear(string $a_var)

References ilSession\clear().

+ Here is the call graph for this function:

◆ search()

ilHelpGUI::search ( )

Definition at line 401 of file class.ilHelpGUI.php.

401 : void
402 {
404 $ui = $this->ui;
405
406 $term = $this->help_request->getTerm();
407
408 if ($term === "") {
409 $term = ilSession::get("help_search_term");
410 }
411
412 $this->resetCurrentPage();
413
414 $h_tpl = new ilTemplate("tpl.help.html", true, true, "Services/Help");
415
416 $back_button = $ui->factory()->button()->bulky($ui->factory()->symbol()->glyph()->back(), $lng->txt("back"), "#")->withOnLoadCode(function ($id) {
417 return
418 "$(\"#$id\").click(function() { return il.Help.listHelp(event, true); return false;});";
419 });
420 $h_tpl->setVariable("BACKBUTTON", $ui->renderer()->renderAsync($back_button));
421
422 $h_tpl->setVariable("HEAD", $lng->txt("help") . " - " .
423 $lng->txt("search_result"));
424
425 $h_tpl->setCurrentBlock("search");
426 $h_tpl->setVariable("GL_SEARCH", ilGlyphGUI::get(ilGlyphGUI::SEARCH));
427 $h_tpl->setVariable("HELP_SEARCH_LABEL", $this->lng->txt("help_search_label"));
428 $h_tpl->setVariable("VAL_SEARCH", ilLegacyFormElementsUtil::prepareFormOutput($term));
429 $h_tpl->parseCurrentBlock();
430
431 $h_tpl->setVariable("CLOSE_IMG", ilGlyphGUI::get(ilGlyphGUI::CLOSE));
432
433 $lm_id = ilHelp::getHelpLMId();
434 $s = new ilRepositoryObjectDetailSearch($lm_id);
435 $s->setQueryString($term);
436 $result = $s->performSearch();
437
438 $grp_list = new ilGroupedListGUI();
439 foreach ($result->getResults() as $r) {
440 $grp_list->addEntry(
441 ilLMObject::_lookupTitle($r["item_id"]),
442 "#",
443 "",
444 "return il.Help.showPage(" . $r["item_id"] . ");"
445 );
446 }
447 $h_tpl->setVariable("CONTENT", $grp_list->getHTML());
448
449 ilSession::set("help_search_term", $term);
450
451 echo $h_tpl->get();
452 exit;
453 }
static get(string $a_glyph, string $a_text="")
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
ilLanguage $lng
ILIAS DI UIServices $ui
static getHelpLMId()
Get help lm id.
static _lookupTitle(int $a_obj_id)
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
static prepareFormOutput($a_str, bool $a_strip=false)
static set(string $a_var, $a_val)
Set a value.
special template class to simplify handling of ITX/PEAR
exit
Definition: login.php:28

References $id, $lng, ilLMObject\_lookupTitle(), ilGlyphGUI\CLOSE, exit, ilGlyphGUI\get(), ilSession\get(), ilHelp\getHelpLMId(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), ilGlyphGUI\SEARCH, and ilSession\set().

+ Here is the call graph for this function:

◆ setCtrlPar()

ilHelpGUI::setCtrlPar ( )

Definition at line 129 of file class.ilHelpGUI.php.

129 : void
130 {
131 $ilCtrl = $this->ctrl;
132 $refId = (string) $this->help_request->getRefId();
133 $ilCtrl->setParameterByClass("ilhelpgui", "help_screen_id", $this->getScreenId() . "." . $refId);
134 }
$refId
Definition: xapitoken.php:58

References $refId.

◆ setDefaultScreenId()

ilHelpGUI::setDefaultScreenId ( string  $a_part,
string  $a_id 
)

Definition at line 62 of file class.ilHelpGUI.php.

65 : void {
66 $this->def_screen_id[$a_part] = $a_id;
67 }

◆ setScreenId()

ilHelpGUI::setScreenId ( string  $a_id)

Definition at line 69 of file class.ilHelpGUI.php.

69 : void
70 {
71 $this->screen_id[self::ID_PART_SCREEN] = $a_id;
72 }

◆ setScreenIdComponent()

◆ setSubScreenId()

ilHelpGUI::setSubScreenId ( string  $a_id)

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

74 : void
75 {
76 $this->screen_id[self::ID_PART_SUB_SCREEN] = $a_id;
77 }

◆ showHelp()

ilHelpGUI::showHelp ( )

Definition at line 142 of file class.ilHelpGUI.php.

142 : void
143 {
145 $lng->loadLanguageModule("help");
146 $ui = $this->ui;
147
148 if ($this->help_request->getHelpScreenId() !== "") {
149 ilSession::set("help_screen_id", $this->help_request->getHelpScreenId());
150 $help_screen_id = $this->help_request->getHelpScreenId();
151 } else {
152 $help_screen_id = ilSession::get("help_screen_id");
153 }
154
155 ilSession::set("help_search_term", "");
156
157 $this->resetCurrentPage();
158
159 $id_arr = explode(".", $help_screen_id);
160 $help_arr = ilHelpMapping::getHelpSectionsForId($id_arr[0], $id_arr[1]);
161 $oh_lm_id = ilHelp::getHelpLMId();
162
163 if ($oh_lm_id > 0) {
164 $acc = new ilAccordionGUI();
165 $acc->setId("oh_acc");
166 $acc->setUseSessionStorage(true);
167 $acc->setBehaviour(ilAccordionGUI::FIRST_OPEN);
168
169 foreach ($help_arr as $h_id) {
170 $st_id = $h_id;
171 if (!ilLMObject::_exists($st_id)) {
172 continue;
173 }
174
175 $pages = ilLMObject::getPagesOfChapter($oh_lm_id, $st_id);
176 $grp_list = new ilGroupedListGUI();
177 foreach ($pages as $pg) {
178 $grp_list->addEntry(
179 $this->replaceMenuItemTags(ilLMObject::_lookupTitle($pg["child"])),
180 "#",
181 "",
182 "return il.Help.showPage(" . $pg["child"] . ");"
183 );
184 }
185
186 $acc->addItem(ilLMObject::_lookupTitle($st_id), $grp_list->getHTML());
187 }
188
189 $h_tpl = new ilTemplate("tpl.help.html", true, true, "Services/Help");
190 $h_tpl->setVariable("HEAD", $lng->txt("help"));
191
192 $h_tpl->setCurrentBlock("search");
193 $h_tpl->setVariable("GL_SEARCH", ilGlyphGUI::get(ilGlyphGUI::SEARCH));
194 $h_tpl->setVariable("HELP_SEARCH_LABEL", $this->lng->txt("help_search_label"));
195 $h_tpl->parseCurrentBlock();
196
197 if (count($help_arr) > 0) {
198 $h_tpl->setVariable("CONTENT", $acc->getHTML(true));
199 } else {
200 $mess = $ui->factory()->messageBox()->info($lng->txt("help_no_content"));
201 $h_tpl->setVariable("CONTENT", $ui->renderer()->render([$mess]));
202 }
203
204 $h_tpl->setVariable("CLOSE_IMG", ilGlyphGUI::get(ilGlyphGUI::CLOSE));
205 echo $h_tpl->get();
206 }
207 exit;
208 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
replaceMenuItemTags(string $content)
static getPagesOfChapter(int $a_lm_id, int $a_chap_id)
Get pages of chapter.
static _exists(int $a_id)
checks wether a lm content object with specified id exists or not
loadLanguageModule(string $a_module)
Load language module.

References $lng, ilLMObject\_exists(), ilLMObject\_lookupTitle(), ilGlyphGUI\CLOSE, exit, ilAccordionGUI\FIRST_OPEN, ilGlyphGUI\get(), ilSession\get(), ilHelp\getHelpLMId(), ilHelpMapping\getHelpSectionsForId(), ilLMObject\getPagesOfChapter(), ILIAS\Repository\lng(), ilGlyphGUI\SEARCH, and ilSession\set().

+ Here is the call graph for this function:

◆ showPage()

ilHelpGUI::showPage ( )

Definition at line 210 of file class.ilHelpGUI.php.

210 : void
211 {
213 $ui = $this->ui;
214
215 $page_id = $this->help_request->getHelpPage();
216
217 $h_tpl = new ilTemplate("tpl.help.html", true, true, "Services/Help");
218
219 if (($t = ilSession::get("help_search_term")) != "") {
220 $back_button = $ui->factory()->button()->bulky($ui->factory()->symbol()->glyph()->back(), $lng->txt("back"), "#")->withOnLoadCode(function ($id) use ($t) {
221 return
222 "$(\"#$id\").click(function() { return il.Help.search('" . ilLegacyFormElementsUtil::prepareFormOutput(
223 $t
224 ) . "'); return false;});";
225 });
226 } else {
227 $back_button = $ui->factory()->button()->bulky($ui->factory()->symbol()->glyph()->back(), $lng->txt("back"), "#")->withOnLoadCode(function ($id) {
228 return
229 "$(\"#$id\").click(function() { return il.Help.listHelp(event, true); return false;});";
230 });
231 }
232 $h_tpl->setVariable("BACKBUTTON", $ui->renderer()->renderAsync($back_button));
233
234 $h_tpl->setVariable(
235 "HEAD",
237 );
238
239 if (!ilPageUtil::_existsAndNotEmpty("lm", $page_id)) {
240 exit;
241 }
242
243 // get page object
244 $page_gui = new ilLMPageGUI($page_id);
245 $cfg = $page_gui->getPageConfig();
246 $page_gui->setPresentationTitle("");
247 $page_gui->setTemplateOutput(false);
248 $page_gui->setHeader("");
249 $page_gui->setRawPageContent(true);
250 $cfg->setEnablePCType("Map", false);
251 $cfg->setEnablePCType("Tabs", false);
252 $cfg->setEnablePCType("FileList", false);
253
254 $page_gui->getPageObject()->buildDom();
255 $int_links = $page_gui->getPageObject()->getInternalLinks();
256 $link_xml = $this->getLinkXML($int_links);
257 $link_xml .= $this->getLinkTargetsXML();
258 //echo htmlentities($link_xml);
259 $page_gui->setLinkXml($link_xml);
260
261 $ret = $this->replaceMenuItemTags($page_gui->showPage());
262
263 $h_tpl->setVariable("CONTENT", $ret);
264 $h_tpl->setVariable("CLOSE_IMG", ilGlyphGUI::get(ilGlyphGUI::CLOSE));
265
266 ilSession::set("help_pg", $page_id);
267
268 $page = $h_tpl->get();
269
270 // replace style classes
271 //$page = str_replace("ilc_text_inline_Strong", "ilHelpStrong", $page);
272
273 echo $page;
274 exit;
275 }
getLinkXML(array $a_int_links)
getLinkTargetsXML()
Get XMl for Link Targets.
Extension of ilPageObjectGUI for learning modules.
static _existsAndNotEmpty(string $a_parent_type, int $a_id, string $a_lang="-")
checks whether page exists and is not empty (may return true on some empty pages)

References $id, $lng, ilPageUtil\_existsAndNotEmpty(), ilLMObject\_lookupTitle(), ilGlyphGUI\CLOSE, exit, ilGlyphGUI\get(), ilSession\get(), ilLegacyFormElementsUtil\prepareFormOutput(), ilSession\set(), and ILIAS\UI\Implementation\Component\withOnLoadCode().

+ Here is the call graph for this function:

Field Documentation

◆ $ctrl

ilCtrl ilHelpGUI::$ctrl
protected

Definition at line 34 of file class.ilHelpGUI.php.

◆ $def_screen_id

array ilHelpGUI::$def_screen_id = array()

Definition at line 39 of file class.ilHelpGUI.php.

◆ $help_request

StandardGUIRequest ilHelpGUI::$help_request
protected

Definition at line 32 of file class.ilHelpGUI.php.

◆ $help_sections

array ilHelpGUI::$help_sections = array()

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

◆ $lng

ilLanguage ilHelpGUI::$lng
protected

Definition at line 36 of file class.ilHelpGUI.php.

◆ $raw_menu_items

array ilHelpGUI::$raw_menu_items = null
protected

Definition at line 43 of file class.ilHelpGUI.php.

◆ $screen_id

array ilHelpGUI::$screen_id = array()

Definition at line 40 of file class.ilHelpGUI.php.

◆ $screen_id_component

string ilHelpGUI::$screen_id_component = ''
protected

Definition at line 41 of file class.ilHelpGUI.php.

◆ $settings

ilSetting ilHelpGUI::$settings
protected

Definition at line 35 of file class.ilHelpGUI.php.

◆ $ui

ILIAS DI UIServices ilHelpGUI::$ui
protected

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

◆ $user

ilObjUser ilHelpGUI::$user
protected

Definition at line 37 of file class.ilHelpGUI.php.

◆ ID_PART_COMPONENT

const ilHelpGUI::ID_PART_COMPONENT = "component"

Definition at line 31 of file class.ilHelpGUI.php.

◆ ID_PART_SCREEN

const ilHelpGUI::ID_PART_SCREEN = "screen"

◆ ID_PART_SUB_SCREEN

const ilHelpGUI::ID_PART_SUB_SCREEN = "sub_screen"

Definition at line 30 of file class.ilHelpGUI.php.


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