ilHelpGUI Class Reference

Help GUI class. More...

Collaboration diagram for ilHelpGUI:

Public Member Functions
	__construct ()
	constructor More...
	setDefaultScreenId ($a_part, $a_id)
	Set default screen id. More...
	setScreenId ($a_id)
	Set screen id. More...
	setSubScreenId ($a_id)
	Set sub screen id. More...
	setScreenIdComponent ($a_comp)
	Set screen id component. More...
	getScreenId ()
	Get screen id. More...
	addHelpSection ($a_help_id, $a_level=1)
	Add help section. More...
	hasSections ()
	Has sections? More...
	getHelpSections ()
	Get help sections. More...
	setCtrlPar ()
	Get help section url parameter. More...
	executeCommand ()
	execute command More...
	showHelp ()
	Show online help. More...
	showPage ()
	Show page. More...
	resetCurrentPage ()
	Hide help. More...
	getTabTooltipText ($a_tab_id)
	Get tab tooltip text. More...
	initHelp ($a_tpl, $ajax_url)
	Render current help page. More...
	isHelpPageActive ()
	Is help page active? More...
	deactivateTooltips ()
	Deactivate tooltips. More...
	activateTooltips ()
	Activate tooltips. More...
	getLinkXML ($a_int_links)
	get xml for links More...
	getLinkTargetsXML ()
	Get XMl for Link Targets. More...
	search ()
	Search. More...

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

Protected Member Functions
	replaceMenuItemTags (string $content)
	Help page post processing. More...
	replaceItemTag ($mmc, string $content, \ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem $item)
	Replace item tag. More...
	getTitleForItem (\ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem $item)
	Get title for item. More...

Protected Attributes
	$ctrl
	$settings
	$lng
	$user
	$ui
	$raw_menu_items = null

Detailed Description

Help GUI class.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

@ilCtrl_Calls ilHelpGUI: ilLMPageGUI

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

Constructor & Destructor Documentation

__construct()

ilHelpGUI::__construct

(

)

constructor

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

    {
        global $DIC;
 
        $this->settings = $DIC->settings();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $ilCtrl = $DIC->ctrl();
                
        $this->ctrl = $ilCtrl;
        $this->ui = $DIC->ui();
    }

References $DIC, $ilCtrl, settings(), ui(), and user().

Here is the call graph for this function:

Member Function Documentation

activateTooltips()

ilHelpGUI::activateTooltips

(

)

Activate tooltips.

Parameters

return

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

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

References $ilUser, and $user.

addHelpSection()

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

Add help section.

Parameters

return

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

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

deactivateTooltips()

ilHelpGUI::deactivateTooltips

(

)

Deactivate tooltips.

Parameters

return

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

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

References $ilUser, and $user.

executeCommand()

ilHelpGUI::executeCommand

(

)

execute command

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

    {
        $cmd = $this->ctrl->getCmd("showHelp");
        $next_class = $this->ctrl->getNextClass($this);
        
        switch ($next_class) {
            default:
                return $this->$cmd();
                break;
        }
    }

getHelpSections()

ilHelpGUI::getHelpSections

(

)

Get help sections.

Parameters

return

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

    {
        include_once("./Services/Help/classes/class.ilHelpMapping.php");
        return ilHelpMapping::getHelpSectionsForId($this->getScreenId(), (int) $_GET["ref_id"]);
    }

References $_GET, ilHelpMapping\getHelpSectionsForId(), and getScreenId().

Here is the call graph for this function:

getLinkTargetsXML()

ilHelpGUI::getLinkTargetsXML

(

)

Get XMl for Link Targets.

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

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

Referenced by showPage().

Here is the caller graph for this function:

getLinkXML()

ilHelpGUI::getLinkXML

(

$a_int_links

)

