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)

	registerTabLink (string $tab_id, \ILIAS\UI\Component\Link\Standard $link)

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

	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
HelpScreenIdObserver	$observer

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 @ilCtrl_Calls ilHelpGUI: ilLMPageGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilHelpGUI::__construct ( )

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

    {
        global $DIC;
 
        $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();
 
        if (!isset($DIC['help.screen_id_collector'])) {
            $DIC['help.screen_id_collector'] = function () use ($DIC) {
                return new HelpScreenIdObserver();
            };
        }
        $DIC->ctrl()->attachObserver($DIC['help.screen_id_collector']);
        $this->observer = $DIC['help.screen_id_collector'];
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ activateTooltips()

ilHelpGUI::activateTooltips ( )

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

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

◆ addHelpSection()

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

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

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

◆ areTooltipsActive()

ilHelpGUI::areTooltipsActive ( )

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

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

◆ deactivateTooltips()

ilHelpGUI::deactivateTooltips ( )

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

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

◆ executeCommand()

ilHelpGUI::executeCommand ( )

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

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getHelpSections()

ilHelpGUI::getHelpSections ( )

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

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

◆ getLinkTargetsXML()

ilHelpGUI::getLinkTargetsXML ( )

Get XMl for Link Targets.

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

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

◆ getLinkXML()

ilHelpGUI::getLinkXML ( array $a_int_links )

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

     : 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;
    }

◆ getScreenId()

ilHelpGUI::getScreenId ( )

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

                                 : string
    {
        return $this->observer->getScreenId();
 
        $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;
    }

◆ getTabTooltipText()

ilHelpGUI::getTabTooltipText ( string $a_tab_id )

Definition at line 308 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 143 of file class.ilHelpGUI.php.

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

◆ if()

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

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

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

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

References $DIC.

◆ initHelp()

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

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

     : void {
        global $DIC;
 
        $this->initUI();
        $ilUser = $DIC->user();
        $ilSetting = $DIC->settings();
        $ctrl = $DIC->ctrl();
 
        $a_tpl->addJavaScript("assets/js/ilHelp.js");
        $a_tpl->addJavaScript("assets/js/accordion.js");
        $a_tpl->addJavaScript("components/ILIAS/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);
            }
        }
    }

◆ initUI()

ilHelpGUI::initUI ( )

protected

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

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

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

Here is the call graph for this function:

◆ isHelpActive()

ilHelpGUI::isHelpActive ( )

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

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

◆ isHelpPageActive()

ilHelpGUI::isHelpPageActive ( )

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

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

References ilSession\get().

Here is the call graph for this function:

◆ registerTabLink()

ilHelpGUI::registerTabLink	(	string	$tab_id,
		\ILIAS\UI\Component\Link\Standard	$link
	)

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

                                                                                            : \ILIAS\UI\Component\Link\Standard
    {
        $tab_id = $this->screen_id_component . "_" . $tab_id;
        return $this->internal()->gui()->guidedTour()->guidedTourGUI()
            ->registerTabLink($tab_id, $link);
    }

◆ replaceItemTag()

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

protected

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

     : 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;
    }

References $path.

◆ replaceMenuItemTags()

ilHelpGUI::replaceMenuItemTags ( string $content )

protected

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

     : 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;
    }

◆ resetCurrentPage()

ilHelpGUI::resetCurrentPage ( )

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

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

References ilSession\clear().

Here is the call graph for this function:

◆ search()

ilHelpGUI::search ( )

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

                            : 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, "components/ILIAS/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;
    }

