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 ()

	showTooltips ()

	isHelpActive ()

	areTooltipsActive ()

	savePersonalSettingFromLegacyForm (ilPropertyFormGUI $form)

	addPersonalSettingToLegacyForm (ilPropertyFormGUI $form)

	if (is_null(self::$internal_service))
	temporary move it here until DIC holds help service instead of ilHelpGUI More...

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
	initUI ()

	symbol ()

	replaceMenuItemTags (string $content)

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

Protected Attributes
ILIAS Repository InternalGUIService	$gui

ILIAS Help Presentation PresentationManager	$presentation

ILIAS Help Map MapManager	$help_map

StandardGUIRequest	$help_request

ilCtrl	$ctrl

ilSetting	$settings

ilLanguage	$lng

ilObjUser	$user

string	$screen_id_component = ''

ILIAS DI UIServices	$ui

array	$raw_menu_items = null

Static Protected Attributes
static ILIAS Help InternalService	$internal_service = null

Detailed Description

Help GUI class.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilHelpGUI::__construct ( )

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

References ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

     {
         $domain = $this->internal()->domain();
 
         $this->settings = $domain->settings();
         $this->lng = $domain->lng();
         $this->user = $domain->user();
 
         $this->help_map = $domain->map();
         $this->presentation = $domain->presentation();
     }

Here is the call graph for this function:

Member Function Documentation

◆ activateTooltips()

ilHelpGUI::activateTooltips ( )

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

References $user, and ilObjUser\writePref().

                                       : void
     {
         $ilUser = $this->user;
 
         $ilUser->writePref("hide_help_tt", "0");
     }

Here is the call graph for this function:

◆ addHelpSection()

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

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

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

◆ addPersonalSettingToLegacyForm()

ilHelpGUI::addPersonalSettingToLegacyForm ( ilPropertyFormGUI $form )

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