get xml for links

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

    {
        $ilCtrl = $this->ctrl;
 
        $link_info = "<IntLinkInfos>";
        foreach ($a_int_links as $int_link) {
            $target = $int_link["Target"];
            if (substr($target, 0, 4) == "il__") {
                $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;
    }

References $ctrl, $ilCtrl, $target_arr, $target_id, and $type.

Referenced by showPage().

Here is the caller graph for this function:

getScreenId()

ilHelpGUI::getScreenId

(

)

Get screen id.

Parameters

return

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

    {
        $comp = ($this->screen_id_component != "")
            ? $this->screen_id_component
            : $this->def_screen_id[self::ID_PART_COMPONENT];
        
        if ($comp == "") {
            return "";
        }
        
        $scr_id = ($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 = ($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;
    }

References $screen_id, ID_PART_SCREEN, and ID_PART_SUB_SCREEN.

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

Here is the caller graph for this function:

getTabTooltipText()

ilHelpGUI::getTabTooltipText

(

$a_tab_id

)

Get tab tooltip text.

Parameters

string

$a_tab_id

tab id

Returns

string tooltip text

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

    {
        $lng = $this->lng;
        
        include_once("./Services/Help/classes/class.ilHelp.php");
        if ($this->screen_id_component != "") {
            return ilHelp::getTooltipPresentationText($this->screen_id_component . "_" . $a_tab_id);
            //return $lng->txt("help_tt_".$this->screen_id_component."_".$a_tab_id);
        }
        return "";
    }

References $lng, and ilHelp\getTooltipPresentationText().

Here is the call graph for this function:

getTitleForItem()

ilHelpGUI::getTitleForItem ( \ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem  $item )

protected

Get title for item.

Parameters

\ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem

$item

Returns

string

Exceptions

Throwable

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

                                                                                               : string
    {
        global $DIC;
        $mmc = $DIC->globalScreen()->collector()->mainmenu();
        return $mmc->getItemInformation()->customTranslationForUser($item)->getTitle();
    }

References $DIC.

Referenced by replaceItemTag().

Here is the caller graph for this function:

hasSections()

ilHelpGUI::hasSections

(

)

Has sections?

Parameters

return

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

    {
        $ilSetting = $this->settings;
        
        include_once("./Services/Help/classes/class.ilHelpMapping.php");
        return ilHelpMapping::hasScreenIdSections($this->getScreenId());
    }

References $ilSetting, $settings, getScreenId(), and ilHelpMapping\hasScreenIdSections().

Here is the call graph for this function:

initHelp()

ilHelpGUI::initHelp	(		$a_tpl,
			$ajax_url
	)

Render current help page.

Parameters

return

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

    {
        global $DIC;
 
        $ilUser = $DIC->user();
        $ilSetting = $DIC->settings();
        $ctrl = $DIC->ctrl();
 
        ilYuiUtil::initConnection();
        $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)
            . "');"
        );
 
 
        $module_id = (int) $ilSetting->get("help_module");
 
        if ((OH_REF_ID > 0 || $module_id > 0) && $ilUser->getLanguage() == "de") {
            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);
            }
 
 
            if ($ilUser->getPref("hide_help_tt")) {
                $a_tpl->addOnLoadCode("if (il && il.Help) {il.Help.switchTooltips();}", 3);
            }
        }
    }

References $ctrl, $DIC, $ilSetting, $ilUser, ilSession\get(), ilYuiUtil\initConnection(), iljQueryUtil\initMaphilight(), and setCtrlPar().

Here is the call graph for this function:

isHelpPageActive()

ilHelpGUI::isHelpPageActive

(

)

Is help page active?

Parameters

return

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

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

References ilSession\get().

Here is the call graph for this function:

replaceItemTag()

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

protected

Replace item tag.

Parameters

return

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

    {
        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 $DIC, and getTitleForItem().

Referenced by replaceMenuItemTags().

Here is the call graph for this function:

Here is the caller graph for this function:

replaceMenuItemTags()

ilHelpGUI::replaceMenuItemTags ( string  $content )

protected

Help page post processing.

Parameters

string

$content

Returns

string

Exceptions

Throwable

Definition at line 618 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($mmc, $content, $link);
                }
            }
            $content = $this->replaceItemTag($mmc, $content, $item);
        }
        return $content;
    }

References $DIC, and replaceItemTag().

Referenced by showHelp(), and showPage().

Here is the call graph for this function:

Here is the caller graph for this function:

resetCurrentPage()

ilHelpGUI::resetCurrentPage

(

)

Hide help.

Parameters

return

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

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

References ilSession\clear().

Referenced by search(), and showHelp().

Here is the call graph for this function:

Here is the caller graph for this function:

search()

ilHelpGUI::search

(

)

Search.

Parameters