References $id, $lng, ilLMObject\_lookupTitle(), exit, ilSession\get(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), ilSession\set(), ILIAS\Repository\symbol(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ setCtrlPar()

ilHelpGUI::setCtrlPar ( )

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

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

References $refId.

◆ setDefaultScreenId()

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

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

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

◆ setScreenId()

ilHelpGUI::setScreenId ( string $a_id )

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

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

◆ setScreenIdComponent()

ilHelpGUI::setScreenIdComponent ( string $a_comp )

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

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

Referenced by ilBookingScheduleGUI\create(), ilBookingScheduleGUI\edit(), ilObjCategoryGUI\executeCommand(), ilSurveyEditorGUI\executeCommand(), ilObjFileBasedLMGUI\getTabs(), ilObjRootFolderGUI\getTabs(), ilObjSurveyQuestionPoolGUI\getTabs(), ilObjWikiGUI\getTabs(), ilLMContentRendererGUI\initHelp(), ilBookingHelpAdapter\setHelpId(), ilBasicSkillGUI\setLevelHead(), ilBasicSkillTemplateGUI\setLevelHead(), ilWikiPageGUI\setScreenIdComponent(), ilSkillTemplateReferenceGUI\setTabs(), ilDashboardGUI\setTabs(), ilPortfolioRepositoryGUI\setTabs(), ilObjPortfolioTemplateGUI\setTabs(), ilObjWorkspaceFolderGUI\setTabs(), ilSkillCategoryGUI\setTabs(), ilSkillTemplateCategoryGUI\setTabs(), ilBasicSkillGUI\setTabs(), and ilBasicSkillTemplateGUI\setTabs().

Here is the caller graph for this function:

◆ setSubScreenId()

ilHelpGUI::setSubScreenId ( string $a_id )

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

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

◆ showHelp()

ilHelpGUI::showHelp ( )

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

                              : 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, "components/ILIAS/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;
    }

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

Here is the call graph for this function:

◆ showPage()

ilHelpGUI::showPage ( )

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

                              : void
    {
        $lng = $this->lng;
        $ui = $this->ui;
 
        $page_id = $this->help_request->getHelpPage();
 
        $h_tpl = new ilTemplate("tpl.help.html", true, true, "components/ILIAS/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;
    }

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

Here is the call graph for this function:

◆ showTooltips()

ilHelpGUI::showTooltips ( )

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

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

◆ symbol()

ilHelpGUI::symbol ( )

protected

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

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

References $DIC.

Field Documentation

◆ $ctrl

ilCtrl ilHelpGUI::$ctrl

protected

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

◆ $def_screen_id

array ilHelpGUI::$def_screen_id = array()

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

◆ $gui

ILIAS Repository InternalGUIService ilHelpGUI::$gui

protected

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

Referenced by initUI().

◆ $help_map

ILIAS Help Map MapManager ilHelpGUI::$help_map

protected

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

◆ $help_request

StandardGUIRequest ilHelpGUI::$help_request

protected

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

◆ $help_sections

array ilHelpGUI::$help_sections = array()

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

◆ $internal_service

ILIAS Help InternalService ilHelpGUI::$internal_service = null

staticprotected

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

◆ $lng

ilLanguage ilHelpGUI::$lng

protected

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

◆ $observer

HelpScreenIdObserver ilHelpGUI::$observer

protected

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

◆ $presentation

ILIAS Help Presentation PresentationManager ilHelpGUI::$presentation

protected

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

◆ $raw_menu_items

array ilHelpGUI::$raw_menu_items = null

protected

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

◆ $screen_id

array ilHelpGUI::$screen_id = array()

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

◆ $screen_id_component

string ilHelpGUI::$screen_id_component = ''

protected

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

◆ $settings

ilSetting ilHelpGUI::$settings

protected

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

◆ $ui

ILIAS DI UIServices ilHelpGUI::$ui

protected

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

◆ $user

ilObjUser ilHelpGUI::$user

protected

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

◆ ID_PART_COMPONENT

const ilHelpGUI::ID_PART_COMPONENT = "component"

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

◆ ID_PART_SCREEN

const ilHelpGUI::ID_PART_SCREEN = "screen"

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

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

◆ ID_PART_SUB_SCREEN

const ilHelpGUI::ID_PART_SUB_SCREEN = "sub_screen"

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

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

components/ILIAS/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()

◆ areTooltipsActive()

◆ deactivateTooltips()

◆ executeCommand()

◆ getHelpSections()

◆ getLinkTargetsXML()

◆ getLinkXML()

◆ getScreenId()

◆ getTabTooltipText()

◆ hasSections()

◆ if()

◆ initHelp()

◆ initUI()

◆ isHelpActive()

◆ isHelpPageActive()

◆ registerTabLink()

◆ replaceItemTag()

◆ replaceMenuItemTags()

◆ resetCurrentPage()

◆ 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

◆ $observer

◆ $presentation

◆ $raw_menu_items

◆ $screen_id

◆ $screen_id_component

◆ $settings

◆ $ui

◆ $user

◆ ID_PART_COMPONENT

◆ ID_PART_SCREEN

◆ ID_PART_SUB_SCREEN