ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
interface.ilGlobalTemplateInterface.php
Go to the documentation of this file.
1<?php
17{
18
22 public function hideFooter();
23
24
36 public function setOnScreenMessage($a_type, $a_txt, $a_keep = false);
37
38
42 public function addJavaScript($a_js_file, $a_add_version_parameter = true, $a_batch = 2);
43
44
48 public function addOnLoadCode($a_code, $a_batch = 2);
49
50
56 public function getOnLoadCodeForAsynch();
57
58
62 public function resetJavascript();
63
64
65 public function fillJavaScriptFiles($a_force = false);
66
67
71 public function addCss($a_css_file, $media = "screen");
72
73
77 public function addInlineCss($a_css, $media = "screen");
78
79
80 public function setBodyClass($a_class = "");
81
82
88 public function loadStandardTemplate();
89
90
96 public function setTitle($a_title, $hidden = false);
97
98
102 public function setDescription($a_descr);
103
104
108 public function setTitleIcon($a_icon_path, $a_icon_desc = "");
109
110
118 public function setAlertProperties(array $a_props);
119
120
124 public function clearHeader();
125
126
132 public function setHeaderActionMenu($a_header);
133
134
138 public function setHeaderPageTitle($a_title);
139
140
144 public function setLocator();
145
146
150 public function setTabs($a_tabs_html);
151
152
156 public function setSubTabs($a_tabs_html);
157
158
162 public function setContent($a_html);
163
164
168 public function setLeftContent($a_html);
169
170
175
176
180 public function setRightContent($a_html);
181
182
183 public function setPageFormAction($a_action);
184
185
190 public function setLoginTargetPar($a_val);
191
192
198 public function 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);
199
200
206 public function printToStdout($part = "DEFAULT", $a_fill_tabs = true, $a_skip_main_menu = false);
207
208
214 public function printToString() : string;
215
216
223 public function setTreeFlatIcon($a_link, $a_mode);
224
225
229 public function addLightbox($a_html, $a_id);
230
231
238 public function addAdminPanelToolbar(ilToolbarGUI $toolb, $a_bottom_panel = true, $a_arrow = false);
239
240
241 public function setPermanentLink($a_type, $a_id, $a_append = "", $a_target = "", $a_title = "");
242
243
247 public function resetHeaderBlock($a_reset_header_action = true);
248
249
253 public function enableDragDropFileUpload($a_ref_id);
254
255
261 public function get($part = "DEFAULT");
262
263
264 public function setVariable($variable, $value = '');
265
266
274 public function setCurrentBlock($part = "DEFAULT");
275
276
286 public function touchBlock($block);
287
288
298 public function parseCurrentBlock($part = "DEFAULT");
299
300
313 public function addBlockFile($var, $block, $tplname, $in_module = false);
314
315
325 public function blockExists($a_blockname);
326}
An exception for terminatinating execution or to throw for unit testing.
hideFooter()
Make the template hide the footer.
fillJavaScriptFiles($a_force=false)
addLightbox($a_html, $a_id)
Add lightbox html.
printToString()
Use this method to get the finally rendered page as string.
setTabs($a_tabs_html)
sets tabs in standard template
setTitleIcon($a_icon_path, $a_icon_desc="")
set title icon
getOnLoadCodeForAsynch()
Get js onload code for ajax calls.
parseCurrentBlock($part="DEFAULT")
Überladene Funktion, die auf den aktuelle Block vorher noch ein replace ausführt.
addBlockFile($var, $block, $tplname, $in_module=false)
overwrites ITX::addBlockFile
addAdminPanelToolbar(ilToolbarGUI $toolb, $a_bottom_panel=true, $a_arrow=false)
Add admin panel commands as toolbar.
setHeaderPageTitle($a_title)
Sets the title of the page (for browser window).
setAlertProperties(array $a_props)
Set alert properties.
addJavaScript($a_js_file, $a_add_version_parameter=true, $a_batch=2)
Add a javascript file that should be included in the header.
blockExists($a_blockname)
check if block exists in actual template
setLeftContent($a_html)
Sets content of left column.
touchBlock($block)
overwrites ITX::touchBlock.
setHeaderActionMenu($a_header)
Set header action menu.
setTitle($a_title, $hidden=false)
Sets title in standard template.
setCurrentBlock($part="DEFAULT")
@access public
setLeftNavContent($a_content)
Sets content of left navigation column.
setContent($a_html)
Sets content for standard template.
setPermanentLink($a_type, $a_id, $a_append="", $a_target="", $a_title="")
setTreeFlatIcon($a_link, $a_mode)
set tree/flat icon
addInlineCss($a_css, $media="screen")
Add a css file that should be included in the header.
setRightContent($a_html)
Sets content of right column.
resetJavascript()
Reset javascript files.
setVariable($variable, $value='')
enableDragDropFileUpload($a_ref_id)
Enables the file upload into this object by dropping a file.
printToStdout($part="DEFAULT", $a_fill_tabs=true, $a_skip_main_menu=false)
addCss($a_css_file, $media="screen")
Add a css file that should be included in the header.
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)
clearHeader()
Clear header.
setLoginTargetPar($a_val)
Set target parameter for login (public sector).
setSubTabs($a_tabs_html)
sets subtabs in standard template
loadStandardTemplate()
This loads the standard template "tpl.adm_content.html" and "tpl.statusline.html" the CONTENT and STA...
setDescription($a_descr)
Sets descripton below title in standard template.
resetHeaderBlock($a_reset_header_action=true)
Reset all header properties: title, icon, description, alerts, action menu.
setLocator()
Insert locator.
setOnScreenMessage($a_type, $a_txt, $a_keep=false)
Set a message to be displayed to the user.
addOnLoadCode($a_code, $a_batch=2)
Add on load code.
$a_content
Definition: workflow.php:93
$a_type
Definition: workflow.php:92