|
ILIAS
release_8 Revision v8.24
|
Help GUI class. More...
Inheritance diagram for ilHelpGUI:
Collaboration diagram for ilHelpGUI:Public Member Functions | |
| __construct () | |
| setDefaultScreenId (string $a_part, string $a_id) | |
| setScreenId (string $a_id) | |
| setSubScreenId (string $a_id) | |
| setScreenIdComponent (string $a_comp) | |
| getScreenId () | |
| addHelpSection (string $a_help_id, int $a_level=1) | |
| hasSections () | |
| getHelpSections () | |
| setCtrlPar () | |
| executeCommand () | |
| showHelp () | |
| showPage () | |
| resetCurrentPage () | |
| getTabTooltipText (string $a_tab_id) | |
| initHelp (ilGlobalTemplateInterface $a_tpl, string $ajax_url) | |
| isHelpPageActive () | |
| deactivateTooltips () | |
| activateTooltips () | |
| getLinkXML (array $a_int_links) | |
| getLinkTargetsXML () | |
| Get XMl for Link Targets. More... | |
| search () | |
Data Fields | |
| const | ID_PART_SCREEN = "screen" |
| const | ID_PART_SUB_SCREEN = "sub_screen" |
| const | ID_PART_COMPONENT = "component" |
| array | $help_sections = array() |
| array | $def_screen_id = array() |
| array | $screen_id = array() |
Protected Member Functions | |
| replaceMenuItemTags (string $content) | |
| replaceItemTag (string $content, \ILIAS\GlobalScreen\Scope\MainMenu\Factory\isItem $item) | |
Protected Attributes | |
| StandardGUIRequest | $help_request |
| ilCtrl | $ctrl |
| ilSetting | $settings |
| ilLanguage | $lng |
| ilObjUser | $user |
| string | $screen_id_component = '' |
| ILIAS DI UIServices | $ui |
| array | $raw_menu_items = null |
Help GUI class.
Definition at line 27 of file class.ilHelpGUI.php.
| ilHelpGUI::__construct | ( | ) |
Definition at line 45 of file class.ilHelpGUI.php.
References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), ILIAS\Repository\ui(), and ILIAS\Repository\user().
Here is the call graph for this function:| ilHelpGUI::activateTooltips | ( | ) |
| ilHelpGUI::addHelpSection | ( | string | $a_help_id, |
| int | $a_level = 1 |
||
| ) |
Definition at line 109 of file class.ilHelpGUI.php.
| ilHelpGUI::deactivateTooltips | ( | ) |
Definition at line 335 of file class.ilHelpGUI.php.
References $ilUser.
| ilHelpGUI::executeCommand | ( | ) |
Definition at line 136 of file class.ilHelpGUI.php.
References ILIAS\Repository\ctrl().
Here is the call graph for this function:| ilHelpGUI::getHelpSections | ( | ) |
Definition at line 121 of file class.ilHelpGUI.php.
References ilHelpMapping\getHelpSectionsForId().
Here is the call graph for this function:| ilHelpGUI::getLinkTargetsXML | ( | ) |
Get XMl for Link Targets.
Definition at line 393 of file class.ilHelpGUI.php.
| ilHelpGUI::getLinkXML | ( | array | $a_int_links | ) |
Definition at line 349 of file class.ilHelpGUI.php.
References $target_arr, $target_id, and $type.
| ilHelpGUI::getScreenId | ( | ) |
Definition at line 84 of file class.ilHelpGUI.php.
| ilHelpGUI::getTabTooltipText | ( | string | $a_tab_id | ) |
Definition at line 282 of file class.ilHelpGUI.php.
References ilHelp\getTooltipPresentationText().
Here is the call graph for this function:| ilHelpGUI::hasSections | ( | ) |
Definition at line 116 of file class.ilHelpGUI.php.
References ilHelpMapping\hasScreenIdSections().
Here is the call graph for this function:| ilHelpGUI::initHelp | ( | ilGlobalTemplateInterface | $a_tpl, |
| string | $ajax_url | ||
| ) |
Definition at line 290 of file class.ilHelpGUI.php.
| ilHelpGUI::isHelpPageActive | ( | ) |
Definition at line 330 of file class.ilHelpGUI.php.
References ilSession\get().
Here is the call graph for this function:
|
protected |
Definition at line 477 of file class.ilHelpGUI.php.
References $path.
|
protected |
Definition at line 455 of file class.ilHelpGUI.php.
| ilHelpGUI::resetCurrentPage | ( | ) |
Definition at line 277 of file class.ilHelpGUI.php.
References ilSession\clear().
Here is the call graph for this function:| ilHelpGUI::search | ( | ) |
Definition at line 401 of file class.ilHelpGUI.php.
References $id, $lng, ilLMObject\_lookupTitle(), ilGlyphGUI\CLOSE, exit, ilGlyphGUI\get(), ilSession\get(), ilHelp\getHelpLMId(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), ilGlyphGUI\SEARCH, and ilSession\set().
Here is the call graph for this function:| ilHelpGUI::setCtrlPar | ( | ) |
Definition at line 129 of file class.ilHelpGUI.php.
References $refId.
| ilHelpGUI::setDefaultScreenId | ( | string | $a_part, |
| string | $a_id | ||
| ) |
Definition at line 62 of file class.ilHelpGUI.php.
| ilHelpGUI::setScreenId | ( | string | $a_id | ) |
Definition at line 69 of file class.ilHelpGUI.php.
| ilHelpGUI::setScreenIdComponent | ( | string | $a_comp | ) |
Definition at line 79 of file class.ilHelpGUI.php.
Referenced by ilDataCollectionUiAdapter\__construct(), ilObjCategoryGUI\assignRolesObject(), 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(), ilPortfolioRepositoryGUI\setTabs(), ilObjPortfolioTemplateGUI\setTabs(), ilDashboardGUI\setTabs(), ilObjWorkspaceFolderGUI\setTabs(), ilSkillCategoryGUI\setTabs(), ilSkillTemplateCategoryGUI\setTabs(), ilBasicSkillGUI\setTabs(), and ilBasicSkillTemplateGUI\setTabs().
Here is the caller graph for this function:| ilHelpGUI::setSubScreenId | ( | string | $a_id | ) |
Definition at line 74 of file class.ilHelpGUI.php.
| ilHelpGUI::showHelp | ( | ) |
Definition at line 142 of file class.ilHelpGUI.php.
References $lng, ilLMObject\_exists(), ilLMObject\_lookupTitle(), ilGlyphGUI\CLOSE, exit, ilAccordionGUI\FIRST_OPEN, ilGlyphGUI\get(), ilSession\get(), ilHelp\getHelpLMId(), ilHelpMapping\getHelpSectionsForId(), ilLMObject\getPagesOfChapter(), ILIAS\Repository\lng(), ilGlyphGUI\SEARCH, and ilSession\set().
Here is the call graph for this function:| ilHelpGUI::showPage | ( | ) |
Definition at line 210 of file class.ilHelpGUI.php.
References $id, $lng, ilPageUtil\_existsAndNotEmpty(), ilLMObject\_lookupTitle(), ilGlyphGUI\CLOSE, exit, ilGlyphGUI\get(), ilSession\get(), ilLegacyFormElementsUtil\prepareFormOutput(), ilSession\set(), and ILIAS\UI\Implementation\Component\withOnLoadCode().
Here is the call graph for this function:
|
protected |
Definition at line 34 of file class.ilHelpGUI.php.
| array ilHelpGUI::$def_screen_id = array() |
Definition at line 39 of file class.ilHelpGUI.php.
|
protected |
Definition at line 32 of file class.ilHelpGUI.php.
| array ilHelpGUI::$help_sections = array() |
Definition at line 38 of file class.ilHelpGUI.php.
|
protected |
Definition at line 36 of file class.ilHelpGUI.php.
|
protected |
Definition at line 43 of file class.ilHelpGUI.php.
| array ilHelpGUI::$screen_id = array() |
Definition at line 40 of file class.ilHelpGUI.php.
|
protected |
Definition at line 41 of file class.ilHelpGUI.php.
|
protected |
Definition at line 35 of file class.ilHelpGUI.php.
|
protected |
Definition at line 42 of file class.ilHelpGUI.php.
|
protected |
Definition at line 37 of file class.ilHelpGUI.php.
| const ilHelpGUI::ID_PART_COMPONENT = "component" |
Definition at line 31 of file class.ilHelpGUI.php.
| const ilHelpGUI::ID_PART_SCREEN = "screen" |
Definition at line 29 of file class.ilHelpGUI.php.
Referenced by ilObjStyleSheetGUI\createObject(), ilRepositoryGUI\executeCommand(), and ilPDSelectedItemsBlockGUI\getHTML().
| const ilHelpGUI::ID_PART_SUB_SCREEN = "sub_screen" |
Definition at line 30 of file class.ilHelpGUI.php.