ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilDataCollectionGlobalTemplate Class Reference
+ Inheritance diagram for ilDataCollectionGlobalTemplate:
+ Collaboration diagram for ilDataCollectionGlobalTemplate:

Public Member Functions

 __construct (string $file, bool $flag1, bool $flag2, string $in_module="", string $vars=ilGlobalTemplateInterface::DEFAULT_BLOCK, bool $plugin=false, bool $a_use_cache=true)
 
 printToString ()
 Use this method to get the finally rendered page as string. More...
 
 hideFooter ()
 Make the template hide the footer. More...
 
 setOnScreenMessage (string $type, string $a_txt, bool $a_keep=false)
 Set a message to be displayed to the user. More...
 
 addJavaScript (string $a_js_file, bool $a_add_version_parameter=true, int $a_batch=2)
 Add a javascript file that should be included in the header. More...
 
 addOnLoadCode (string $a_code, int $a_batch=2)
 Add on load code. More...
 
 getOnLoadCodeForAsynch ()
 Get js onload code for ajax calls. More...
 
 resetJavascript ()
 Reset javascript files. More...
 
 fillJavaScriptFiles (bool $a_force=false)
 Probably adds javascript files. More...
 
 addCss (string $a_css_file, string $media="screen")
 Add a css file that should be included in the header. More...
 
 addInlineCss (string $a_css, string $media="screen")
 Add a css file that should be included in the header. More...
 
 fillCssFiles (bool $a_force=false)
 Fill in the css file tags. More...
 
 setBodyClass (string $a_class="")
 Sets the body-tags class. More...
 
 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 (string $a_title, bool $hidden=false)
 Sets title in standard template. More...
 
 setDescription (string $a_descr)
 Sets description below title in standard template. More...
 
 setTitleIcon (string $a_icon_path, string $a_icon_desc="")
 set title icon More...
 
 setAlertProperties (array $alerts)
 Set alert properties. More...
 
 clearHeader ()
 Clear header. More...
 
 setHeaderActionMenu (string $a_header)
 Set header action menu. More...
 
 setHeaderPageTitle (string $a_title)
 Sets the title of the page (for browser window). More...
 
 setLocator ()
 Insert locator. More...
 
 setTabs (string $a_tabs_html)
 sets tabs in standard template More...
 
 setSubTabs (string $a_tabs_html)
 sets subtabs in standard template More...
 
 setContent (string $a_html)
 Sets content for standard template. More...
 
 setLeftContent (string $a_html)
 Sets content of left column. More...
 
 setLeftNavContent (string $a_content)
 Sets content of left navigation column. More...
 
 setRightContent (string $a_html)
 Sets content of right column. More...
 
 setPageFormAction (string $a_action)
 Sets the pages form action. More...
 
 setLoginTargetPar (string $a_val)
 Set target parameter for login (public sector). More...
 
 getSpecial (string $part=self::DEFAULT_BLOCK, bool $add_error_mess=false, bool $handle_referer=false, bool $add_ilias_footer=false, bool $add_standard_elements=false, bool $a_main_menu=true, bool $a_tabs=true)
 Renders the page with specific elements enabled. More...
 
 printToStdout (string $part=self::DEFAULT_BLOCK, bool $has_tabs=true, bool $skip_main_menu=false)
 
 setTreeFlatIcon (string $a_link, string $a_mode)
 Sets a tree or flat icon. More...
 
 addAdminPanelToolbar (ilToolbarGUI $toolbar, bool $is_bottom_panel=true, bool $has_arrow=false)
 
 setPermanentLink (string $a_type, ?int $a_id, string $a_append="", string $a_target="", string $a_title="")
 Generates and sets a permanent ilias link. More...
 
 resetHeaderBlock (bool $a_reset_header_action=true)
 Reset all header properties: title, icon, description, alerts, action menu. More...
 
 setFileUploadRefId (int $a_ref_id)
 Enables the file upload into this object by dropping a file. More...
 
 get (string $part="DEFAULT")
 
 setVariable (string $variable, $value='')
 Sets the given variable to the given value. More...
 
 setCurrentBlock (string $part="DEFAULT")
 Sets the template to the given block. More...
 
 touchBlock (string $block)
 overwrites ITX::touchBlock. More...
 
 parseCurrentBlock (string $block_name="DEFAULT")
 Parses the given block. More...
 
 addBlockFile (string $var, string $block, string $template_name, ?string $in_module=null)
 overwrites ITX::addBlockFile More...
 
 blockExists (string $block_name)
 check if block exists in actual template More...
 
- Public Member Functions inherited from ILIAS\UICore\GlobalTemplate
 hideFooter ()
 Make the template hide the footer. More...
 
 setOnScreenMessage (string $type, string $a_txt, bool $a_keep=false)
 Set a message to be displayed to the user. More...
 
 addJavaScript (string $a_js_file, bool $a_add_version_parameter=true, int $a_batch=2)
 Add a javascript file that should be included in the header. More...
 
 addOnLoadCode (string $a_code, int $a_batch=2)
 Add on load code. More...
 
 getOnLoadCodeForAsynch ()
 Get js onload code for ajax calls. More...
 
 resetJavascript ()
 Reset javascript files. More...
 
 fillJavaScriptFiles (bool $a_force=false)
 Probably adds javascript files. More...
 
 addCss (string $a_css_file, string $media="screen")
 Add a css file that should be included in the header. More...
 
 addInlineCss (string $a_css, string $media="screen")
 Add a css file that should be included in the header. More...
 
 setBodyClass (string $a_class="")
 Sets the body-tags class. More...
 
 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 (string $a_title, bool $hidden=false)
 Sets title in standard template. More...
 
 setDescription (string $a_descr)
 Sets description below title in standard template. More...
 
 setTitleIcon (string $a_icon_path, string $a_icon_desc="")
 set title icon More...
 
 setAlertProperties (array $alerts)
 Set alert properties. More...
 
 clearHeader ()
 Clear header. More...
 
 setHeaderActionMenu (string $a_header)
 Set header action menu. More...
 
 setHeaderPageTitle (string $a_title)
 Sets the title of the page (for browser window). More...
 
 setLocator ()
 Insert locator. More...
 
 setTabs (string $a_tabs_html)
 sets tabs in standard template More...
 
 setSubTabs (string $a_tabs_html)
 sets subtabs in standard template More...
 
 setContent (string $a_html)
 Sets content for standard template. More...
 
 setLeftContent (string $a_html)
 Sets content of left column. More...
 
 setLeftNavContent (string $a_content)
 Sets content of left navigation column. More...
 
 setRightContent (string $a_html)
 Sets content of right column. More...
 
 setPageFormAction (string $a_action)
 Sets the pages form action. More...
 
 setLoginTargetPar (string $a_val)
 Set target parameter for login (public sector). More...
 
 getSpecial (string $part=self::DEFAULT_BLOCK, bool $add_error_mess=false, bool $handle_referer=false, bool $add_ilias_footer=false, bool $add_standard_elements=false, bool $a_main_menu=true, bool $a_tabs=true)
 Renders the page with specific elements enabled. More...
 
 printToStdout (string $part=self::DEFAULT_BLOCK, bool $has_tabs=true, bool $skip_main_menu=false)
 
 printToString ()
 Use this method to get the finally rendered page as string. More...
 
 setTreeFlatIcon (string $a_link, string $a_mode)
 Sets a tree or flat icon. More...
 
 addAdminPanelToolbar (\ilToolbarGUI $toolbar, bool $is_bottom_panel=true, bool $has_arrow=false)
 Add admin panel commands as toolbar. More...
 
 setPermanentLink (string $a_type, ?int $a_id, string $a_append="", string $a_target="", string $a_title="")
 Generates and sets a permanent ilias link. More...
 
 resetHeaderBlock (bool $a_reset_header_action=true)
 Reset all header properties: title, icon, description, alerts, action menu. More...
 
 setFileUploadRefId (int $a_ref_id)
 Enables the file upload into this object by dropping a file. More...
 
 get (string $part=self::DEFAULT_BLOCK)
 Renders the given block and returns the html string. More...
 
 setVariable (string $variable, $value='')
 Sets the given variable to the given value. More...
 
 setCurrentBlock (string $part=self::DEFAULT_BLOCK)
 Sets the template to the given block. More...
 
 parseCurrentBlock (string $block_name=self::DEFAULT_BLOCK)
 Parses the given block. More...
 
 touchBlock (string $block)
 overwrites ITX::touchBlock. More...
 
 addBlockFile (string $var, string $block, string $template_name, ?string $in_module=null)
 overwrites ITX::addBlockFile More...
 
 blockExists (string $block_name)
 check if block exists in actual template More...
 