References $DIC, ilPropertyFormGUI\addItem(), areTooltipsActive(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

                                                                            : void
     {
         if ($this->areTooltipsActive()) {
             $this->lng->loadLanguageModule('help');
             $cb = new ilCheckboxInputGUI($this->lng->txt('help_toggle_tooltips'), 'help_tooltips');
             $cb->setChecked(!($this->user->prefs['hide_help_tt'] ?? false));
             $cb->setInfo($this->lng->txt('help_toggle_tooltips_info'));
             $form->addItem($cb);
         }
     }

Here is the call graph for this function:

◆ areTooltipsActive()

ilHelpGUI::areTooltipsActive ( )

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

Referenced by addPersonalSettingToLegacyForm(), and savePersonalSettingFromLegacyForm().

                                        : bool
     {
         return $this->internal()->domain()->module()->areTooltipsActive();
     }

Here is the caller graph for this function:

◆ deactivateTooltips()

ilHelpGUI::deactivateTooltips ( )

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

References $user, and ilObjUser\writePref().

                                         : void
     {
         $ilUser = $this->user;
 
         $ilUser->writePref("hide_help_tt", "1");
     }

Here is the call graph for this function:

◆ executeCommand()

ilHelpGUI::executeCommand ( )

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

References ILIAS\Repository\ctrl(), and initUI().

                                     : string
     {
         $this->initUI();
         $cmd = $this->ctrl->getCmd("showHelp") ?: "showHelp";
         return (string) $this->$cmd();
     }

Here is the call graph for this function:

◆ getHelpSections()

ilHelpGUI::getHelpSections ( )

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

References getScreenId().

                                      : array
     {
         return $this->help_map->getHelpSectionsForId(
             $this->getScreenId(),
             $this->help_request->getRefId()
         );
     }

Here is the call graph for this function:

◆ getLinkTargetsXML()

ilHelpGUI::getLinkTargetsXML ( )

Get XMl for Link Targets.

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

Referenced by showPage().

                                        : string
     {
         $link_info = "<LinkTargets>";
         $link_info .= "<LinkTarget TargetFrame=\"None\" LinkTarget=\"\" OnClick=\"return il.Help.openLink(event);\" />";
         $link_info .= "</LinkTargets>";
         return $link_info;
     }

Here is the caller graph for this function:

◆ getLinkXML()

ilHelpGUI::getLinkXML ( array $a_int_links )

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

Referenced by showPage().

      : string {
         $href = "";
         $link_info = "<IntLinkInfos>";
         foreach ($a_int_links as $int_link) {
             $target = $int_link["Target"];
             if (strpos($target, "il__") === 0) {
                 $target_arr = explode("_", $target);
                 $target_id = $target_arr[count($target_arr) - 1];
                 $type = $int_link["Type"];
                 $targetframe = "None";
 
                 // anchor
                 $anc = $anc_add = "";
                 if (($int_link["Anchor"] ?? "") != "") {
                     $anc = $int_link["Anchor"];
                     $anc_add = "_" . rawurlencode($int_link["Anchor"]);
                 }
 
                 switch ($type) {
                     case "PageObject":
                     case "StructureObject":
                         if ($type === "PageObject") {
                             $href = "#pg_" . $target_id;
                         } else {
                             $href = "#";
                         }
                         break;
                 }
 
                 $link_info .= "<IntLinkInfo Target=\"$target\" Type=\"$type\" " .
                     "TargetFrame=\"$targetframe\" LinkHref=\"$href\" LinkTarget=\"\" Anchor=\"\"/>";
             }
         }
         $link_info .= "</IntLinkInfos>";
 
         return $link_info;
     }

Here is the caller graph for this function:

◆ getScreenId()

ilHelpGUI::getScreenId ( )

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

References $screen_id.

Referenced by getHelpSections(), hasSections(), and setCtrlPar().

                                  : string
     {
         $comp = ($this->screen_id_component != "")
             ? $this->screen_id_component
             : ($this->def_screen_id[self::ID_PART_COMPONENT] ?? '');
 
         if ($comp == "") {
             return "";
         }
 
         $scr_id = (isset($this->screen_id[self::ID_PART_SCREEN]) && $this->screen_id[self::ID_PART_SCREEN] != "")
             ? $this->screen_id[self::ID_PART_SCREEN]
             : ($this->def_screen_id[self::ID_PART_SCREEN] ?? '');
 
         $sub_scr_id = (isset($this->screen_id[self::ID_PART_SUB_SCREEN]) && $this->screen_id[self::ID_PART_SUB_SCREEN] != "")
             ? $this->screen_id[self::ID_PART_SUB_SCREEN]
             : ($this->def_screen_id[self::ID_PART_SUB_SCREEN] ?? '');
 
         $screen_id = $comp . "/" .
             $scr_id . "/" .
             $sub_scr_id;
 
         return $screen_id;
     }

Here is the caller graph for this function:

◆ getTabTooltipText()

ilHelpGUI::getTabTooltipText ( string $a_tab_id )

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

                                                        : string
     {
         if ($this->screen_id_component != "") {
             return $this->internal()->domain()->tooltips()->getTooltipPresentationText($this->screen_id_component . "_" . $a_tab_id);
         }
         return "";
     }

◆ hasSections()

ilHelpGUI::hasSections ( )

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

References getScreenId().

                                  : bool
     {
         return $this->help_map->hasScreenIdSections($this->getScreenId());
     }

Here is the call graph for this function:

◆ if()

ilHelpGUI::if ( is_null(self::$internal_service) )

temporary move it here until DIC holds help service instead of ilHelpGUI

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

                                             {
             self::$internal_service = new \ILIAS\Help\InternalService(
                 $DIC
             );
         }

◆ initHelp()

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

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

References $DIC, $ilSetting, ilGlobalTemplateInterface\addJavaScript(), ilGlobalTemplateInterface\addOnLoadCode(), ilSession\get(), ilCtrl\getLinkTargetByClass(), iljQueryUtil\initMaphilight(), initUI(), and setCtrlPar().

      : void {
         global $DIC;
 
         $this->initUI();
         $ilUser = $DIC->user();
         $ilSetting = $DIC->settings();
         $ctrl = $DIC->ctrl();
 
         $a_tpl->addJavaScript("./Services/Help/js/ilHelp.js");
         $a_tpl->addJavaScript("./Services/Accordion/js/accordion.js");
         iljQueryUtil::initMaphilight();
         $a_tpl->addJavaScript("./Services/COPage/js/ilCOPagePres.js");
 
         $this->setCtrlPar();
         $a_tpl->addOnLoadCode(
             "il.Help.setAjaxUrl('" .
             $ctrl->getLinkTargetByClass("ilhelpgui", "", "", true)
             . "');"
         );
 
 
         if ($this->presentation->isHelpActive()) {
             if (ilSession::get("help_pg") > 0) {
                 $a_tpl->addOnLoadCode("il.Help.showCurrentPage(" . ilSession::get("help_pg") . ");", 3);
             } else {
                 $a_tpl->addOnLoadCode("il.Help.listHelp(null);", 3);
             }
         }
     }

Here is the call graph for this function:

◆ initUI()

ilHelpGUI::initUI ( )

protected

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

References ILIAS\Repository\ctrl(), and ILIAS\Repository\ui().

Referenced by executeCommand(), and initHelp().

                                : void
     {
         $this->ui = $this->internal()->gui()->ui();
         $gui = $this->internal()->gui();
         $this->ctrl = $gui->ctrl();
         $this->help_request = $gui->standardRequest();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isHelpActive()

ilHelpGUI::isHelpActive ( )

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

                                   : bool
     {
         return $this->internal()->domain()->module()->isHelpActive();
     }

◆ isHelpPageActive()

ilHelpGUI::isHelpPageActive ( )

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

References ilSession\get().

                                       : bool
     {
         return (ilSession::get("help_pg") > 0);
     }

Here is the call graph for this function:

◆ replaceItemTag()

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

protected

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

References $DIC, $id, and $path.

Referenced by replaceMenuItemTags().

      : string {
         global $DIC;
         $mmc = $DIC->globalScreen()->collector()->mainmenu();
 
         $id = $item->getProviderIdentification()->getInternalIdentifier();
         $ws = "[ \t\r\f\v\n]*";
 
         // menu item path
         while (preg_match("~\[(menu" . $ws . "path$ws=$ws(\"$id\")$ws)/\]~i", $content, $found)) {
             $path = "";
             if ($item instanceof \ILIAS\GlobalScreen\Scope\MainMenu\Factory\isChild) {
                 $parent = $mmc->getItemInformation()->getParent($item);
                 if ($parent !== null) {
                     $parent = $mmc->getSingleItemFromRaw($parent);
                     $path = $this->getTitleForItem($parent) . " > ";
                 }
             }
             $path .= $this->getTitleForItem($item);
             $content = preg_replace(
                 '~\[' . $found[1] . '/\]~i',
                 "<strong>" . $path . "</strong>",
                 $content
             );
         }
         // menu item
         while (preg_match("~\[(menu" . $ws . "item$ws=$ws(\"$id\")$ws)/\]~i", $content, $found)) {
             $content = preg_replace(
                 '~\[' . $found[1] . '/\]~i',
                 "<strong>" . $this->getTitleForItem($item) . "</strong>",
                 $content
             );
         }
         return $content;
     }

Here is the caller graph for this function:

◆ replaceMenuItemTags()

ilHelpGUI::replaceMenuItemTags ( string $content )

protected

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

References $DIC, and replaceItemTag().

Referenced by showHelp(), and showPage().

      : string {
         global $DIC;
 
         $mmc = $DIC->globalScreen()->collector()->mainmenu();
         if ($this->raw_menu_items == null) {
             $mmc->collectOnce();
             $this->raw_menu_items = iterator_to_array($mmc->getRawItems());
         }
 
         foreach ($this->raw_menu_items as $item) {
             if ($item instanceof Item\LinkList) {
                 foreach ($item->getLinks() as $link) {
                     $content = $this->replaceItemTag($content, $link);
                 }
             }
             $content = $this->replaceItemTag($content, $item);
         }
         return $content;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetCurrentPage()

ilHelpGUI::resetCurrentPage ( )

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

References ilSession\clear().

Referenced by search(), and showHelp().

                                       : void
     {
         ilSession::clear("help_pg");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePersonalSettingFromLegacyForm()

ilHelpGUI::savePersonalSettingFromLegacyForm ( ilPropertyFormGUI $form )

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

References areTooltipsActive(), ilPropertyFormGUI\getInput(), and ILIAS\Repository\user().

                                                                               : void
     {
         if ($this->areTooltipsActive()) {
             $this->user->setPref('hide_help_tt', (string) (int) !$form->getInput('help_tooltips'));
         }
     }

Here is the call graph for this function:

◆ search()

ilHelpGUI::search ( )

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

References $id, $lng, $r, $ui, ilLMObject\_lookupTitle(), exit, ilSession\get(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), resetCurrentPage(), ilSession\set(), symbol(), ilLanguage\txt(), ILIAS\Repository\ui(), and ILIAS\UI\Implementation\Component\withOnLoadCode().

                             : void
     {
         $lng = $this->lng;
         $ui = $this->ui;
 
         $term = $this->help_request->getTerm();
 
         if ($term === "") {
             $term = ilSession::get("help_search_term");
         }
 
         $this->resetCurrentPage();
 
         $h_tpl = new ilTemplate("tpl.help.html", true, true, "Services/Help");
 
         $back_button = $ui->factory()->button()->bulky($ui->factory()->symbol()->glyph()->back(), $lng->txt("back"), "#")->withOnLoadCode(function ($id) {
             return
                 "$(\"#$id\").click(function() { return il.Help.listHelp(event, true); return false;});";
         });
         $h_tpl->setVariable("BACKBUTTON", $ui->renderer()->renderAsync($back_button));
 
         $h_tpl->setVariable("HEAD", $lng->txt("help") . " - " .
             $lng->txt("search_result"));
 
         $h_tpl->setCurrentBlock("search");
         $h_tpl->setVariable("GL_SEARCH", $this->symbol()->glyph("search")->render());
         $h_tpl->setVariable("HELP_SEARCH_LABEL", $this->lng->txt("help_search_label"));
         $h_tpl->setVariable("VAL_SEARCH", ilLegacyFormElementsUtil::prepareFormOutput($term));
         $h_tpl->parseCurrentBlock();
 
         $h_tpl->setVariable("CLOSE_IMG", $this->symbol()->glyph("close")->render());
 
         $items = [];
         $module = $this->internal()->domain()->module();
         foreach ($module->getActiveModules() as $module_id) {
             $lm_id = $module->lookupModuleLmId($module_id);
             $s = new ilRepositoryObjectDetailSearch($lm_id);
             $s->setQueryString($term);
             $result = $s->performSearch();
             foreach ($result->getResults() as $r) {
                 $items[] = $this->ui->factory()->button()->shy(
                     ilLMObject::_lookupTitle($r["item_id"]),
                     "#"
                 )->withOnLoadCode(function ($id) use ($r) {
                     return "document.getElementById('$id').addEventListener('click', () => {return il.Help.showPage(" . $r["item_id"] . ");})";
                 });
             }
         }
 
         $list = $this->ui->factory()->listing()->unordered($items);
         $h_tpl->setVariable("CONTENT", $this->ui->renderer()->renderAsync($list));
 
         ilSession::set("help_search_term", $term);
 
         echo $h_tpl->get();
         exit;
     }

Here is the call graph for this function:

◆ setCtrlPar()

ilHelpGUI::setCtrlPar ( )

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

References $ctrl, $refId, and getScreenId().

Referenced by initHelp().

                                 : void
     {
         $ilCtrl = $this->ctrl;
         $refId = (string) $this->help_request->getRefId();
         $ilCtrl->setParameterByClass("ilhelpgui", "help_screen_id", $this->getScreenId() . "." . $refId);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultScreenId()

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

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

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

◆ setScreenId()

ilHelpGUI::setScreenId ( string $a_id )

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

Referenced by ilObjMediaObjectGUI\createObject(), and ilObjQuestionPoolGUI\createQuestionFormObject().

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

Here is the caller graph for this function:

◆ setScreenIdComponent()

ilHelpGUI::setScreenIdComponent ( string $a_comp )

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

Referenced by ilObjPortfolioBaseGUI\addBlog(), ilObjPortfolioBaseGUI\addPage(), ilObjCategoryGUI\assignRolesObject(), ilBookingScheduleGUI\create(), ilBookingScheduleGUI\edit(), ilExSubmissionTextGUI\editAssignmentTextObject(), ilObjCategoryGUI\executeCommand(), ilSurveyEditorGUI\executeCommand(), ilObjQuestionPoolGUI\getQueryParamInt(), ilObjRootFolderGUI\getTabs(), ilGlossaryTermGUI\getTabs(), ilObjFileBasedLMGUI\getTabs(), ilObjStyleSheetGUI\getTabs(), ilObjWikiGUI\getTabs(), ilObjSurveyQuestionPoolGUI\getTabs(), ilGlossaryPresentationGUI\getTabs(), ilObjMediaObjectGUI\getTabs(), ilLMContentRendererGUI\initHelp(), ilSurveyExecutionGUI\outSurveyPage(), ilBookingHelpAdapter\setHelpId(), ilBasicSkillTemplateGUI\setLevelHead(), ilBasicSkillGUI\setLevelHead(), ilWikiPageGUI\setScreenIdComponent(), ilObjWorkspaceFolderGUI\setTabs(), ilSkillCategoryGUI\setTabs(), ilSkillTemplateReferenceGUI\setTabs(), ilSkillTemplateCategoryGUI\setTabs(), ilPortfolioRepositoryGUI\setTabs(), ilObjPortfolioTemplateGUI\setTabs(), ilBasicSkillTemplateGUI\setTabs(), ilObjPortfolioGUI\setTabs(), ilDashboardGUI\setTabs(), ilBasicSkillGUI\setTabs(), ilObjTaxonomyGUI\setTabs(), ilObjMediaCastGUI\setTabs(), ilObjMediaPoolGUI\setTabs(), ilObjContentObjectGUI\setTabs(), ilGlossaryPresentationGUI\showDefinitionTabs(), and ilExSubmissionFileGUI\uploadFormObject().

                                                         : void
     {
         $this->screen_id_component = $a_comp;
     }

Here is the caller graph for this function:

◆ setSubScreenId()

ilHelpGUI::setSubScreenId ( string $a_id )

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

Referenced by ilBookingScheduleGUI\confirmDelete().

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

Here is the caller graph for this function:

◆ showHelp()

ilHelpGUI::showHelp ( )

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

References $id, $lng, $ui, ilLMObject\_exists(), ilLMObject\_lookupContObjID(), ilLMObject\_lookupTitle(), exit, ilAccordionGUI\FIRST_OPEN, ilSession\get(), ilLMObject\getPagesOfChapter(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), replaceMenuItemTags(), resetCurrentPage(), ilSession\set(), symbol(), ilLanguage\txt(), and ILIAS\Repository\ui().

                               : void
     {
         $lng = $this->lng;
         $lng->loadLanguageModule("help");
         $ui = $this->ui;
 
         if ($this->help_request->getHelpScreenId() !== "") {
             ilSession::set("help_screen_id", $this->help_request->getHelpScreenId());
             $help_screen_id = $this->help_request->getHelpScreenId();
         } else {
             $help_screen_id = ilSession::get("help_screen_id");
         }
 
         ilSession::set("help_search_term", "");
 
         $this->resetCurrentPage();
 
         $id_arr = explode(".", $help_screen_id);
         $help_arr = $this->help_map->getHelpSectionsForId($id_arr[0], (int) $id_arr[1]);
 
         if (count($help_arr) > 0) {
             $acc = new ilAccordionGUI();
             $acc->setId("oh_acc");
             $acc->setUseSessionStorage(true);
             $acc->setBehaviour(ilAccordionGUI::FIRST_OPEN);
 
             foreach ($help_arr as $h_id) {
                 $st_id = $h_id;
                 if (!ilLMObject::_exists($st_id)) {
                     continue;
                 }
                 $oh_lm_id = ilLMObject::_lookupContObjID($st_id);
                 $pages = ilLMObject::getPagesOfChapter($oh_lm_id, $st_id);
                 $items = [];
                 foreach ($pages as $pg) {
                     $items[] = $this->ui->factory()->button()->shy(
                         $this->replaceMenuItemTags(ilLMObject::_lookupTitle($pg["child"])),
                         "#"
                     )->withOnLoadCode(function ($id) use ($pg) {
                         return "document.getElementById('$id').addEventListener('click', () => {return il.Help.showPage(" . $pg["child"] . ");})";
                     });
                 }
                 $list = $this->ui->factory()->listing()->unordered($items);
                 $acc->addItem(ilLMObject::_lookupTitle($st_id), $this->ui->renderer()->renderAsync($list));
             }
 
             $h_tpl = new ilTemplate("tpl.help.html", true, true, "Services/Help");
             $h_tpl->setVariable("HEAD", $lng->txt("help"));
 
             $h_tpl->setCurrentBlock("search");
             $h_tpl->setVariable("GL_SEARCH", $this->symbol()->glyph("search")->render());
             $h_tpl->setVariable("HELP_SEARCH_LABEL", $this->lng->txt("help_search_label"));
             $h_tpl->parseCurrentBlock();
 
             if (count($help_arr) > 0) {
                 $h_tpl->setVariable("CONTENT", $acc->getHTML(true));
             } else {
                 $mess = $ui->factory()->messageBox()->info($lng->txt("help_no_content"));
                 $h_tpl->setVariable("CONTENT", $ui->renderer()->render([$mess]));
             }
 
             $h_tpl->setVariable("CLOSE_IMG", $this->symbol()->glyph("close")->render());
             echo $h_tpl->get();
         }
         exit;
     }

Here is the call graph for this function:

◆ showPage()

ilHelpGUI::showPage ( )

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

References $id, $lng, $ui, ilPageUtil\_existsAndNotEmpty(), ilLMObject\_lookupTitle(), exit, ilSession\get(), getLinkTargetsXML(), getLinkXML(), ilLegacyFormElementsUtil\prepareFormOutput(), replaceMenuItemTags(), ilSession\set(), symbol(), ilLanguage\txt(), and ILIAS\UI\Implementation\Component\withOnLoadCode().

                               : void
     {
         $lng = $this->lng;
         $ui = $this->ui;
 
         $page_id = $this->help_request->getHelpPage();
 
         $h_tpl = new ilTemplate("tpl.help.html", true, true, "Services/Help");
 
         if (($t = ilSession::get("help_search_term")) != "") {
             $back_button = $ui->factory()->button()->bulky($ui->factory()->symbol()->glyph()->back(), $lng->txt("back"), "#")->withOnLoadCode(function ($id) use ($t) {
                 return
                     "$(\"#$id\").click(function() { return il.Help.search('" . ilLegacyFormElementsUtil::prepareFormOutput(
                         $t
                     ) . "'); return false;});";
             });
         } else {
             $back_button = $ui->factory()->button()->bulky($ui->factory()->symbol()->glyph()->back(), $lng->txt("back"), "#")->withOnLoadCode(function ($id) {
                 return
                     "$(\"#$id\").click(function() { return il.Help.listHelp(event, true); return false;});";
             });
         }
         $h_tpl->setVariable("BACKBUTTON", $ui->renderer()->renderAsync($back_button));
 
         $h_tpl->setVariable(
             "HEAD",
             $this->replaceMenuItemTags(ilLMObject::_lookupTitle($page_id))
         );
 
         if (!ilPageUtil::_existsAndNotEmpty("lm", $page_id)) {
             exit;
         }
 
         // get page object
         $page_gui = new ilLMPageGUI($page_id);
         $cfg = $page_gui->getPageConfig();
         $page_gui->setPresentationTitle("");
         $page_gui->setTemplateOutput(false);
         $page_gui->setHeader("");
         $page_gui->setRawPageContent(true);
         $cfg->setEnablePCType("Map", false);
         $cfg->setEnablePCType("Tabs", false);
         $cfg->setEnablePCType("FileList", false);
 
         $page_gui->getPageObject()->buildDom();
         $int_links = $page_gui->getPageObject()->getInternalLinks();
         $link_xml = $this->getLinkXML($int_links);
         $link_xml .= $this->getLinkTargetsXML();
         //echo htmlentities($link_xml);
         $page_gui->setLinkXml($link_xml);
 
         $ret = $this->replaceMenuItemTags($page_gui->showPage());
 
         $h_tpl->setVariable("CONTENT", $ret);
         $h_tpl->setVariable("CLOSE_IMG", $this->symbol()->glyph("close")->render());
 
         ilSession::set("help_pg", $page_id);
 
         $page = $h_tpl->get();
 
         // replace style classes
         //$page = str_replace("ilc_text_inline_Strong", "ilHelpStrong", $page);
 
         echo $page;
         exit;
     }

Here is the call graph for this function:

◆ showTooltips()

ilHelpGUI::showTooltips ( )

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

                                   : bool
     {
         return $this->presentation->showTooltips();
     }

◆ symbol()

ilHelpGUI::symbol ( )

protected

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

References $DIC.

Referenced by search(), showHelp(), and showPage().

                                : \ILIAS\Repository\Symbol\SymbolAdapterGUI
     {
         global $DIC;
         return $DIC->repository()->internal()->gui()->symbol();
     }

Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilCtrl ilHelpGUI::$ctrl

protected

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

Referenced by setCtrlPar().

◆ $def_screen_id

array ilHelpGUI::$def_screen_id = array()

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

◆ $gui

ILIAS Repository InternalGUIService ilHelpGUI::$gui

protected

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

◆ $help_map

ILIAS Help Map MapManager ilHelpGUI::$help_map

protected

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

◆ $help_request

StandardGUIRequest ilHelpGUI::$help_request

protected

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

◆ $help_sections

array ilHelpGUI::$help_sections = array()

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

◆ $internal_service

ILIAS Help InternalService ilHelpGUI::$internal_service = null

staticprotected

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

◆ $lng

ilLanguage ilHelpGUI::$lng

protected

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

Referenced by search(), showHelp(), and showPage().

◆ $presentation

ILIAS Help Presentation PresentationManager ilHelpGUI::$presentation

protected

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

◆ $raw_menu_items

array ilHelpGUI::$raw_menu_items = null

protected

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

◆ $screen_id

array ilHelpGUI::$screen_id = array()

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

Referenced by getScreenId().

◆ $screen_id_component

string ilHelpGUI::$screen_id_component = ''

protected

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

◆ $settings

ilSetting ilHelpGUI::$settings

protected

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

◆ $ui

ILIAS DI UIServices ilHelpGUI::$ui

protected

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

Referenced by search(), showHelp(), and showPage().

◆ $user

ilObjUser ilHelpGUI::$user

protected

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

Referenced by activateTooltips(), and deactivateTooltips().

◆ 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"

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

Referenced by ilObjStyleSheetGUI\createObject(), ilRepositoryGUI\executeCommand(), and ilTabsGUI\removeNonTabbedLinks().

◆ ID_PART_SUB_SCREEN

const ilHelpGUI::ID_PART_SUB_SCREEN = "sub_screen"

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

Referenced by ilTabsGUI\removeNonTabbedLinks().

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

Services/Help/classes/class.ilHelpGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateTooltips()

◆ addHelpSection()

◆ addPersonalSettingToLegacyForm()

◆ areTooltipsActive()

◆ deactivateTooltips()

◆ executeCommand()

◆ getHelpSections()

◆ getLinkTargetsXML()

◆ getLinkXML()

◆ getScreenId()

◆ getTabTooltipText()

◆ hasSections()

◆ if()

◆ initHelp()

◆ initUI()

◆ isHelpActive()

◆ isHelpPageActive()

◆ replaceItemTag()

◆ replaceMenuItemTags()

◆ resetCurrentPage()

◆ savePersonalSettingFromLegacyForm()

◆ search()

◆ setCtrlPar()

◆ setDefaultScreenId()

◆ setScreenId()

◆ setScreenIdComponent()

◆ setSubScreenId()

◆ showHelp()

◆ showPage()

◆ showTooltips()

◆ symbol()

Field Documentation

◆ $ctrl

◆ $def_screen_id

◆ $gui

◆ $help_map

◆ $help_request

◆ $help_sections

◆ $internal_service

◆ $lng

◆ $presentation

◆ $raw_menu_items

◆ $screen_id

◆ $screen_id_component

◆ $settings

◆ $ui

◆ $user

◆ ID_PART_COMPONENT

◆ ID_PART_SCREEN

◆ ID_PART_SUB_SCREEN