return

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

    {
        $lng = $this->lng;
        $ui = $this->ui;
 
        $term = $_GET["term"];
 
        if ($term == "") {
            $term = ilSession::get("help_search_term");
        }
 
        $this->resetCurrentPage();
 
        $h_tpl = new ilTemplate("tpl.help.html", true, true, "Services/Help");
        include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
 
 
        $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");
        include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
        $h_tpl->setVariable("GL_SEARCH", ilGlyphGUI::get(ilGlyphGUI::SEARCH));
        $h_tpl->setVariable("HELP_SEARCH_LABEL", $this->lng->txt("help_search_label"));
        $h_tpl->setVariable("VAL_SEARCH", ilUtil::prepareFormOutput($term));
        $h_tpl->parseCurrentBlock();
 
        include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
        $h_tpl->setVariable("CLOSE_IMG", ilGlyphGUI::get(ilGlyphGUI::CLOSE));
 
        $lm_id = ilHelp::getHelpLMId();
        include_once("./Services/Search/classes/class.ilRepositoryObjectDetailSearch.php");
        $s = new ilRepositoryObjectDetailSearch($lm_id);
        $s->setQueryString($term);
        $result = $s->performSearch();
 
        include_once("./Services/UIComponent/GroupedList/classes/class.ilGroupedListGUI.php");
        $grp_list = new ilGroupedListGUI();
        foreach ($result->getResults() as $r) {
            $grp_list->addEntry(
                ilLMObject::_lookupTitle($r["item_id"]),
                "#",
                "",
                "return il.Help.showPage(" . $r["item_id"] . ");"
            );
        }
        $h_tpl->setVariable("CONTENT", $grp_list->getHTML());
 
        ilSession::set("help_search_term", $term);
 
        echo $h_tpl->get();
        ;
        exit;
    }

References $_GET, $lng, $result, $ui, ilLMObject\_lookupTitle(), ilGlyphGUI\CLOSE, exit, ilGlyphGUI\get(), ilSession\get(), ilHelp\getHelpLMId(), ilUtil\prepareFormOutput(), resetCurrentPage(), ilGlyphGUI\SEARCH, and ilSession\set().

Here is the call graph for this function:

setCtrlPar()

ilHelpGUI::setCtrlPar

(

)

Get help section url parameter.

Parameters

return

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

    {
        $ilCtrl = $this->ctrl;
        
        /*$h_ids = $sep = "";
        foreach ($this->getHelpSections() as $hs)
        {
            $h_ids.= $sep.$hs;
            $sep = ",";
        }*/
        $ilCtrl->setParameterByClass("ilhelpgui", "help_screen_id", $this->getScreenId() . "." . $_GET["ref_id"]);
    }

References $_GET, $ctrl, $ilCtrl, and getScreenId().

Referenced by initHelp().

Here is the call graph for this function:

Here is the caller graph for this function:

setDefaultScreenId()

ilHelpGUI::setDefaultScreenId	(		$a_part,
			$a_id
	)

Set default screen id.

Parameters

return

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

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

setScreenId()

ilHelpGUI::setScreenId

(

$a_id

)

Set screen id.

Parameters

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

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

References ID_PART_SCREEN.

setScreenIdComponent()

ilHelpGUI::setScreenIdComponent

(

$a_comp

)

Set screen id component.

Parameters

return

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

    {
        $this->screen_id_component = $a_comp;
    }

setSubScreenId()

ilHelpGUI::setSubScreenId

(

$a_id

)

Set sub screen id.

Parameters

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

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

References ID_PART_SUB_SCREEN.

showHelp()

ilHelpGUI::showHelp

(

)

Show online help.

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

    {
        $lng = $this->lng;
        $lng->loadLanguageModule("help");
        $ui = $this->ui;
 
        if ($_GET["help_screen_id"] != "") {
            ilSession::set("help_screen_id", $_GET["help_screen_id"]);
            $help_screen_id = $_GET["help_screen_id"];
        } else {
            $help_screen_id = ilSession::get("help_screen_id");
        }
 
        ilSession::set("help_search_term", "");
 
        $this->resetCurrentPage();
 
        $id_arr = explode(".", $help_screen_id);
        include_once("./Services/Help/classes/class.ilHelpMapping.php");
        include_once("./Services/Help/classes/class.ilHelp.php");
 
        $help_arr = ilHelpMapping::getHelpSectionsForId($id_arr[0], $id_arr[1]);
        $oh_lm_id = ilHelp::getHelpLMId();
 
        if ($oh_lm_id > 0) {
            include_once("./Services/Accordion/classes/class.ilAccordionGUI.php");
            $acc = new ilAccordionGUI();
            $acc->setId("oh_acc_" . $h_id);
            $acc->setUseSessionStorage(true);
            $acc->setBehaviour(ilAccordionGUI::FIRST_OPEN);
 
            foreach ($help_arr as $h_id) {
                include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                $st_id = $h_id;
                if (!ilLMObject::_exists($st_id)) {
                    continue;
                }
 
                $pages = ilLMObject::getPagesOfChapter($oh_lm_id, $st_id);
                include_once("./Services/UIComponent/GroupedList/classes/class.ilGroupedListGUI.php");
                $grp_list = new ilGroupedListGUI();
                foreach ($pages as $pg) {
                    $grp_list->addEntry(
                        $this->replaceMenuItemTags((string) ilLMObject::_lookupTitle($pg["child"])),
                        "#",
                        "",
                        "return il.Help.showPage(" . $pg["child"] . ");"
                    );
                }
                
                $acc->addItem(ilLMObject::_lookupTitle($st_id), $grp_list->getHTML());
            }
 
            $h_tpl = new ilTemplate("tpl.help.html", true, true, "Services/Help");
            $h_tpl->setVariable("HEAD", $lng->txt("help"));
 
            $h_tpl->setCurrentBlock("search");
            include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
            $h_tpl->setVariable("GL_SEARCH", ilGlyphGUI::get(ilGlyphGUI::SEARCH));
            $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());
            } else {
                $mess = $ui->factory()->messageBox()->info($lng->txt("help_no_content"));
                $h_tpl->setVariable("CONTENT", $ui->renderer()->render([$mess]));
            }
 
            include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
            $h_tpl->setVariable("CLOSE_IMG", ilGlyphGUI::get(ilGlyphGUI::CLOSE));
            echo $h_tpl->get();
        }
        exit;
    }

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