Protected Member Functions

 fillJavascriptFile (string $file, string $vers)
 

Protected Attributes

string $tree_flat_link = ""
 
string $page_form_action = ""
 
array $permanent_link = []
 
bool $standard_template_loaded = false
 
ilTemplate $template
 
array $on_load_code
 
string $body_class
 
string $icon_path
 
bool $enable_fileupload = null
 
string $left_content = ""
 
string $left_nav_content = ""
 
string $right_content = ""
 
string $main_content = ""
 
string $login_target_par = ""
 
string $tplIdentifier = ""
 
string $tree_flat_mode = ""
 
string $icon_desc = ""
 
ILIAS HTTP Services $http
 
ILIAS Refinery Factory $refinery
 
string $main_menu
 
string $main_menu_spacer
 
array $message = []
 
array $js_files = [0 => "assets/js/Basic.js"]
 
array $js_files_vp = ["assets/js/Basic.js" => true]
 
array $js_files_batch = ["assets/js/Basic.js" => 1]
 
array $css_files = []
 Stores CSS-files to be included. More...
 
array $inline_css = []
 Stores CSS to be included directly. More...
 
string $header_page_title = ""
 
string $title = ""
 
string $title_desc = ""
 
array $title_alerts = []
 
string $header_action
 
string $tabs_html = ""
 
string $sub_tabs_html = ""
 
ilToolbarGUI $admin_panel_commands_toolbar = null
 
bool $admin_panel_arrow = null
 
bool $admin_panel_bottom = null
 

Static Protected Attributes

static array $message_types
 

Private Member Functions

 getMainMenu ()
 
 fillMainMenu ()
 
 initHelp ()
 
 fillMessage ()
 Fill message area. More...
 
 getMessageTextForType (string $m)
 
 fillOnLoadCode ()
 Fill add on load code. More...
 
 fillBodyClass ()
 
 fillInlineCss ()
 Fill in the inline css. More...
 
 fillNewContentStyle ()
 Fill Content Style. More...
 
 fillHeader ()
 Fill header. More...
 
 getHeaderActionMenu ()
 Get header action menu. More...
 
 fillTabs ()
 
 getTabsHTML ()
 
 fillLeftNav ()
 Fill left navigation frame. More...
 
 setCenterColumnClass ()
 
 fillMainContent ()
 
 fillLeftContent ()
 
 fillRightContent ()
 
 fillToolbar ()
 
 fillContentLanguage ()
 Add current user language to meta tags. More...
 
 fillWindowTitle ()
 
 fillPageFormAction ()
 
 fillSideIcons ()
 Fill side icons (upper icon, tree icon, web folder icon) More...
 
 fillAdminPanel ()
 Put admin panel into template: More...
 

Private Attributes

ilLanguage $lng
 
ilLocatorGUI $locator
 
ilTabsGUI $tabs
 
ilToolbarGUI $toolbar
 
ilSetting $settings
 
ilComponentFactory $component_factory
 

Additional Inherited Members

- Data Fields inherited from ILIAS\UICore\GlobalTemplate
const MESSAGE_TYPE_FAILURE = 'failure'
 
const MESSAGE_TYPE_SUCCESS = "success"
 
const MESSAGE_TYPE_QUESTION = "question"
 
const MESSAGE_TYPE_INFO = "info"
 
const MESSAGE_TYPES
 
const DEFAULT_BLOCK = 'DEFAULT'
 

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilDataCollectionGlobalTemplate::__construct ( string  $file,
bool  $flag1,
bool  $flag2,
string  $in_module = "",
string  $vars = ilGlobalTemplateInterface::DEFAULT_BLOCK,
bool  $plugin = false,
bool  $a_use_cache = true 
)

Definition at line 49 of file class.ilDataCollectionGlobalTemplate.php.

57 {
58 global $DIC;
59
60 $this->setBodyClass("std");
61 $this->lng = $DIC->language();
62 $this->http = $DIC->http();
63 $this->locator = $DIC["ilLocator"];
64 $this->tabs = $DIC->tabs();
65 $this->toolbar = $DIC->toolbar();
66 $this->settings = $DIC->settings();
67 $this->component_factory = $DIC["component.factory"];
68
69 $this->template = new ilTemplate($file, $flag1, $flag2, $in_module, $vars, $plugin, $a_use_cache);
70 }
setBodyClass(string $a_class="")
Sets the body-tags class.
special template class to simplify handling of ITX/PEAR
static http()
Fetches the global http state from ILIAS.
global $DIC
Definition: shib_login.php:26

