Help GUI class. More...

Collaboration diagram for ilHelpGUI:

Public Member Functions
	ilHelpGUI ()
	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)
	Render current help page. 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()

Detailed Description

Help GUI class.

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

Version: $Id$

ilHelpGUI: ilLMPageGUI

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

Member Function Documentation

◆ activateTooltips()

ilHelpGUI::activateTooltips ( )

Activate tooltips.

Parameters

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

References $ilUser.

         {
                 global $ilUser;
                 
                 $ilUser->writePref("hide_help_tt", "0");
         }

◆ addHelpSection()

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

Add help section.

Parameters

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

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

◆ deactivateTooltips()

ilHelpGUI::deactivateTooltips ( )

Deactivate tooltips.

Parameters

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

References $ilUser.

         {
                 global $ilUser;
                 
                 $ilUser->writePref("hide_help_tt", "1");
         }

◆ executeCommand()

ilHelpGUI::executeCommand ( )

execute command

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

References $cmd.

         {
                 $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

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

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

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

Here is the call graph for this function:

◆ getLinkTargetsXML()

ilHelpGUI::getLinkTargetsXML ( )

Get XMl for Link Targets.

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

Referenced by showPage().

         {
                 $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 ( $a_int_links )

get xml for links

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

References $ilCtrl, $target_arr, and $target_id.

Referenced by showPage().

         {
                 global $ilCtrl;
 
                 $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;
         }

Here is the caller graph for this function:

◆ getScreenId()

ilHelpGUI::getScreenId ( )

Get screen id.

Parameters

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

References $screen_id.

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

         {
                 $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;
         }

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 354 of file class.ilHelpGUI.php.

References $lng, and ilHelp\getTooltipPresentationText().

         {
                 global $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 "";
         }

Here is the call graph for this function:

◆ hasSections()

ilHelpGUI::hasSections ( )

Has sections?

Parameters

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

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

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

Here is the call graph for this function:

◆ ilHelpGUI()

ilHelpGUI::ilHelpGUI ( )

constructor

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

References $ilCtrl.

         {
                 global $ilCtrl;
                                 
                 $this->ctrl =& $ilCtrl;
         }

◆ initHelp()

ilHelpGUI::initHelp ( $a_tpl )

Render current help page.

Parameters

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

References $ilSetting, $ilUser, and ilSession\get().

Referenced by ilTemplate\initHelp().

         {
                 global $ilUser, $ilSetting;
 
                 $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);
                         }
                         if ($ilUser->getPref("hide_help_tt"))
                         {
                                 $a_tpl->addJavascript("./Services/Help/js/ilHelp.js");
                                 $a_tpl->addOnLoadCode("if (il && il.Help) {il.Help.switchTooltips();}", 3);
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetCurrentPage()

ilHelpGUI::resetCurrentPage ( )

Hide help.

Parameters

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

References ilSession\clear().

Referenced by search(), and showHelp().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ search()

ilHelpGUI::search ( )

Search.

Parameters

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

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

         {
                 global $lng;
 
                 $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");
 
                 $h_tpl->setCurrentBlock("backlink");
                 $h_tpl->setVariable("TXT_BACK", $lng->txt("back"));
                 $h_tpl->setVariable("ONCLICK_BACK",
                         "return il.Help.listHelp(event, true);");
                 $h_tpl->parseCurrentBlock();
 
 
                 $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("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;
         }

Here is the call graph for this function:

◆ setCtrlPar()

ilHelpGUI::setCtrlPar ( )

Get help section url parameter.

Parameters

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

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

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

Here is the call graph for this function:

◆ setDefaultScreenId()

ilHelpGUI::setDefaultScreenId	(	$a_part,
		$a_id
	)

Set default screen id.

Parameters

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

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

◆ setScreenIdComponent()

ilHelpGUI::setScreenIdComponent ( $a_comp )

Set screen id component.

Parameters

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

         {
                 $this->screen_id_component = $a_comp;
         }

◆ setSubScreenId()

ilHelpGUI::setSubScreenId ( $a_id )

Set sub screen id.

Parameters

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

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

◆ showHelp()

ilHelpGUI::showHelp ( )

Show online help.

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

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

         {
                 global $ilHelp, $lng, $ilSetting;
 
                 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 && count($help_arr) > 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(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->parseCurrentBlock();
 
                         $h_tpl->setVariable("CONTENT", $acc->getHTML());
                         include_once("./Services/UIComponent/Glyph/classes/class.ilGlyphGUI.php");
                         $h_tpl->setVariable("CLOSE_IMG", ilGlyphGUI::get(ilGlyphGUI::CLOSE));
                         echo $h_tpl->get();
                 }
                 exit;
         }

Here is the call graph for this function:

◆ showPage()

ilHelpGUI::showPage ( )

Show page.

Parameters

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

References $_GET, $lng, $ret, $t, ilPageUtil\_existsAndNotEmpty(), ilLMObject\_lookupTitle(), ilGlyphGUI\CLOSE, exit, ilGlyphGUI\get(), ilSession\get(), getLinkTargetsXML(), getLinkXML(), ilUtil\prepareFormOutput(), and ilSession\set().

         {
                 global $lng;
                 
                 $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");
 
 
                 $h_tpl->setCurrentBlock("backlink");
                 $h_tpl->setVariable("TXT_BACK", $lng->txt("back"));
                 if (($t =ilSession::get("help_search_term")) != "")
                 {
                         $h_tpl->setVariable("ONCLICK_BACK",
                                 "return il.Help.search('".ilUtil::prepareFormOutput($t)."');");
                 }
                 else
                 {
                         $h_tpl->setVariable("ONCLICK_BACK",
                                 "return il.Help.listHelp(event, true);");
                 }
                 $h_tpl->parseCurrentBlock();
                 
                 
                 $h_tpl->setVariable("HEAD", $lng->txt("help")." - ".
                         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 = $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;
         }

Here is the call graph for this function:

Field Documentation

◆ $def_screen_id

ilHelpGUI::$def_screen_id = array()

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

◆ $help_sections

ilHelpGUI::$help_sections = array()

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

◆ $screen_id

ilHelpGUI::$screen_id = array()

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

Referenced by getScreenId().

◆ ID_PART_COMPONENT

const ilHelpGUI::ID_PART_COMPONENT = "component"

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

◆ ID_PART_SCREEN

const ilHelpGUI::ID_PART_SCREEN = "screen"

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

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

◆ ID_PART_SUB_SCREEN

const ilHelpGUI::ID_PART_SUB_SCREEN = "sub_screen"

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

Referenced by ilTabsGUI\__getHTML().

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

Services/Help/classes/class.ilHelpGUI.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ activateTooltips()

◆ addHelpSection()

◆ deactivateTooltips()

◆ executeCommand()

◆ getHelpSections()

◆ getLinkTargetsXML()

◆ getLinkXML()

◆ getScreenId()

◆ getTabTooltipText()

◆ hasSections()

◆ ilHelpGUI()

◆ initHelp()

◆ resetCurrentPage()

◆ search()

◆ setCtrlPar()

◆ setDefaultScreenId()

◆ setScreenId()

◆ setScreenIdComponent()

◆ setSubScreenId()

◆ showHelp()

◆ showPage()

Field Documentation

◆ $def_screen_id

◆ $help_sections

◆ $screen_id

◆ ID_PART_COMPONENT

◆ ID_PART_SCREEN

◆ ID_PART_SUB_SCREEN