Here is the call graph for this function:

showPage()

ilHelpGUI::showPage

(

)

Show page.

Parameters

return

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

    {
        $lng = $this->lng;
        $ui = $this->ui;
        
        $page_id = (int) $_GET["help_page"];
        
        $h_tpl = new ilTemplate("tpl.help.html", true, true, "Services/Help");
        include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
 
 
        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('" . ilUtil::prepareFormOutput($t) . "'); return false;});";
            });
            $h_tpl->setVariable("BACKBUTTON", $ui->renderer()->renderAsync($back_button));
        } 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((string) ilLMObject::_lookupTitle($page_id))
        );
        
        include_once("./Services/COPage/classes/class.ilPageUtil.php");
        if (!ilPageUtil::_existsAndNotEmpty("lm", $page_id)) {
            exit;
        }
        include_once("./Services/COPage/classes/class.ilPageObject.php");
        include_once("./Services/COPage/classes/class.ilPageObjectGUI.php");
 
        // get page object
        include_once("./Modules/LearningModule/classes/class.ilObjContentObject.php");
        include_once("./Modules/LearningModule/classes/class.ilLMPageGUI.php");
        $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((string) $page_gui->showPage());
 
        $h_tpl->setVariable("CONTENT", $ret);
        include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
        $h_tpl->setVariable("CLOSE_IMG", ilGlyphGUI::get(ilGlyphGUI::CLOSE));
 
        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 $_GET, $lng, $ret, $ui, ilPageUtil\_existsAndNotEmpty(), ilLMObject\_lookupTitle(), ilGlyphGUI\CLOSE, exit, ilGlyphGUI\get(), ilSession\get(), getLinkTargetsXML(), getLinkXML(), ilUtil\prepareFormOutput(), replaceMenuItemTags(), ilSession\set(), and ILIAS\UI\Implementation\Component\withOnLoadCode().

Here is the call graph for this function:

Field Documentation

$ctrl

ilHelpGUI::$ctrl

protected

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

Referenced by getLinkXML(), initHelp(), and setCtrlPar().

$def_screen_id

ilHelpGUI::$def_screen_id = array()

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

$help_sections

ilHelpGUI::$help_sections = array()

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

$lng

ilHelpGUI::$lng

protected

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

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

$raw_menu_items

ilHelpGUI::$raw_menu_items = null

protected

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

$screen_id

ilHelpGUI::$screen_id = array()

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

Referenced by getScreenId().

$settings

ilHelpGUI::$settings

protected

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

Referenced by hasSections().

$ui

ilHelpGUI::$ui

protected

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

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

$user

ilHelpGUI::$user

protected

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

Referenced by activateTooltips(), and deactivateTooltips().

ID_PART_COMPONENT

const ilHelpGUI::ID_PART_COMPONENT = "component"

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

ID_PART_SCREEN

const ilHelpGUI::ID_PART_SCREEN = "screen"

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

Referenced by ilTabsGUI\__getHTML(), ilObjStyleSheetGUI\createObject(), ilRepositoryGUI\executeCommand(), ilPDSelectedItemsBlockGUI\getHTML(), getScreenId(), and setScreenId().

ID_PART_SUB_SCREEN

const ilHelpGUI::ID_PART_SUB_SCREEN = "sub_screen"

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

Referenced by ilTabsGUI\__getHTML(), getScreenId(), and setSubScreenId().

---

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

• Services/Help/classes/class.ilHelpGUI.php