References $DIC, XapiProxy\$plugin, ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), setBodyClass(), ILIAS\Repository\settings(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

+ Here is the call graph for this function:

Member Function Documentation

◆ addAdminPanelToolbar()

ilDataCollectionGlobalTemplate::addAdminPanelToolbar ( ilToolbarGUI  $toolbar,
bool  $is_bottom_panel = true,
bool  $has_arrow = false 
)

Definition at line 1144 of file class.ilDataCollectionGlobalTemplate.php.

1148 : void {
1149 $this->admin_panel_commands_toolbar = $toolbar;
1150 $this->admin_panel_arrow = $has_arrow;
1151 $this->admin_panel_bottom = $is_bottom_panel;
1152 }

◆ addBlockFile()

ilDataCollectionGlobalTemplate::addBlockFile ( string  $var,
string  $block,
string  $template_name,
?string  $in_module = null 
)

overwrites ITX::addBlockFile

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1268 of file class.ilDataCollectionGlobalTemplate.php.

1268 : bool
1269 {
1270 return $this->template->addBlockFile($var, $block, $template_name, $in_module);
1271 }

Referenced by loadStandardTemplate().

+ Here is the caller graph for this function:

◆ addCss()

ilDataCollectionGlobalTemplate::addCss ( string  $a_css_file,
string  $media = "screen" 
)

Add a css file that should be included in the header.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 360 of file class.ilDataCollectionGlobalTemplate.php.

360 : void
361 {
362 if (!array_key_exists($a_css_file . $media, $this->css_files)) {
363 $this->css_files[$a_css_file . $media] = ["file" => $a_css_file, "media" => $media];
364 }
365 }

◆ addInlineCss()

ilDataCollectionGlobalTemplate::addInlineCss ( string  $a_css,
string  $media = "screen" 
)

Add a css file that should be included in the header.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 374 of file class.ilDataCollectionGlobalTemplate.php.

374 : void
375 {
376 $this->inline_css[] = ["css" => $a_css, "media" => $media];
377 }

◆ addJavaScript()

ilDataCollectionGlobalTemplate::addJavaScript ( string  $a_js_file,
bool  $a_add_version_parameter = true,
int  $a_batch = 2 
)

Add a javascript file that should be included in the header.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 201 of file class.ilDataCollectionGlobalTemplate.php.

201 : void
202 {
203 // three batches currently
204 if ($a_batch < 1 || $a_batch > 3) {
205 $a_batch = 2;
206 }
207
208 // ensure jquery files being loaded first
209 if (is_int(strpos($a_js_file, "components/ILIAS/jQuery"))
210 || is_int(strpos($a_js_file, "/jquery.js"))
211 || is_int(strpos($a_js_file, "/jquery-min.js"))
212 ) {
213 $a_batch = 0;
214 }
215
216 if (!in_array($a_js_file, $this->js_files)) {
217 $this->js_files[] = $a_js_file;
218 $this->js_files_vp[$a_js_file] = $a_add_version_parameter;
219 $this->js_files_batch[$a_js_file] = $a_batch;
220 }
221 }

◆ addOnLoadCode()

ilDataCollectionGlobalTemplate::addOnLoadCode ( string  $a_code,
int  $a_batch = 2 
)

Add on load code.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 226 of file class.ilDataCollectionGlobalTemplate.php.

226 : void
227 {
228 // three batches currently
229 if ($a_batch < 1 || $a_batch > 3) {
230 $a_batch = 2;
231 }
232 $this->on_load_code[$a_batch][] = $a_code;
233 }

◆ blockExists()

ilDataCollectionGlobalTemplate::blockExists ( string  $block_name)

check if block exists in actual template

Parameters
string$block_name

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1273 of file class.ilDataCollectionGlobalTemplate.php.

1273 : bool
1274 {
1275 return $this->template->blockExists($block_name);
1276 }

Referenced by fillBodyClass(), fillCssFiles(), fillInlineCss(), fillJavaScriptFiles(), fillTabs(), getTabsHTML(), setCenterColumnClass(), and setTabs().

+ Here is the caller graph for this function:

◆ clearHeader()

ilDataCollectionGlobalTemplate::clearHeader ( )

Clear header.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 522 of file class.ilDataCollectionGlobalTemplate.php.

522 : void
523 {
524 $this->setTitle("");
525 $this->setTitleIcon("");
526 $this->setDescription("");
527 $this->setAlertProperties([]);
528 }
setTitle(string $a_title, bool $hidden=false)
Sets title in standard template.
setTitleIcon(string $a_icon_path, string $a_icon_desc="")
set title icon
setAlertProperties(array $alerts)
Set alert properties.
setDescription(string $a_descr)
Sets description below title in standard template.

References setAlertProperties(), setDescription(), setTitle(), and setTitleIcon().

+ Here is the call graph for this function:

◆ fillAdminPanel()

ilDataCollectionGlobalTemplate::fillAdminPanel ( )
private

Put admin panel into template:

  • creation selector
  • admin view on/off button

Definition at line 1159 of file class.ilDataCollectionGlobalTemplate.php.

1159 : void
1160 {
1161 if ($this->admin_panel_commands_toolbar === null) {
1162 return;
1163 }
1164
1166
1167 // Add arrow if desired.
1168 if ($this->admin_panel_arrow) {
1169 $toolb->setLeadingImage(ilUtil::getImagePath("nav/arrow_upright.svg"), $this->lng->txt("actions"));
1170 }
1171
1172 $this->fillPageFormAction();
1173
1174 // Add top admin bar.
1175 $this->setCurrentBlock("adm_view_components");
1176 $this->setVariable("ADM_PANEL1", $toolb->getHTML());
1177 $this->parseCurrentBlock();
1178
1179 // Add bottom admin bar if user wants one.
1180 if ($this->admin_panel_bottom) {
1181 $this->setCurrentBlock("adm_view_components2");
1182
1183 // Replace previously set arrow image.
1184 if ($this->admin_panel_arrow) {
1185 $toolb->setLeadingImage(ilUtil::getImagePath("nav/arrow_downright.svg"), $this->lng->txt("actions"));
1186 }
1187
1188 $this->setVariable("ADM_PANEL2", $toolb->getHTML());
1189 $this->parseCurrentBlock();
1190 }
1191 }
setCurrentBlock(string $part="DEFAULT")
Sets the template to the given block.
parseCurrentBlock(string $block_name="DEFAULT")
Parses the given block.
setVariable(string $variable, $value='')
Sets the given variable to the given value.
setLeadingImage(string $a_img, string $a_alt)
static getImagePath(string $image_name, string $module_path="", string $mode="output", bool $offline=false)
get image path (for images located in a template directory)

References ilUtil\getImagePath(), ILIAS\Repository\lng(), and setVariable().

+ Here is the call graph for this function:

◆ fillBodyClass()

ilDataCollectionGlobalTemplate::fillBodyClass ( )
private

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

422 : void
423 {
424 if ($this->body_class != "" && $this->blockExists("body_class")) {
425 $this->setCurrentBlock("body_class");
426 $this->setVariable("BODY_CLASS", $this->body_class);
427 $this->parseCurrentBlock();
428 }
429 }
blockExists(string $block_name)
check if block exists in actual template

References blockExists(), parseCurrentBlock(), setCurrentBlock(), and setVariable().

+ Here is the call graph for this function:

◆ fillContentLanguage()

ilDataCollectionGlobalTemplate::fillContentLanguage ( )
private

Add current user language to meta tags.

Definition at line 841 of file class.ilDataCollectionGlobalTemplate.php.

841 : void
842 {
843 $this->setVariable('META_CONTENT_LANGUAGE', $this->lng->getContentLanguage());
844 $this->setVariable('LANGUAGE_DIRECTION', $this->lng->getTextDirection());
845 }

References ILIAS\Repository\lng(), and setVariable().

+ Here is the call graph for this function:

◆ fillCssFiles()

ilDataCollectionGlobalTemplate::fillCssFiles ( bool  $a_force = false)

Fill in the css file tags.

Parameters
bool$a_force

Definition at line 388 of file class.ilDataCollectionGlobalTemplate.php.

388 : void
389 {
390 if (!$this->blockExists("css_file")) {
391 return;
392 }
393 foreach ($this->css_files as $css) {
394 $filename = $css["file"];
395 if (strpos($filename, "?") > 0) {
396 $filename = substr($filename, 0, strpos($filename, "?"));
397 }
398 if (is_file($filename) || $a_force) {
399 $this->setCurrentBlock("css_file");
400 $this->setVariable("CSS_FILE", $css["file"]);
401 $this->setVariable("CSS_MEDIA", $css["media"]);
402 $this->parseCurrentBlock();
403 }
404 }
405 }
$filename
Definition: buildRTE.php:78

References $filename, blockExists(), parseCurrentBlock(), setCurrentBlock(), and setVariable().

+ Here is the call graph for this function:

◆ fillHeader()

ilDataCollectionGlobalTemplate::fillHeader ( )
private

Fill header.

Definition at line 557 of file class.ilDataCollectionGlobalTemplate.php.

557 : void
558 {
559 $header_tpl = new ilTemplate('tpl.il_header.html', true, true);
560
561 $header = false;
562
563 if ($this->icon_path != "") {
564 $header_tpl->setCurrentBlock("header_image");
565 if ($this->icon_desc != "") {
566 $header_tpl->setVariable("IMAGE_DESC", $this->lng->txt("icon") . " " . $this->icon_desc);
567 $header_tpl->setVariable("IMAGE_ALT", $this->lng->txt("icon") . " " . $this->icon_desc);
568 }
569
570 $header_tpl->setVariable("IMG_HEADER", $this->icon_path);
571 $header_tpl->parseCurrentBlock();
572 $header = true;
573 }
574
575 if ($this->title != "") {
576 $title = ilUtil::stripScriptHTML($this->title);
577 $header_tpl->setVariable("HEADER", $title);
578
579 $header = true;
580 }
581
582 if ($header) {
583 $header_tpl->setCurrentBlock("header_image");
584 $header_tpl->parseCurrentBlock();
585 }
586
587 if ($this->title_desc != "") {
588 $header_tpl->setCurrentBlock("header_desc");
589 $header_tpl->setVariable("H_DESCRIPTION", $this->title_desc);
590 $header_tpl->parseCurrentBlock();
591 }
592
593 $header = $this->getHeaderActionMenu();
594 if ($header) {
595 $header_tpl->setCurrentBlock("head_action_inner");
596 $header_tpl->setVariable("HEAD_ACTION", $header);
597 $header_tpl->parseCurrentBlock();
598 $header_tpl->touchBlock("head_action");
599 }
600
601 if (count($this->title_alerts)) {
602 foreach ($this->title_alerts as $alert) {
603 $header_tpl->setCurrentBlock('header_alert');
604 if (!($alert['propertyNameVisible'] === false)) {
605 $header_tpl->setVariable('H_PROP', $alert['property'] . ':');
606 }
607 $header_tpl->setVariable('H_VALUE', $alert['value']);
608 $header_tpl->parseCurrentBlock();
609 }
610 }
611
612 $this->template->setVariable("IL_HEADER", $header_tpl->get());
613 }
static stripScriptHTML(string $a_str, string $a_allow="", bool $a_rm_js=true)

References $title, getHeaderActionMenu(), ILIAS\Repository\lng(), and ilUtil\stripScriptHTML().

+ Here is the call graph for this function:

◆ fillInlineCss()

ilDataCollectionGlobalTemplate::fillInlineCss ( )
private

Fill in the inline css.

Definition at line 434 of file class.ilDataCollectionGlobalTemplate.php.

434 : void
435 {
436 if (!$this->blockExists("css_inline")) {
437 return;
438 }
439 foreach ($this->inline_css as $css) {
440 $this->setCurrentBlock("css_inline");
441 $this->setVariable("CSS_INLINE", $css["css"]);
442 $this->parseCurrentBlock();
443 }
444 }

References blockExists(), parseCurrentBlock(), setCurrentBlock(), and setVariable().

+ Here is the call graph for this function:

◆ fillJavascriptFile()

ilDataCollectionGlobalTemplate::fillJavascriptFile ( string  $file,
string  $vers 
)
protected

Definition at line 330 of file class.ilDataCollectionGlobalTemplate.php.

330 : void
331 {
332 $this->setCurrentBlock("js_file");
333 if ($this->js_files_vp[$file]) {
334 $this->setVariable("JS_FILE", ilUtil::appendUrlParameterString($file, $vers));
335 } else {
336 $this->setVariable("JS_FILE", $file);
337 }
338 $this->parseCurrentBlock();
339 }
static appendUrlParameterString(string $a_url, string $a_par, bool $xml_style=false)

References ilUtil\appendUrlParameterString(), parseCurrentBlock(), setCurrentBlock(), and setVariable().

Referenced by fillJavaScriptFiles().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillJavaScriptFiles()

ilDataCollectionGlobalTemplate::fillJavaScriptFiles ( bool  $a_force = false)

Probably adds javascript files.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 277 of file class.ilDataCollectionGlobalTemplate.php.

277 : void
278 {
279 $vers = "vers=" . str_replace([".", " "], "-", ILIAS_VERSION);
280
281 if (DEVMODE) {
282 $vers .= '-' . time();
283 }
284
285 if ($this->blockExists("js_file")) {
286 // three batches
287 for ($i = 0; $i <= 3; $i++) {
288 reset($this->js_files);
289 foreach ($this->js_files as $file) {
290 if ($this->js_files_batch[$file] == $i) {
291 if (is_file($file) || substr($file, 0, 4) == "http" || substr(
292 $file,
293 0,
294 2
295 ) == "//" || $a_force) {
296 $this->fillJavascriptFile($file, $vers);
297 } else {
298 if (substr($file, 0, 2) == './') { // #13962
299 $url_parts = parse_url($file);
300 if (is_file($url_parts['path'])) {
301 $this->fillJavascriptFile($file, $vers);
302 }
303 }
304 }
305 }
306 }
307 }
308 }
309 }
const ILIAS_VERSION

References blockExists(), fillJavascriptFile(), and ILIAS_VERSION.

+ Here is the call graph for this function:

◆ fillLeftContent()

ilDataCollectionGlobalTemplate::fillLeftContent ( )
private

Definition at line 795 of file class.ilDataCollectionGlobalTemplate.php.

795 : void
796 {
797 if (trim($this->left_content) != "") {
798 $this->setCurrentBlock("left_column");
799 $this->setVariable("LEFT_CONTENT", $this->left_content);
800 $left_col_class = (trim($this->right_content) == "")
801 ? "col-sm-3 col-sm-pull-9"
802 : "col-sm-3 col-sm-pull-6";
803 $this->setVariable("LEFT_COL_CLASS", $left_col_class);
804 $this->parseCurrentBlock();
805 }
806 }

References parseCurrentBlock(), setCurrentBlock(), and setVariable().

+ Here is the call graph for this function:

◆ fillLeftNav()

ilDataCollectionGlobalTemplate::fillLeftNav ( )
private

Fill left navigation frame.

Definition at line 736 of file class.ilDataCollectionGlobalTemplate.php.

736 : void
737 {
738 if (trim($this->left_nav_content) != "") {
739 $this->setCurrentBlock("left_nav");
740 $this->setVariable("LEFT_NAV_CONTENT", $this->left_nav_content);
741 $this->parseCurrentBlock();
742 $this->touchBlock("left_nav_space");
743 }
744 }
touchBlock(string $block)
overwrites ITX::touchBlock.

References parseCurrentBlock(), setCurrentBlock(), setVariable(), and touchBlock().

+ Here is the call graph for this function:

◆ fillMainContent()

ilDataCollectionGlobalTemplate::fillMainContent ( )
private

Definition at line 788 of file class.ilDataCollectionGlobalTemplate.php.

788 : void
789 {
790 if (trim($this->main_content) != "") {
791 $this->setVariable("ADM_CONTENT", $this->main_content);
792 }
793 }

References setVariable().

+ Here is the call graph for this function:

◆ fillMainMenu()

ilDataCollectionGlobalTemplate::fillMainMenu ( )
private

Definition at line 91 of file class.ilDataCollectionGlobalTemplate.php.

91 : void
92 {
93 }

◆ fillMessage()

ilDataCollectionGlobalTemplate::fillMessage ( )
private

Fill message area.

Definition at line 139 of file class.ilDataCollectionGlobalTemplate.php.

139 : void
140 {
141 $out = "";
142
143 foreach (self::$message_types as $m) {
144 $txt = $this->getMessageTextForType($m);
145
146 if ($txt != "") {
148 }
149
150 $request = $this->http->request();
151 $accept_header = $request->getHeaderLine('Accept');
152 if (ilSession::has($m) && ilSession::get($m) && ($accept_header !== 'application/json')) {
154 }
155 }
156
157 if ($out != "") {
158 $this->setVariable("MESSAGE", $out);
159 }
160 }
$out
Definition: buildRTE.php:24
static get(string $a_var)
static clear(string $a_var)
static has($a_var)
static getSystemMessageHTML(string $a_txt, string $a_type="info")
Get HTML for a system message.
$txt
Definition: error.php:31

References $out, $txt, ilSession\clear(), ilSession\get(), getMessageTextForType(), ilUtil\getSystemMessageHTML(), ilSession\has(), ILIAS\FileDelivery\http(), and setVariable().

Referenced by getSpecial().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillNewContentStyle()

ilDataCollectionGlobalTemplate::fillNewContentStyle ( )
private

Fill Content Style.

Definition at line 449 of file class.ilDataCollectionGlobalTemplate.php.

449 : void
450 {
451 $this->setVariable(
452 "LOCATION_NEWCONTENT_STYLESHEET_TAG",
453 '<link rel="stylesheet" type="text/css" href="' .
455 . '" />'
456 );
457 }
static getNewContentStyleSheetLocation(string $mode="output")
get full style sheet file name (path inclusive) of current user

References ilUtil\getNewContentStyleSheetLocation(), and setVariable().

+ Here is the call graph for this function:

◆ fillOnLoadCode()

ilDataCollectionGlobalTemplate::fillOnLoadCode ( )
private

Fill add on load code.

Definition at line 314 of file class.ilDataCollectionGlobalTemplate.php.

314 : void
315 {
316 for ($i = 1; $i <= 3; $i++) {
317 if (is_array($this->on_load_code[$i])) {
318 $this->setCurrentBlock("on_load_code");
319 foreach ($this->on_load_code[$i] as $code) {
320 $this->setCurrentBlock("on_load_code_inner");
321 $this->setVariable("OLCODE", $code);
322 $this->parseCurrentBlock();
323 }
324 $this->setCurrentBlock("on_load_code");
325 $this->parseCurrentBlock();
326 }
327 }
328 }

References parseCurrentBlock(), setCurrentBlock(), and setVariable().

+ Here is the call graph for this function:

◆ fillPageFormAction()

ilDataCollectionGlobalTemplate::fillPageFormAction ( )
private

Definition at line 877 of file class.ilDataCollectionGlobalTemplate.php.

877 : void
878 {
879 if ($this->page_form_action != "") {
880 $this->setCurrentBlock("page_form_start");
881 $this->setVariable("PAGE_FORM_ACTION", $this->page_form_action);
882 $this->parseCurrentBlock();
883 $this->touchBlock("page_form_end");
884 }
885 }

References parseCurrentBlock(), setCurrentBlock(), setVariable(), and touchBlock().

+ Here is the call graph for this function:

◆ fillRightContent()

ilDataCollectionGlobalTemplate::fillRightContent ( )
private

Definition at line 808 of file class.ilDataCollectionGlobalTemplate.php.

808 : void
809 {
810 if (trim($this->right_content) != "") {
811 $this->setCurrentBlock("right_column");
812 $this->setVariable("RIGHT_CONTENT", $this->right_content);
813 $this->parseCurrentBlock();
814 }
815 }

References parseCurrentBlock(), setCurrentBlock(), and setVariable().

+ Here is the call graph for this function:

◆ fillSideIcons()

ilDataCollectionGlobalTemplate::fillSideIcons ( )
private

Fill side icons (upper icon, tree icon, web folder icon)

Definition at line 1102 of file class.ilDataCollectionGlobalTemplate.php.

1102 : void
1103 {
1104 // tree/flat icon
1105 if ($this->tree_flat_link != "") {
1106 if ($this->left_nav_content != "") {
1107 $this->touchBlock("tree_lns");
1108 }
1109
1110 $this->setCurrentBlock("tree_mode");
1111 $this->setVariable("LINK_MODE", $this->tree_flat_link);
1112 if ($this->settings->get("tree_frame") == "right") {
1113 $this->setVariable("IMG_TREE", ilUtil::getImagePath("standard/icon_sidebar_on.svg"));
1114 $this->setVariable("RIGHT", "Right");
1115 } else {
1116 $this->setVariable("IMG_TREE", ilUtil::getImagePath("standard/icon_sidebar_on.svg"));
1117 }
1118 $this->setVariable("ALT_TREE", $this->lng->txt($this->tree_flat_mode . "view"));
1119 $this->setVariable("TARGET_TREE", ilFrameTargetInfo::_getFrame("MainContent"));
1120 $this->parseCurrentBlock();
1121 }
1122
1123 $this->setCurrentBlock("tree_icons");
1124 $this->parseCurrentBlock();
1125 }
static _getFrame(string $a_class)

References ilFrameTargetInfo\_getFrame(), ilUtil\getImagePath(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and setVariable().

+ Here is the call graph for this function:

◆ fillTabs()

ilDataCollectionGlobalTemplate::fillTabs ( )
private

Definition at line 677 of file class.ilDataCollectionGlobalTemplate.php.

677 : void
678 {
679 if ($this->blockExists("tabs_outer_start")) {
680 $this->touchBlock("tabs_outer_start");
681 $this->touchBlock("tabs_outer_end");
682 $this->touchBlock("tabs_inner_start");
683 $this->touchBlock("tabs_inner_end");
684
685 if ($this->tabs_html != "") {
686 $this->setVariable("TABS", $this->tabs_html);
687 }
688 $this->setVariable("SUB_TABS", $this->sub_tabs_html);
689 }
690 }

References blockExists(), setVariable(), and touchBlock().

+ Here is the call graph for this function:

◆ fillToolbar()

ilDataCollectionGlobalTemplate::fillToolbar ( )
private

Definition at line 824 of file class.ilDataCollectionGlobalTemplate.php.

824 : void
825 {
826 $thtml = $this->toolbar->getHTML();
827 if ($thtml != "") {
828 $this->setCurrentBlock("toolbar_buttons");
829 $this->setVariable("BUTTONS", $thtml);
830 $this->parseCurrentBlock();
831 }
832 }

References parseCurrentBlock(), setCurrentBlock(), setVariable(), and ILIAS\Repository\toolbar().

+ Here is the call graph for this function:

◆ fillWindowTitle()

ilDataCollectionGlobalTemplate::fillWindowTitle ( )
private

Definition at line 847 of file class.ilDataCollectionGlobalTemplate.php.

847 : void
848 {
849 if ($this->header_page_title != "") {
850 $title = ilUtil::stripScriptHTML($this->header_page_title);
851 $this->setVariable("PAGETITLE", "- " . $title);
852 }
853
854 if ($this->settings->get('short_inst_name') != "") {
855 $this->setVariable(
856 "WINDOW_TITLE",
857 $this->settings->get('short_inst_name')
858 );
859 } else {
860 $this->setVariable(
861 "WINDOW_TITLE",
862 "ILIAS"
863 );
864 }
865 }

References $title, ILIAS\Repository\settings(), setVariable(), and ilUtil\stripScriptHTML().

+ Here is the call graph for this function:

◆ get()

ilDataCollectionGlobalTemplate::get ( string  $part = "DEFAULT")
Parameters
string
Returns
string

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1243 of file class.ilDataCollectionGlobalTemplate.php.

1243 : string
1244 {
1245 return $this->template->get($part);
1246 }

◆ getHeaderActionMenu()

ilDataCollectionGlobalTemplate::getHeaderActionMenu ( )
private

Get header action menu.

Definition at line 618 of file class.ilDataCollectionGlobalTemplate.php.

618 : string
619 {
621 }

References $header_action.

Referenced by fillHeader().

+ Here is the caller graph for this function:

◆ getMainMenu()

ilDataCollectionGlobalTemplate::getMainMenu ( )
private

Definition at line 87 of file class.ilDataCollectionGlobalTemplate.php.

87 : void
88 {
89 }

◆ getMessageTextForType()

ilDataCollectionGlobalTemplate::getMessageTextForType ( string  $m)
private

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

162 : string
163 {
164 $txt = "";
165 if (ilSession::has($m) && ilSession::get($m) != "") {
166 $txt = ilSession::get($m);
167 } else {
168 if (isset($this->message[$m])) {
169 $txt = $this->message[$m];
170 }
171 }
172
173 return $txt;
174 }

References $txt, ilSession\get(), and ilSession\has().

Referenced by fillMessage().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getOnLoadCodeForAsynch()

ilDataCollectionGlobalTemplate::getOnLoadCodeForAsynch ( )

Get js onload code for ajax calls.

Returns
string

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 239 of file class.ilDataCollectionGlobalTemplate.php.

239 : string
240 {
241 $js = "";
242 for ($i = 1; $i <= 3; $i++) {
243 if (is_array($this->on_load_code[$i])) {
244 foreach ($this->on_load_code[$i] as $code) {
245 $js .= $code . "\n";
246 }
247 }
248 }
249 if ($js) {
250 return '<script type="text/javascript">' . "\n" .
251 $js .
252 '</script>' . "\n";
253 }
254
255 return '';
256 }

◆ getSpecial()

ilDataCollectionGlobalTemplate::getSpecial ( string  $part = self::DEFAULT_BLOCK,
bool  $add_error_mess = false,
bool  $handle_referer = false,
bool  $add_ilias_footer = false,
bool  $add_standard_elements = false,
bool  $a_main_menu = true,
bool  $a_tabs = true 
)

Renders the page with specific elements enabled.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 917 of file class.ilDataCollectionGlobalTemplate.php.

925 : string {
926 if ($add_error_mess) {
927 $this->fillMessage();
928 }
929
930 // set standard parts (tabs and title icon)
931 if ($add_standard_elements) {
932 if ($this->blockExists("content") && $a_tabs) {
933 // determine default screen id
934 $this->getTabsHTML();
935 }
936
937 // to get also the js files for the main menu
938 $this->getMainMenu();
939 $this->initHelp();
940
941 // these fill blocks in tpl.main.html
942 $this->fillCssFiles();
943 $this->fillInlineCss();
944 $this->fillBodyClass();
945
946 // these fill just plain placeholder variables in tpl.main.html
947 $this->setCurrentBlock();
948 $this->fillNewContentStyle();
949 $this->fillContentLanguage();
950 $this->fillWindowTitle();
951
952 // these fill blocks in tpl.adm_content.html
953 $this->fillHeader();
954 $this->fillSideIcons();
955 $this->fillLeftContent();
956 $this->fillLeftNav();
957 $this->fillRightContent();
958 $this->fillAdminPanel();
959 $this->fillToolbar();
960
961 $this->setCenterColumnClass();
962
963 // late loading of javascipr files, since operations above may add files
964 $this->fillJavaScriptFiles();
965 $this->fillOnLoadCode();
966
967 // these fill just plain placeholder variables in tpl.adm_content.html
968 if ($this->blockExists("content")) {
969 $this->setCurrentBlock("content");
970 if ($a_tabs) {
971 $this->fillTabs();
972 }
973 $this->fillMainContent();
974 if ($a_main_menu) {
975 $this->fillMainMenu();
976 }
977 $this->parseCurrentBlock();
978 }
979 }
980
981 if ($part == "DEFAULT") {
982 $html = $this->template->get();
983 } else {
984 $html = $this->template->get($part);
985 }
986
987 // save language usages as late as possible
989
990 return $html;
991 }
fillCssFiles(bool $a_force=false)
Fill in the css file tags.
fillSideIcons()
Fill side icons (upper icon, tree icon, web folder icon)
fillJavaScriptFiles(bool $a_force=false)
Probably adds javascript files.
fillContentLanguage()
Add current user language to meta tags.
static _saveUsages()
Store the collected language variable usages in the user session This should be called as late as pos...

References fillMessage().

+ Here is the call graph for this function:

◆ getTabsHTML()

ilDataCollectionGlobalTemplate::getTabsHTML ( )
private

Definition at line 692 of file class.ilDataCollectionGlobalTemplate.php.

692 : void
693 {
694 if ($this->blockExists("tabs_outer_start")) {
695 $this->sub_tabs_html = $this->tabs->getSubTabHTML();
696 $this->tabs_html = $this->tabs->getHTML(true);
697 }
698 }

References blockExists(), and ILIAS\Repository\tabs().

+ Here is the call graph for this function:

◆ hideFooter()

ilDataCollectionGlobalTemplate::hideFooter ( )

Make the template hide the footer.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 99 of file class.ilDataCollectionGlobalTemplate.php.

99 : void
100 {
101 }

◆ initHelp()

ilDataCollectionGlobalTemplate::initHelp ( )
private

Definition at line 95 of file class.ilDataCollectionGlobalTemplate.php.

95 : void
96 {
97 }

◆ loadStandardTemplate()

ilDataCollectionGlobalTemplate::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.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 468 of file class.ilDataCollectionGlobalTemplate.php.

468 : void
469 {
470 if ($this->standard_template_loaded) {
471 return;
472 }
473
474 // always load jQuery
477
478 $this->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
479 $this->addBlockFile("STATUSLINE", "statusline", "tpl.statusline.html");
480
481 $this->standard_template_loaded = true;
482 }
addBlockFile(string $var, string $block, string $template_name, ?string $in_module=null)
overwrites ITX::addBlockFile
static initjQueryUI(?ilGlobalTemplateInterface $a_tpl=null)
inits and adds the jQuery-UI JS-File to the global template (see included_components....
static initjQuery(?ilGlobalTemplateInterface $a_tpl=null)
inits and adds the jQuery JS-File to the global or a passed template

References addBlockFile(), iljQueryUtil\initjQuery(), and iljQueryUtil\initjQueryUI().

+ Here is the call graph for this function:

◆ parseCurrentBlock()

ilDataCollectionGlobalTemplate::parseCurrentBlock ( string  $block_name = "DEFAULT")

Parses the given block.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1263 of file class.ilDataCollectionGlobalTemplate.php.

1263 : bool
1264 {
1265 return $this->template->parseCurrentBlock($block_name);
1266 }

Referenced by fillBodyClass(), fillCssFiles(), fillInlineCss(), fillJavascriptFile(), fillLeftContent(), fillLeftNav(), fillOnLoadCode(), fillPageFormAction(), fillRightContent(), fillToolbar(), and setCenterColumnClass().

+ Here is the caller graph for this function:

◆ printToStdout()

ilDataCollectionGlobalTemplate::printToStdout ( string  $part = self::DEFAULT_BLOCK,
bool  $has_tabs = true,
bool  $skip_main_menu = false 
)
Parameters
bool$has_tabsif template variable {TABS} should be filled with content of ilTabs
bool$skip_main_menuif the main menu should be rendered.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 993 of file class.ilDataCollectionGlobalTemplate.php.

997 : void {
998 switch ($this->http->request()->getHeaderLine('Accept')) {
999 case 'application/json':
1000 $string = json_encode([
1001 self::MESSAGE_TYPE_SUCCESS => is_null($this->message[self::MESSAGE_TYPE_FAILURE]),
1002 'message' => '',
1003 ]);
1005 $this->http->saveResponse($this->http->response()->withBody($stream));
1006 $this->http->sendResponse();
1007 exit;
1008 default:
1009 // include yahoo dom per default
1011
1012 header('P3P: CP="CURa ADMa DEVa TAIa PSAa PSDa IVAa IVDa OUR BUS IND UNI COM NAV INT CNT STA PRE"');
1013 header("Content-type: text/html; charset=UTF-8");
1014
1015 $this->fillMessage();
1016
1017 // set standard parts (tabs and title icon)
1018 $this->fillBodyClass();
1019 if ($has_tabs) {
1020 if ($this->blockExists("content")) {
1021 // determine default screen id
1022 $this->getTabsHTML();
1023 }
1024
1025 // to get also the js files for the main menu
1026 if (!$skip_main_menu) {
1027 $this->getMainMenu();
1028 $this->initHelp();
1029 }
1030
1031 // these fill blocks in tpl.main.html
1032 $this->fillCssFiles();
1033 $this->fillInlineCss();
1034 //$this->fillJavaScriptFiles();
1035
1036 // these fill just plain placeholder variables in tpl.main.html
1037 $this->setCurrentBlock();
1038 $this->fillNewContentStyle();
1039 $this->fillContentLanguage();
1040 $this->fillWindowTitle();
1041
1042 // these fill blocks in tpl.adm_content.html
1043 $this->fillHeader();
1044 $this->fillSideIcons();
1045 $this->fillLeftContent();
1046 $this->fillLeftNav();
1047 $this->fillRightContent();
1048 $this->fillAdminPanel();
1049 $this->fillToolbar();
1050
1051 $this->setCenterColumnClass();
1052
1053 // late loading of javascipr files, since operations above may add files
1054 $this->fillJavaScriptFiles();
1055 $this->fillOnLoadCode();
1056
1057 // these fill just plain placeholder variables in tpl.adm_content.html
1058 if ($this->blockExists("content")) {
1059 $this->setCurrentBlock("content");
1060 $this->fillTabs();
1061 $this->fillMainContent();
1062 $this->fillMainMenu();
1063 $this->parseCurrentBlock();
1064 }
1065 }
1066
1067 if ($part == "DEFAULT" or is_bool($part)) {
1068 $html = $this->template->getUnmodified();
1069 } else {
1070 $html = $this->template->getUnmodified($part);
1071 }
1072
1073 // Modification of html is done inline here and can't be done
1074 // by ilTemplate, because the "phase" is template_show in this
1075 // case here.
1076 foreach ($this->component_factory->getActivePluginsInSlot("uihk") as $plugin) {
1077 $gui_class = $plugin->getUIClassInstance();
1078
1079 $resp = $gui_class->getHTML(
1080 "",
1081 "template_show",
1082 ["tpl_id" => $this->tplIdentifier, "tpl_obj" => $this, "html" => $html]
1083 );
1084
1085 if ($resp["mode"] != ilUIHookPluginGUI::KEEP) {
1086 $html = $gui_class->modifyHTML($html, $resp);
1087 }
1088 }
1089
1090 // save language usages as late as possible
1092
1093 print $html;
1094
1095 break;
1096 }
1097 }
static ofString(string $string)
Creates a new stream with an initial value.
Definition: Streams.php:41
static initDom(?ilGlobalTemplateInterface $a_main_tpl=null)
Init YUI Dom.
exit

References XapiProxy\$plugin, XapiProxy\$resp, ilObjLanguageAccess\_saveUsages(), exit, ILIAS\UI\examples\Symbol\Glyph\Header\header(), ILIAS\FileDelivery\http(), ilYuiUtil\initDom(), ilUIHookPluginGUI\KEEP, and ILIAS\Filesystem\Stream\Streams\ofString().

+ Here is the call graph for this function:

◆ printToString()

ilDataCollectionGlobalTemplate::printToString ( )

Use this method to get the finally rendered page as string.

Implements ILIAS\UICore\GlobalTemplate.

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

72 : string
73 {
74 throw new ilException('not implemented');
75 }
Base class for ILIAS Exception handling.

◆ resetHeaderBlock()

ilDataCollectionGlobalTemplate::resetHeaderBlock ( bool  $a_reset_header_action = true)

Reset all header properties: title, icon, description, alerts, action menu.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1212 of file class.ilDataCollectionGlobalTemplate.php.

1212 : void
1213 {
1214 $this->setTitle("");
1215 $this->setTitleIcon("");
1216 $this->setDescription("");
1217 $this->setAlertProperties([]);
1218 $this->setFileUploadRefId(0);
1219
1220 // see setFullscreenHeader()
1221 if ($a_reset_header_action) {
1222 $this->setHeaderActionMenu("");
1223 }
1224 }
setFileUploadRefId(int $a_ref_id)
Enables the file upload into this object by dropping a file.
setHeaderActionMenu(string $a_header)
Set header action menu.

◆ resetJavascript()

ilDataCollectionGlobalTemplate::resetJavascript ( )

Reset javascript files.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 264 of file class.ilDataCollectionGlobalTemplate.php.

264 : void
265 {
266 $this->js_files = [];
267 $this->js_files_vp = [];
268 $this->js_files_batch = [];
269 }

◆ setAlertProperties()

ilDataCollectionGlobalTemplate::setAlertProperties ( array  $alerts)

Set alert properties.

Parameters
array<int,array>$alerts

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 514 of file class.ilDataCollectionGlobalTemplate.php.

514 : void
515 {
516 $this->title_alerts = $alerts;
517 }

Referenced by clearHeader().

+ Here is the caller graph for this function:

◆ setBodyClass()

ilDataCollectionGlobalTemplate::setBodyClass ( string  $a_class = "")

Sets the body-tags class.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 417 of file class.ilDataCollectionGlobalTemplate.php.

417 : void
418 {
419 $this->body_class = $a_class;
420 }

Referenced by __construct().

+ Here is the caller graph for this function:

◆ setCenterColumnClass()

ilDataCollectionGlobalTemplate::setCenterColumnClass ( )
private

Definition at line 754 of file class.ilDataCollectionGlobalTemplate.php.

754 : void
755 {
756 if (!$this->blockExists("center_col_width")) {
757 return;
758 }
759 $center_column_class = "";
760 if (trim($this->right_content) != "" && trim($this->left_content) != "") {
761 $center_column_class = "two_side_col";
762 } else {
763 if (trim($this->right_content) != "" || trim($this->left_content) != "") {
764 $center_column_class = "one_side_col";
765 }
766 }
767
768 switch ($center_column_class) {
769 case "one_side_col":
770 $center_column_class = "col-sm-9";
771 break;
772 case "two_side_col":
773 $center_column_class = "col-sm-6";
774 break;
775 default:
776 $center_column_class = "col-sm-12";
777 break;
778 }
779 if (trim($this->left_content) != "") {
780 $center_column_class .= " col-sm-push-3";
781 }
782
783 $this->setCurrentBlock("center_col_width");
784 $this->setVariable("CENTER_COL", $center_column_class);
785 $this->parseCurrentBlock();
786 }

References blockExists(), parseCurrentBlock(), setCurrentBlock(), and setVariable().

+ Here is the call graph for this function:

◆ setContent()

ilDataCollectionGlobalTemplate::setContent ( string  $a_html)

Sets content for standard template.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 710 of file class.ilDataCollectionGlobalTemplate.php.

710 : void
711 {
712 if ($a_html != "") {
713 $this->main_content = $a_html;
714 }
715 }

◆ setCurrentBlock()

ilDataCollectionGlobalTemplate::setCurrentBlock ( string  $part = "DEFAULT")

Sets the template to the given block.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1253 of file class.ilDataCollectionGlobalTemplate.php.

1253 : bool
1254 {
1255 return $this->template->setCurrentBlock($part);
1256 }

Referenced by fillBodyClass(), fillCssFiles(), fillInlineCss(), fillJavascriptFile(), fillLeftContent(), fillLeftNav(), fillOnLoadCode(), fillPageFormAction(), fillRightContent(), fillToolbar(), and setCenterColumnClass().

+ Here is the caller graph for this function:

◆ setDescription()

ilDataCollectionGlobalTemplate::setDescription ( string  $a_descr)

Sets description below title in standard template.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 503 of file class.ilDataCollectionGlobalTemplate.php.

503 : void
504 {
505 $this->title_desc = $a_descr;
506 }

Referenced by clearHeader().

+ Here is the caller graph for this function:

◆ setFileUploadRefId()

ilDataCollectionGlobalTemplate::setFileUploadRefId ( int  $a_ref_id)

Enables the file upload into this object by dropping a file.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1229 of file class.ilDataCollectionGlobalTemplate.php.

1229 : void
1230 {
1231 $this->enable_fileupload = false;
1232 }

◆ setHeaderActionMenu()

ilDataCollectionGlobalTemplate::setHeaderActionMenu ( string  $a_header)

Set header action menu.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 539 of file class.ilDataCollectionGlobalTemplate.php.

539 : void
540 {
541 $this->header_action = $a_header;
542 }

◆ setHeaderPageTitle()

ilDataCollectionGlobalTemplate::setHeaderPageTitle ( string  $a_title)

Sets the title of the page (for browser window).

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 549 of file class.ilDataCollectionGlobalTemplate.php.

549 : void
550 {
551 $this->header_page_title = $a_title;
552 }

◆ setLeftContent()

ilDataCollectionGlobalTemplate::setLeftContent ( string  $a_html)

Sets content of left column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 720 of file class.ilDataCollectionGlobalTemplate.php.

720 : void
721 {
722 $this->left_content = $a_html;
723 }

◆ setLeftNavContent()

ilDataCollectionGlobalTemplate::setLeftNavContent ( string  $a_content)

Sets content of left navigation column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 728 of file class.ilDataCollectionGlobalTemplate.php.

728 : void
729 {
730 $this->left_nav_content = $a_content;
731 }

◆ setLocator()

ilDataCollectionGlobalTemplate::setLocator ( )

Insert locator.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 630 of file class.ilDataCollectionGlobalTemplate.php.

630 : void
631 {
632 $html = "";
633
634 include_once("./components/ILIAS/UIComponent/classes/class.ilUIHookProcessor.php");
635 $html = $this->locator->getHTML();
636 $uip = new ilUIHookProcessor(
637 "components/ILIAS/Locator",
638 "main_locator",
639 ["locator_gui" => $this->locator, "html" => $html]
640 );
641 $html = $uip->getHTML($html);
642
643 $this->setVariable("LOCATOR", $html);
644 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

References ILIAS\Repository\locator(), and setVariable().

+ Here is the call graph for this function:

◆ setLoginTargetPar()

ilDataCollectionGlobalTemplate::setLoginTargetPar ( string  $a_val)

Set target parameter for login (public sector).

This is used by the main menu

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 897 of file class.ilDataCollectionGlobalTemplate.php.

897 : void
898 {
899 $this->login_target_par = $a_val;
900 }

◆ setOnScreenMessage()

ilDataCollectionGlobalTemplate::setOnScreenMessage ( string  $type,
string  $a_txt,
bool  $a_keep = false 
)

Set a message to be displayed to the user.

Please use instead of ilUtil::sendInfo(), ilUtil::sendSuccess() and ilUtil::sendFailure().

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 124 of file class.ilDataCollectionGlobalTemplate.php.

124 : void
125 {
126 if (!in_array($type, self::$message_types) || $a_txt == "") {
127 return;
128 }
129 if (!$a_keep) {
130 $this->message[$type] = $a_txt;
131 } else {
132 ilSession::set($type, $a_txt);
133 }
134 }
static set(string $a_var, $a_val)
Set a value.

References ilSession\set().

+ Here is the call graph for this function:

◆ setPageFormAction()

ilDataCollectionGlobalTemplate::setPageFormAction ( string  $a_action)

Sets the pages form action.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 872 of file class.ilDataCollectionGlobalTemplate.php.

872 : void
873 {
874 $this->page_form_action = $a_action;
875 }

◆ setPermanentLink()

ilDataCollectionGlobalTemplate::setPermanentLink ( string  $a_type,
?int  $a_id,
string  $a_append = "",
string  $a_target = "",
string  $a_title = "" 
)

Generates and sets a permanent ilias link.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1193 of file class.ilDataCollectionGlobalTemplate.php.

1199 : void {
1200 $this->permanent_link = [
1201 "type" => $a_type,
1202 "id" => $a_id,
1203 "append" => $a_append,
1204 "target" => $a_target,
1205 "title" => $a_title,
1206 ];
1207 }

◆ setRightContent()

ilDataCollectionGlobalTemplate::setRightContent ( string  $a_html)

Sets content of right column.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 749 of file class.ilDataCollectionGlobalTemplate.php.

749 : void
750 {
751 $this->right_content = $a_html;
752 }

◆ setSubTabs()

ilDataCollectionGlobalTemplate::setSubTabs ( string  $a_tabs_html)

sets subtabs in standard template

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 672 of file class.ilDataCollectionGlobalTemplate.php.

672 : void
673 {
674 $this->setVariable("SUB_TABS", $a_tabs_html);
675 }

References setVariable().

+ Here is the call graph for this function:

◆ setTabs()

ilDataCollectionGlobalTemplate::setTabs ( string  $a_tabs_html)

sets tabs in standard template

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 658 of file class.ilDataCollectionGlobalTemplate.php.

658 : void
659 {
660 if ($a_tabs_html != "" && $this->blockExists("tabs_outer_start")) {
661 $this->touchBlock("tabs_outer_start");
662 $this->touchBlock("tabs_outer_end");
663 $this->touchBlock("tabs_inner_start");
664 $this->touchBlock("tabs_inner_end");
665 $this->setVariable("TABS", $a_tabs_html);
666 }
667 }

References blockExists(), setVariable(), and touchBlock().

+ Here is the call graph for this function:

◆ setTitle()

ilDataCollectionGlobalTemplate::setTitle ( string  $a_title,
bool  $hidden = false 
)

Sets title in standard template.

Will override the header_page_title.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 497 of file class.ilDataCollectionGlobalTemplate.php.

497 : void
498 {
499 $this->title = $a_title;
500 $this->header_page_title = $a_title;
501 }

Referenced by clearHeader().

+ Here is the caller graph for this function:

◆ setTitleIcon()

ilDataCollectionGlobalTemplate::setTitleIcon ( string  $a_icon_path,
string  $a_icon_desc = "" 
)

set title icon

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 508 of file class.ilDataCollectionGlobalTemplate.php.

508 : void
509 {
510 $this->icon_desc = $a_icon_desc;
511 $this->icon_path = $a_icon_path;
512 }

Referenced by clearHeader().

+ Here is the caller graph for this function:

◆ setTreeFlatIcon()

ilDataCollectionGlobalTemplate::setTreeFlatIcon ( string  $a_link,
string  $a_mode 
)

Sets a tree or flat icon.

Parameters
string$a_mode("tree" | "flat")

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1127 of file class.ilDataCollectionGlobalTemplate.php.

1127 : void
1128 {
1129 $this->tree_flat_link = $a_link;
1130 $this->tree_flat_mode = $a_mode;
1131 }

◆ setVariable()

ilDataCollectionGlobalTemplate::setVariable ( string  $variable,
  $value = '' 
)

Sets the given variable to the given value.

Parameters
mixed$value

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1248 of file class.ilDataCollectionGlobalTemplate.php.

1248 : void
1249 {
1250 $this->template->setVariable($variable, $value);
1251 }

Referenced by fillBodyClass(), fillContentLanguage(), fillCssFiles(), fillInlineCss(), fillJavascriptFile(), fillLeftContent(), fillLeftNav(), fillMainContent(), fillMessage(), fillNewContentStyle(), fillOnLoadCode(), fillPageFormAction(), fillRightContent(), fillTabs(), fillToolbar(), fillWindowTitle(), setCenterColumnClass(), setLocator(), setSubTabs(), and setTabs().

+ Here is the caller graph for this function:

◆ touchBlock()

ilDataCollectionGlobalTemplate::touchBlock ( string  $block)

overwrites ITX::touchBlock.

Implements ILIAS\UICore\GlobalTemplate.

Definition at line 1258 of file class.ilDataCollectionGlobalTemplate.php.

1258 : bool
1259 {
1260 return $this->template->touchBlock($block);
1261 }

Referenced by fillLeftNav(), fillPageFormAction(), fillTabs(), and setTabs().

+ Here is the caller graph for this function:

Field Documentation

◆ $admin_panel_arrow

bool ilDataCollectionGlobalTemplate::$admin_panel_arrow = null
protected

Definition at line 1141 of file class.ilDataCollectionGlobalTemplate.php.

◆ $admin_panel_bottom

bool ilDataCollectionGlobalTemplate::$admin_panel_bottom = null
protected

Definition at line 1142 of file class.ilDataCollectionGlobalTemplate.php.

◆ $admin_panel_commands_toolbar

ilToolbarGUI ilDataCollectionGlobalTemplate::$admin_panel_commands_toolbar = null
protected

Definition at line 1140 of file class.ilDataCollectionGlobalTemplate.php.

◆ $body_class

string ilDataCollectionGlobalTemplate::$body_class
protected

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

◆ $component_factory

ilComponentFactory ilDataCollectionGlobalTemplate::$component_factory
private

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

◆ $css_files

array ilDataCollectionGlobalTemplate::$css_files = []
protected

Stores CSS-files to be included.

Definition at line 351 of file class.ilDataCollectionGlobalTemplate.php.

◆ $enable_fileupload

bool ilDataCollectionGlobalTemplate::$enable_fileupload = null
protected

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

◆ $header_action

string ilDataCollectionGlobalTemplate::$header_action
protected

Definition at line 495 of file class.ilDataCollectionGlobalTemplate.php.

Referenced by getHeaderActionMenu().

◆ $header_page_title

string ilDataCollectionGlobalTemplate::$header_page_title = ""
protected

Definition at line 491 of file class.ilDataCollectionGlobalTemplate.php.

◆ $http

ILIAS HTTP Services ilDataCollectionGlobalTemplate::$http
protected

Definition at line 46 of file class.ilDataCollectionGlobalTemplate.php.

◆ $icon_desc

string ilDataCollectionGlobalTemplate::$icon_desc = ""
protected

Definition at line 45 of file class.ilDataCollectionGlobalTemplate.php.

◆ $icon_path

string ilDataCollectionGlobalTemplate::$icon_path
protected

Definition at line 36 of file class.ilDataCollectionGlobalTemplate.php.

◆ $inline_css

array ilDataCollectionGlobalTemplate::$inline_css = []
protected

Stores CSS to be included directly.

Definition at line 355 of file class.ilDataCollectionGlobalTemplate.php.

◆ $js_files

array ilDataCollectionGlobalTemplate::$js_files = [0 => "assets/js/Basic.js"]
protected

Definition at line 186 of file class.ilDataCollectionGlobalTemplate.php.

◆ $js_files_batch

array ilDataCollectionGlobalTemplate::$js_files_batch = ["assets/js/Basic.js" => 1]
protected

Definition at line 196 of file class.ilDataCollectionGlobalTemplate.php.

◆ $js_files_vp

array ilDataCollectionGlobalTemplate::$js_files_vp = ["assets/js/Basic.js" => true]
protected

Definition at line 191 of file class.ilDataCollectionGlobalTemplate.php.

◆ $left_content

string ilDataCollectionGlobalTemplate::$left_content = ""
protected

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

◆ $left_nav_content

string ilDataCollectionGlobalTemplate::$left_nav_content = ""
protected

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

◆ $lng

ilLanguage ilDataCollectionGlobalTemplate::$lng
private

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

◆ $locator

ilLocatorGUI ilDataCollectionGlobalTemplate::$locator
private

Definition at line 24 of file class.ilDataCollectionGlobalTemplate.php.

◆ $login_target_par

string ilDataCollectionGlobalTemplate::$login_target_par = ""
protected

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

◆ $main_content

string ilDataCollectionGlobalTemplate::$main_content = ""
protected

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

◆ $main_menu

string ilDataCollectionGlobalTemplate::$main_menu
protected

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

◆ $main_menu_spacer

string ilDataCollectionGlobalTemplate::$main_menu_spacer
protected

Definition at line 85 of file class.ilDataCollectionGlobalTemplate.php.

◆ $message

array ilDataCollectionGlobalTemplate::$message = []
protected

Definition at line 122 of file class.ilDataCollectionGlobalTemplate.php.

◆ $message_types

array ilDataCollectionGlobalTemplate::$message_types
staticprotected

◆ $on_load_code

array ilDataCollectionGlobalTemplate::$on_load_code
protected

Definition at line 34 of file class.ilDataCollectionGlobalTemplate.php.

◆ $page_form_action

string ilDataCollectionGlobalTemplate::$page_form_action = ""
protected

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

◆ $permanent_link

array ilDataCollectionGlobalTemplate::$permanent_link = []
protected

Definition at line 31 of file class.ilDataCollectionGlobalTemplate.php.

◆ $refinery

ILIAS Refinery Factory ilDataCollectionGlobalTemplate::$refinery
protected

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

◆ $right_content

string ilDataCollectionGlobalTemplate::$right_content = ""
protected

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

◆ $settings

ilSetting ilDataCollectionGlobalTemplate::$settings
private

Definition at line 27 of file class.ilDataCollectionGlobalTemplate.php.

◆ $standard_template_loaded

bool ilDataCollectionGlobalTemplate::$standard_template_loaded = false
protected

Definition at line 32 of file class.ilDataCollectionGlobalTemplate.php.

◆ $sub_tabs_html

string ilDataCollectionGlobalTemplate::$sub_tabs_html = ""
protected

Definition at line 653 of file class.ilDataCollectionGlobalTemplate.php.

◆ $tabs

ilTabsGUI ilDataCollectionGlobalTemplate::$tabs
private

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

◆ $tabs_html

string ilDataCollectionGlobalTemplate::$tabs_html = ""
protected

Definition at line 652 of file class.ilDataCollectionGlobalTemplate.php.

◆ $template

ilTemplate ilDataCollectionGlobalTemplate::$template
protected

Definition at line 33 of file class.ilDataCollectionGlobalTemplate.php.

◆ $title

string ilDataCollectionGlobalTemplate::$title = ""
protected

Definition at line 492 of file class.ilDataCollectionGlobalTemplate.php.

Referenced by fillHeader(), and fillWindowTitle().

◆ $title_alerts

array ilDataCollectionGlobalTemplate::$title_alerts = []
protected

Definition at line 494 of file class.ilDataCollectionGlobalTemplate.php.

◆ $title_desc

string ilDataCollectionGlobalTemplate::$title_desc = ""
protected

Definition at line 493 of file class.ilDataCollectionGlobalTemplate.php.

◆ $toolbar

ilToolbarGUI ilDataCollectionGlobalTemplate::$toolbar
private

Definition at line 26 of file class.ilDataCollectionGlobalTemplate.php.

◆ $tplIdentifier

string ilDataCollectionGlobalTemplate::$tplIdentifier = ""
protected

Definition at line 43 of file class.ilDataCollectionGlobalTemplate.php.

◆ $tree_flat_link

string ilDataCollectionGlobalTemplate::$tree_flat_link = ""
protected

Definition at line 29 of file class.ilDataCollectionGlobalTemplate.php.

◆ $tree_flat_mode

string ilDataCollectionGlobalTemplate::$tree_flat_mode = ""
protected

Definition at line 44 of file class.ilDataCollectionGlobalTemplate.php.


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