LTI\ilGlobalTemplate Class Reference
special template class to simplify handling of ITX/PEAR More...
Inheritance diagram for LTI\ilGlobalTemplate:
Collaboration diagram for LTI\ilGlobalTemplate:
Public Member Functions | |
| __construct ( $file, $flag1, $flag2, $in_module=false, $vars="DEFAULT", $plugin=false, $a_use_cache=false) | |
| constructor More... | |
| getMainMenu () | |
| Public Member Functions inherited from ilGlobalTemplate | |
| __construct ( $file, $flag1, $flag2, $in_module=false, $vars="DEFAULT", $plugin=false, $a_use_cache=true) | |
| constructor More... | |
| printToString ($part="DEFAULT") | |
| @inheritDoc More... | |
| hideFooter () | |
| Make the template hide the footer. More... | |
| setOnScreenMessage ($a_type, $a_txt, $a_keep=false) | |
| Set a message to be displayed to the user. More... | |
| addJavaScript ($a_js_file, $a_add_version_parameter=true, $a_batch=2) | |
| Add a javascript file that should be included in the header. More... | |
| addOnLoadCode ($a_code, $a_batch=2) | |
| Add on load code. More... | |
| getOnLoadCodeForAsynch () | |
| Get js onload code for ajax calls. More... | |
| resetJavascript () | |
| Reset javascript files. More... | |
| fillJavaScriptFiles ($a_force=false) | |
| fillOnLoadCode () | |
| Fill add on load code. More... | |
| addCss ($a_css_file, $media="screen") | |
| Add a css file that should be included in the header. More... | |
| addInlineCss ($a_css, $media="screen") | |
| Add a css file that should be included in the header. More... | |
| fillCssFiles ($a_force=false) | |
| Fill in the css file tags. More... | |
| setBodyClass ($a_class="") | |
| fillBodyClass () | |
| renderPage ($part, $a_fill_tabs, $a_skip_main_menu, \ILIAS\DI\Container $DIC) | |
| loadStandardTemplate () | |
| This loads the standard template "tpl.adm_content.html" and "tpl.statusline.html" the CONTENT and STATUSLINE placeholders if they are not already loaded. More... | |
| setTitle ($a_title, $hidden=false) | |
| Sets title in standard template. More... | |
| setDescription ($a_descr) | |
| Sets descripton below title in standard template. More... | |
| setTitleIcon ($a_icon_path, $a_icon_desc="") | |
| set title icon More... | |
| setAlertProperties (array $a_props) | |
| Set alert properties. More... | |
| clearHeader () | |
| Clear header. More... | |
| setHeaderActionMenu ($a_header) | |
| Set header action menu. More... | |
| setHeaderPageTitle ($a_title) | |
| Sets the title of the page (for browser window). More... | |
| setLocator () | |
| Insert locator. More... | |
| setTabs ($a_tabs_html) | |
| sets tabs in standard template More... | |
| setSubTabs ($a_tabs_html) | |
| sets subtabs in standard template More... | |
| fillTabs () | |
| setContent ($a_html) | |
| Sets content for standard template. More... | |
| setLeftContent ($a_html) | |
| Sets content of left column. More... | |
| setLeftNavContent ($a_content) | |
| Sets content of left navigation column. More... | |
| setRightContent ($a_html) | |
| Sets content of right column. More... | |
| fillContentLanguage () | |
| Add current user language to meta tags. More... | |
| fillWindowTitle () | |
| setPageFormAction ($a_action) | |
| setLoginTargetPar ($a_val) | |
| Set target parameter for login (public sector). More... | |
| getSpecial ( $part="DEFAULT", $add_error_mess=false, $handle_referer=false, $add_ilias_footer=false, $add_standard_elements=false, $a_main_menu=true, $a_tabs=true) | |
| printToStdout ($part="DEFAULT", $a_fill_tabs=true, $a_skip_main_menu=false) | |
| fillScreenReaderFocus () | |
| Accessibility focus for screen readers. More... | |
| setTreeFlatIcon ($a_link, $a_mode) | |
| set tree/flat icon More... | |
| addLightbox ($a_html, $a_id) | |
| Add lightbox html. More... | |
| addAdminPanelToolbar (ilToolbarGUI $toolb, $a_bottom_panel=true, $a_arrow=false) | |
| Add admin panel commands as toolbar. More... | |
| setPermanentLink ($a_type, $a_id, $a_append="", $a_target="", $a_title="") | |
| resetHeaderBlock ($a_reset_header_action=true) | |
| Reset all header properties: title, icon, description, alerts, action menu. More... | |
| enableDragDropFileUpload ($a_ref_id) | |
| Enables the file upload into this object by dropping a file. More... | |
| get ($part="DEFAULT") | |
| setVariable ($variable, $value='') | |
| setCurrentBlock ($part="DEFAULT") | |
| @access public More... | |
| touchBlock ($block) | |
| overwrites ITX::touchBlock. More... | |
| parseCurrentBlock ($part="DEFAULT") | |
| Überladene Funktion, die auf den aktuelle Block vorher noch ein replace ausführt @access public. More... | |
| addBlockFile ($var, $block, $tplname, $in_module=false) | |
| overwrites ITX::addBlockFile @access public More... | |
| blockExists ($a_blockname) | |
| check if block exists in actual template @access private More... | |
| getJSFiles () | |
| getCSSFiles () | |
| getInlineCSS () | |
| Public Member Functions inherited from ilGlobalTemplateInterface | |
| hideFooter () | |
| Make the template hide the footer. More... | |
| setOnScreenMessage ($a_type, $a_txt, $a_keep=false) | |
| Set a message to be displayed to the user. More... | |
| addJavaScript ($a_js_file, $a_add_version_parameter=true, $a_batch=2) | |
| Add a javascript file that should be included in the header. More... | |
| addOnLoadCode ($a_code, $a_batch=2) | |
| Add on load code. More... | |
| getOnLoadCodeForAsynch () | |
| Get js onload code for ajax calls. More... | |
| resetJavascript () | |
| Reset javascript files. More... | |
| fillJavaScriptFiles ($a_force=false) | |
| addCss ($a_css_file, $media="screen") | |
| Add a css file that should be included in the header. More... | |
| addInlineCss ($a_css, $media="screen") | |
| Add a css file that should be included in the header. More... | |
| setBodyClass ($a_class="") | |
| loadStandardTemplate () | |
| This loads the standard template "tpl.adm_content.html" and "tpl.statusline.html" the CONTENT and STATUSLINE placeholders if they are not already loaded. More... | |
| setTitle ($a_title, $hidden=false) | |
| Sets title in standard template. More... | |
| setDescription ($a_descr) | |
| Sets descripton below title in standard template. More... | |
| setTitleIcon ($a_icon_path, $a_icon_desc="") | |
| set title icon More... | |
| setAlertProperties (array $a_props) | |
| Set alert properties. More... | |
| clearHeader () | |
| Clear header. More... | |
| setHeaderActionMenu ($a_header) | |
| Set header action menu. More... | |
| setHeaderPageTitle ($a_title) | |
| Sets the title of the page (for browser window). More... | |
| setLocator () | |
| Insert locator. More... | |
| setTabs ($a_tabs_html) | |
| sets tabs in standard template More... | |
| setSubTabs ($a_tabs_html) | |
| sets subtabs in standard template More... | |
| setContent ($a_html) | |
| Sets content for standard template. More... | |
| setLeftContent ($a_html) | |
| Sets content of left column. More... | |
| setLeftNavContent ($a_content) | |
| Sets content of left navigation column. More... | |
| setRightContent ($a_html) | |
| Sets content of right column. More... | |
| setPageFormAction ($a_action) | |
| setLoginTargetPar ($a_val) | |
| Set target parameter for login (public sector). More... | |
| getSpecial ($part="DEFAULT", $add_error_mess=false, $handle_referer=false, $add_ilias_footer=false, $add_standard_elements=false, $a_main_menu=true, $a_tabs=true) | |
| printToStdout ($part="DEFAULT", $a_fill_tabs=true, $a_skip_main_menu=false) | |
| printToString () | |
| Use this method to get the finally rendered page as string. More... | |
| setTreeFlatIcon ($a_link, $a_mode) | |
| set tree/flat icon More... | |
| addLightbox ($a_html, $a_id) | |
| Add lightbox html. More... | |
| addAdminPanelToolbar (ilToolbarGUI $toolb, $a_bottom_panel=true, $a_arrow=false) | |
| Add admin panel commands as toolbar. More... | |
| setPermanentLink ($a_type, $a_id, $a_append="", $a_target="", $a_title="") | |
| resetHeaderBlock ($a_reset_header_action=true) | |
| Reset all header properties: title, icon, description, alerts, action menu. More... | |
| enableDragDropFileUpload ($a_ref_id) | |
| Enables the file upload into this object by dropping a file. More... | |
| get ($part="DEFAULT") | |
| setVariable ($variable, $value='') | |
| setCurrentBlock ($part="DEFAULT") | |
| @access public More... | |
| touchBlock ($block) | |
| overwrites ITX::touchBlock. More... | |
| parseCurrentBlock ($part="DEFAULT") | |
| Überladene Funktion, die auf den aktuelle Block vorher noch ein replace ausführt. More... | |
| addBlockFile ($var, $block, $tplname, $in_module=false) | |
| overwrites ITX::addBlockFile More... | |
| blockExists ($a_blockname) | |
| check if block exists in actual template More... | |
Additional Inherited Members | |
| Data Fields inherited from ilGlobalTemplate | |
| const | MESSAGE_TYPE_FAILURE = 'failure' |
| const | MESSAGE_TYPE_INFO = "info" |
| const | MESSAGE_TYPE_SUCCESS = "success" |
| const | MESSAGE_TYPE_QUESTION = "question" |
| Protected Member Functions inherited from ilGlobalTemplate | |
| fillJavascriptFile ($file, $vers) | |
| Protected Attributes inherited from ilGlobalTemplate | |
| $tree_flat_link = "" | |
| $page_form_action = "" | |
| $permanent_link = false | |
| $main_content = "" | |
| $lightbox = array() | |
| $standard_template_loaded = false | |
| $template | |
| $main_menu | |
| $main_menu_spacer | |
| $message = array() | |
| $js_files = array(0 => "./Services/JavaScript/js/Basic.js") | |
| $js_files_vp = array("./Services/JavaScript/js/Basic.js" => true) | |
| $js_files_batch = array("./Services/JavaScript/js/Basic.js" => 1) | |
| $css_files = array() | |
| $inline_css = array() | |
| Stores CSS to be included directly. More... | |
| $header_page_title = "" | |
| $title = "" | |
| $title_desc = "" | |
| $title_alerts = array() | |
| $header_action | |
| $tabs_html = "" | |
| $sub_tabs_html = "" | |
| $admin_panel_commands_toolbar = null | |
| $admin_panel_arrow = null | |
| $admin_panel_bottom = null | |
| Static Protected Attributes inherited from ilGlobalTemplate | |
| static | $message_types |
Detailed Description
special template class to simplify handling of ITX/PEAR
- Version
- $Id$
Definition at line 14 of file class.ilGlobalTemplate.php.
Constructor & Destructor Documentation
◆ __construct()
| LTI\ilGlobalTemplate::__construct | ( | $file, | |
| $flag1, | |||
| $flag2, | |||
$in_module = false, |
|||
$vars = "DEFAULT", |
|||
$plugin = false, |
|||
$a_use_cache = false |
|||
| ) |
constructor
- Parameters
-
string $file templatefile (mit oder ohne pfad) boolean $flag1 remove unknown variables boolean $flag2 remove empty blocks boolean $in_module should be set to true, if template file is in module subdirectory array $vars variables to replace @access public
Reimplemented from ilGlobalTemplate.
Definition at line 16 of file class.ilGlobalTemplate.php.
24 {
26 $file,
27 $flag1,
28 $flag2,
29 $in_module,
30 $vars,
31 $plugin,
32 $a_use_cache
33 );
34 }
References XapiProxy\$plugin, and ILIAS\GlobalScreen\Provider\__construct().
Here is the call graph for this function:
Member Function Documentation
◆ getMainMenu()
| LTI\ilGlobalTemplate::getMainMenu | ( | ) |
Reimplemented from ilGlobalTemplate.
Definition at line 36 of file class.ilGlobalTemplate.php.
37 {
38 global $ilMainMenu;
39 //$ilMainMenu->setLoginTargetPar($this->getLoginTargetPar());
40 $this->main_menu = $ilMainMenu->getHTML();
41 $this->main_menu_spacer = $ilMainMenu->getSpacerClass();
42 }
The documentation for this class was generated from the following file:
- Services/LTI/classes/class.ilGlobalTemplate.php
