ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilDataCollectionGlobalTemplate Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

+ 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)
 constructor More...
 
 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...
 
 addLightbox (string $a_html, string $a_id)
 Add a lightbox html to the template. 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="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...
 

Protected Member Functions

 fillJavascriptFile (string $file, string $vers)
 

Protected Attributes

 $tree_flat_link = ""
 
 $page_form_action = ""
 
 $permanent_link = false
 
 $lightbox = array()
 
 $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 = 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...
 
string $header_page_title = ""
 
string $title = ""
 
string $title_desc = ""
 
array $title_alerts = array()
 
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 $message_types
 

Private Member Functions

 fillFooter ()
 Fill the footer area. More...
 
 getMainMenu ()
 
 fillMainMenu ()
 
 initHelp ()
 
 fillMessage ()
 Fill message area. More...
 
 getMessageTextForType (string $m)
 
 fillOnLoadCode ()
 Fill add on load code. More...
 
 fillBodyClass ()
 
 resetCss ()
 Reset css files. More...
 
 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 ()
 
 getLoginTargetPar ()
 Get target parameter for login. More...
 
 fillSideIcons ()
 Fill side icons (upper icon, tree icon, web folder icon) More...
 
 fillLightbox ()
 Fill lightbox content. More...
 
 fillAdminPanel ()
 Put admin panel into template: More...
 
 fillPermanentLink ()
 Fill in permanent link. More...
 
 variableExists (string $a_variablename)
 

Private Attributes

bool $show_footer = true
 

Additional Inherited Members

- Data Fields inherited from ilGlobalTemplateInterface
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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Definition at line 22 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 
)

constructor

Parameters
string$filetemplatefile (mit oder ohne pfad)
bool$flag1remove unknown variables
bool$flag2remove empty blocks
bool$in_moduleshould be set to true, if template file is in module subdirectory
string$varsvariables to replace
bool$plugin
bool$a_use_cachepublic

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

References XapiProxy\$plugin, and setBodyClass().

64  {
65  $this->setBodyClass("std");
66 
67  $this->template = new ilTemplate($file, $flag1, $flag2, $in_module, $vars, $plugin, $a_use_cache);
68  }
setBodyClass(string $a_class="")
Sets the body-tags class.
+ 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 
)

Add admin panel commands as toolbar.

Parameters
bool$is_bottom_panelif the panel should be rendered at the bottom of the page as well.
bool$has_arrowif the panel should be rendered with an arrow icon.

Implements ilGlobalTemplateInterface.

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

1367  : void {
1368  $this->admin_panel_commands_toolbar = $toolbar;
1369  $this->admin_panel_arrow = $has_arrow;
1370  $this->admin_panel_bottom = $is_bottom_panel;
1371  }

◆ addBlockFile()

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

overwrites ITX::addBlockFile

Implements ilGlobalTemplateInterface.

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

Referenced by loadStandardTemplate().

1514  : bool
1515  {
1516  return $this->template->addBlockFile($var, $block, $template_name, $in_module);
1517  }
+ 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 ilGlobalTemplateInterface.

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

470  : void
471  {
472  if (!array_key_exists($a_css_file . $media, $this->css_files)) {
473  $this->css_files[$a_css_file . $media] = array("file" => $a_css_file, "media" => $media);
474  }
475  }

◆ addInlineCss()

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

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

Implements ilGlobalTemplateInterface.

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

484  : void
485  {
486  $this->inline_css[] = array("css" => $a_css, "media" => $media);
487  }

◆ 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 ilGlobalTemplateInterface.

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

304  : void
305  {
306  // three batches currently
307  if ($a_batch < 1 || $a_batch > 3) {
308  $a_batch = 2;
309  }
310 
311  // ensure jquery files being loaded first
312  if (is_int(strpos($a_js_file, "Services/jQuery"))
313  || is_int(strpos($a_js_file, "/jquery.js"))
314  || is_int(strpos($a_js_file, "/jquery-min.js"))
315  ) {
316  $a_batch = 0;
317  }
318 
319  if (!in_array($a_js_file, $this->js_files)) {
320  $this->js_files[] = $a_js_file;
321  $this->js_files_vp[$a_js_file] = $a_add_version_parameter;
322  $this->js_files_batch[$a_js_file] = $a_batch;
323  }
324  }

◆ addLightbox()

ilDataCollectionGlobalTemplate::addLightbox ( string  $a_html,
string  $a_id 
)

Add a lightbox html to the template.

Implements ilGlobalTemplateInterface.

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

1336  : void
1337  {
1338  $this->lightbox[$a_id] = $a_html;
1339  }

◆ addOnLoadCode()

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

Add on load code.

Implements ilGlobalTemplateInterface.

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

329  : void
330  {
331  // three batches currently
332  if ($a_batch < 1 || $a_batch > 3) {
333  $a_batch = 2;
334  }
335  $this->on_load_code[$a_batch][] = $a_code;
336  }

◆ blockExists()

ilDataCollectionGlobalTemplate::blockExists ( string  $block_name)

check if block exists in actual template

Parameters
string$block_name

Implements ilGlobalTemplateInterface.

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

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

1519  : bool
1520  {
1521  return $this->template->blockExists($block_name);
1522  }
+ Here is the caller graph for this function:

◆ clearHeader()

ilDataCollectionGlobalTemplate::clearHeader ( )

Clear header.

Implements ilGlobalTemplateInterface.

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

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

643  : void
644  {
645  $this->setTitle("");
646  $this->setTitleIcon("");
647  $this->setDescription("");
648  $this->setAlertProperties(array());
649  }
setAlertProperties(array $alerts)
Set alert properties.
setDescription(string $a_descr)
Sets description below title in standard template.
setTitle(string $a_title, bool $hidden=false)
Sets title in standard template.
setTitleIcon(string $a_icon_path, string $a_icon_desc="")
set title icon
+ 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 1378 of file class.ilDataCollectionGlobalTemplate.php.

References $admin_panel_commands_toolbar, $DIC, $lng, fillPageFormAction(), ilUtil\getImagePath(), parseCurrentBlock(), setCurrentBlock(), ilToolbarGUI\setLeadingImage(), and setVariable().

Referenced by getSpecial(), and printToStdout().

1378  : void
1379  {
1380  global $DIC;
1381  $lng = $DIC->language();
1382 
1383  if ($this->admin_panel_commands_toolbar === null) {
1384  return;
1385  }
1386 
1388 
1389  // Add arrow if desired.
1390  if ($this->admin_panel_arrow) {
1391  $toolb->setLeadingImage(ilUtil::getImagePath("arrow_upright.svg"), $lng->txt("actions"));
1392  }
1393 
1394  $this->fillPageFormAction();
1395 
1396  // Add top admin bar.
1397  $this->setCurrentBlock("adm_view_components");
1398  $this->setVariable("ADM_PANEL1", $toolb->getHTML());
1399  $this->parseCurrentBlock();
1400 
1401  // Add bottom admin bar if user wants one.
1402  if ($this->admin_panel_bottom) {
1403  $this->setCurrentBlock("adm_view_components2");
1404 
1405  // Replace previously set arrow image.
1406  if ($this->admin_panel_arrow) {
1407  $toolb->setLeadingImage(ilUtil::getImagePath("arrow_downright.svg"), $lng->txt("actions"));
1408  }
1409 
1410  $this->setVariable("ADM_PANEL2", $toolb->getHTML());
1411  $this->parseCurrentBlock();
1412  }
1413  }
$lng
static getImagePath(string $img, string $module_path="", string $mode="output", bool $offline=false)
get image path (for images located in a template directory)
setLeadingImage(string $a_img, string $a_alt)
setCurrentBlock(string $part="DEFAULT")
Sets the template to the given block.
parseCurrentBlock(string $block_name="DEFAULT")
Parses the given block.
global $DIC
Definition: feed.php:28
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillBodyClass()

ilDataCollectionGlobalTemplate::fillBodyClass ( )
private

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

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

Referenced by getSpecial(), and printToStdout().

532  : void
533  {
534  if ($this->body_class != "" && $this->blockExists("body_class")) {
535  $this->setCurrentBlock("body_class");
536  $this->setVariable("BODY_CLASS", $this->body_class);
537  $this->parseCurrentBlock();
538  }
539  }
setCurrentBlock(string $part="DEFAULT")
Sets the template to the given block.
parseCurrentBlock(string $block_name="DEFAULT")
Parses the given block.
blockExists(string $block_name)
check if block exists in actual template
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillContentLanguage()

ilDataCollectionGlobalTemplate::fillContentLanguage ( )
private

Add current user language to meta tags.

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

References $DIC, $lng, and setVariable().

Referenced by getSpecial(), and printToStdout().

995  : void
996  {
997  global $DIC;
998  $lng = $DIC->language();
999 
1000  if (is_object($lng)) {
1001  $this->setVariable('META_CONTENT_LANGUAGE', $lng->getContentLanguage());
1002  $this->setVariable('LANGUAGE_DIRECTION', $lng->getTextDirection());
1003  }
1004  }
$lng
global $DIC
Definition: feed.php:28
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillCssFiles()

ilDataCollectionGlobalTemplate::fillCssFiles ( bool  $a_force = false)

Fill in the css file tags.

Parameters
bool$a_force

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

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

Referenced by getSpecial(), and printToStdout().

498  : void
499  {
500  if (!$this->blockExists("css_file")) {
501  return;
502  }
503  foreach ($this->css_files as $css) {
504  $filename = $css["file"];
505  if (strpos($filename, "?") > 0) {
506  $filename = substr($filename, 0, strpos($filename, "?"));
507  }
508  if (is_file($filename) || $a_force) {
509  $this->setCurrentBlock("css_file");
510  $this->setVariable("CSS_FILE", $css["file"]);
511  $this->setVariable("CSS_MEDIA", $css["media"]);
512  $this->parseCurrentBlock();
513  }
514  }
515  }
setCurrentBlock(string $part="DEFAULT")
Sets the template to the given block.
parseCurrentBlock(string $block_name="DEFAULT")
Parses the given block.
$filename
Definition: buildRTE.php:78
blockExists(string $block_name)
check if block exists in actual template
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillFooter()

ilDataCollectionGlobalTemplate::fillFooter ( )
private

Fill the footer area.

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

References $_SERVER, $DIC, $ilDB, $ilSetting, $lng, $url, ilObjLanguageAccess\_checkTranslate(), ilLink\_getStaticLink(), ilObjLanguageAccess\_getTranslationLink(), ilObjLanguageAccess\_isPageTranslation(), ilUtil\appendUrlParameterString(), ilSystemSupportContactsGUI\getFooterLink(), ilSystemSupportContactsGUI\getFooterText(), ILIAS\FileDelivery\http(), ILIAS_VERSION, ilImprint\isActive(), ILIAS\Repository\refinery(), ilUtil\secureUrl(), and setVariable().

Referenced by getSpecial(), and printToStdout().

101  : void
102  {
103  global $DIC;
104 
105  $ilSetting = $DIC->settings();
106 
107  $lng = $DIC->language();
108 
109  $ilCtrl = $DIC->ctrl();
110  $ilDB = $DIC->database();
111 
112  if (!$this->show_footer) {
113  return;
114  }
115 
116  $ftpl = new ilTemplate("tpl.footer.html", true, true, "Services/UICore");
117 
118  $php = "";
119  if (DEVMODE) {
120  $php = ", PHP " . phpversion();
121  }
122  $ftpl->setVariable("ILIAS_VERSION", ILIAS_VERSION . $php);
123 
124  $link_items = array();
125 
126  $this->http = $DIC->http();
127  $this->refinery = $DIC->refinery();
128 
129  // imprint
130  if ($this->http->wrapper()->query()->has('record_id')) {
131  $baseClass = $this->http->wrapper()->query()->retrieve('baseClass', $this->refinery->kindlyTo()->string());
132  }
133  if ($this->http->wrapper()->post()->has('record_id')) {
134  $baseClass = $this->http->wrapper()->post()->retrieve('baseClass', $this->refinery->kindlyTo()->string());
135  }
136  if ($baseClass != "ilImprintGUI" && ilImprint::isActive()) {
137  $link_items[ilLink::_getStaticLink(0, "impr")] = array($lng->txt("imprint"), true);
138  }
139 
140  // system support contacts
141  if (($l = ilSystemSupportContactsGUI::getFooterLink()) != "") {
142  $link_items[$l] = array(ilSystemSupportContactsGUI::getFooterText(), false);
143  }
144 
145  if (DEVMODE) {
146  if (function_exists("tidy_parse_string")) {
148  $_SERVER["REQUEST_URI"],
149  "do_dev_validate=xhtml"
150  )] = array("Validate", true);
152  $_SERVER["REQUEST_URI"],
153  "do_dev_validate=accessibility"
154  )] = array("Accessibility", true);
155  }
156  }
157 
158  // output translation link
160  $link_items[ilObjLanguageAccess::_getTranslationLink()] = array($lng->txt('translation'), true);
161  }
162 
163  $cnt = 0;
164  foreach ($link_items as $url => $caption) {
165  $cnt++;
166  if ($caption[1]) {
167  $ftpl->touchBlock("blank");
168  }
169  if ($cnt < sizeof($link_items)) {
170  $ftpl->touchBlock("item_separator");
171  }
172 
173  $ftpl->setCurrentBlock("items");
174  $ftpl->setVariable("URL_ITEM", ilUtil::secureUrl($url));
175  $ftpl->setVariable("TXT_ITEM", $caption[0]);
176  $ftpl->parseCurrentBlock();
177  }
178 
179  $this->setVariable("FOOTER", $ftpl->get());
180  }
static appendUrlParameterString(string $a_url, string $a_par, bool $xml_style=false)
const ILIAS_VERSION
static _isPageTranslation()
Check if the current request is a page translation.
$lng
static secureUrl(string $url)
global $DIC
Definition: feed.php:28
static http()
Fetches the global http state from ILIAS.
static _getTranslationLink()
Get the link to translate the current page.
$_SERVER['HTTP_HOST']
Definition: raiseError.php:10
global $ilSetting
Definition: privfeed.php:17
$url
setVariable(string $variable, $value='')
Sets the given variable to the given value.
static _checkTranslate()
Permission check for translations.
static isActive()
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillHeader()

ilDataCollectionGlobalTemplate::fillHeader ( )
private

Fill header.

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

References $DIC, $icon_desc, $lng, getHeaderActionMenu(), and ilUtil\stripScriptHTML().

Referenced by getSpecial(), and printToStdout().

678  : void
679  {
680  global $DIC;
681 
682  $lng = $DIC->language();
683 
684  $header_tpl = new ilTemplate('tpl.il_header.html', true, true);
685 
686  $icon = false;
687  if ($this->icon_path != "") {
688  $icon = true;
689  $header_tpl->setCurrentBlock("header_image");
690  if ($this->icon_desc != "") {
691  $header_tpl->setVariable("IMAGE_DESC", $lng->txt("icon") . " " . $this->icon_desc);
692  $header_tpl->setVariable("IMAGE_ALT", $lng->txt("icon") . " " . $this->icon_desc);
693  }
694 
695  $header_tpl->setVariable("IMG_HEADER", $this->icon_path);
696  $header_tpl->parseCurrentBlock();
697  $header = true;
698  }
699 
700  if ($this->title != "") {
701  $title = ilUtil::stripScriptHTML($this->title);
702  $header_tpl->setVariable("HEADER", $title);
703 
704  $header = true;
705  }
706 
707  if ($header) {
708  $header_tpl->setCurrentBlock("header_image");
709  $header_tpl->parseCurrentBlock();
710  }
711 
712  if ($this->title_desc != "") {
713  $header_tpl->setCurrentBlock("header_desc");
714  $header_tpl->setVariable("H_DESCRIPTION", $this->title_desc);
715  $header_tpl->parseCurrentBlock();
716  }
717 
718  $header = $this->getHeaderActionMenu();
719  if ($header) {
720  $header_tpl->setCurrentBlock("head_action_inner");
721  $header_tpl->setVariable("HEAD_ACTION", $header);
722  $header_tpl->parseCurrentBlock();
723  $header_tpl->touchBlock("head_action");
724  }
725 
726  if (count($this->title_alerts)) {
727  foreach ($this->title_alerts as $alert) {
728  $header_tpl->setCurrentBlock('header_alert');
729  if (!($alert['propertyNameVisible'] === false)) {
730  $header_tpl->setVariable('H_PROP', $alert['property'] . ':');
731  }
732  $header_tpl->setVariable('H_VALUE', $alert['value']);
733  $header_tpl->parseCurrentBlock();
734  }
735  }
736 
737  // add file upload drop zone in header
738  if ($this->enable_fileupload !== null) {
739  $file_upload = new ilObjFileUploadDropzone(
740  $this->enable_fileupload,
741  $header_tpl->get()
742  );
743 
744  $this->template->setVariable(
745  "IL_DROPZONE_HEADER",
746  $file_upload->getDropzoneHtml()
747  );
748  } else {
749  $this->template->setVariable("IL_HEADER", $header_tpl->get());
750  }
751  }
$lng
static stripScriptHTML(string $a_str, string $a_allow="", bool $a_rm_js=true)
global $DIC
Definition: feed.php:28
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillInlineCss()

ilDataCollectionGlobalTemplate::fillInlineCss ( )
private

Fill in the inline css.

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

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

Referenced by getSpecial(), and printToStdout().

552  : void
553  {
554  if (!$this->blockExists("css_inline")) {
555  return;
556  }
557  foreach ($this->inline_css as $css) {
558  $this->setCurrentBlock("css_inline");
559  $this->setVariable("CSS_INLINE", $css["css"]);
560  $this->parseCurrentBlock();
561  }
562  }
setCurrentBlock(string $part="DEFAULT")
Sets the template to the given block.
parseCurrentBlock(string $block_name="DEFAULT")
Parses the given block.
blockExists(string $block_name)
check if block exists in actual template
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillJavascriptFile()

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

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

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

Referenced by fillJavaScriptFiles().

438  : void
439  {
440  $this->setCurrentBlock("js_file");
441  if ($this->js_files_vp[$file]) {
442  $this->setVariable("JS_FILE", ilUtil::appendUrlParameterString($file, $vers));
443  } else {
444  $this->setVariable("JS_FILE", $file);
445  }
446  $this->parseCurrentBlock();
447  }
static appendUrlParameterString(string $a_url, string $a_par, bool $xml_style=false)
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.
+ 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 ilGlobalTemplateInterface.

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

References $DIC, $i, $ilSetting, blockExists(), fillJavascriptFile(), and ILIAS_VERSION.

Referenced by getSpecial(), and printToStdout().

380  : void
381  {
382  global $DIC;
383 
384  $ilSetting = $DIC->settings();
385 
386  if (is_object($ilSetting)) { // maybe this one can be removed
387  $vers = "vers=" . str_replace(array(".", " "), "-", ILIAS_VERSION);
388 
389  if (DEVMODE) {
390  $vers .= '-' . time();
391  }
392  }
393  if ($this->blockExists("js_file")) {
394  // three batches
395  for ($i = 0; $i <= 3; $i++) {
396  reset($this->js_files);
397  foreach ($this->js_files as $file) {
398  if ($this->js_files_batch[$file] == $i) {
399  if (is_file($file) || substr($file, 0, 4) == "http" || substr(
400  $file,
401  0,
402  2
403  ) == "//" || $a_force) {
404  $this->fillJavascriptFile($file, $vers);
405  } else {
406  if (substr($file, 0, 2) == './') { // #13962
407  $url_parts = parse_url($file);
408  if (is_file($url_parts['path'])) {
409  $this->fillJavascriptFile($file, $vers);
410  }
411  }
412  }
413  }
414  }
415  }
416  }
417  }
const ILIAS_VERSION
global $DIC
Definition: feed.php:28
global $ilSetting
Definition: privfeed.php:17
blockExists(string $block_name)
check if block exists in actual template
$i
Definition: metadata.php:41
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillLeftContent()

ilDataCollectionGlobalTemplate::fillLeftContent ( )
private

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

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

Referenced by getSpecial(), and printToStdout().

945  : void
946  {
947  if (trim($this->left_content) != "") {
948  $this->setCurrentBlock("left_column");
949  $this->setVariable("LEFT_CONTENT", $this->left_content);
950  $left_col_class = (trim($this->right_content) == "")
951  ? "col-sm-3 col-sm-pull-9"
952  : "col-sm-3 col-sm-pull-6";
953  $this->setVariable("LEFT_COL_CLASS", $left_col_class);
954  $this->parseCurrentBlock();
955  }
956  }
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.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillLeftNav()

ilDataCollectionGlobalTemplate::fillLeftNav ( )
private

Fill left navigation frame.

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

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

Referenced by getSpecial(), and printToStdout().

886  : void
887  {
888  if (trim($this->left_nav_content) != "") {
889  $this->setCurrentBlock("left_nav");
890  $this->setVariable("LEFT_NAV_CONTENT", $this->left_nav_content);
891  $this->parseCurrentBlock();
892  $this->touchBlock("left_nav_space");
893  }
894  }
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.
touchBlock(string $block)
overwrites ITX::touchBlock.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillLightbox()

ilDataCollectionGlobalTemplate::fillLightbox ( )
private

Fill lightbox content.

Parameters

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

References setVariable().

Referenced by getSpecial(), and printToStdout().

1346  : void
1347  {
1348  $html = implode('', $this->lightbox);
1349  $this->setVariable("LIGHTBOX", $html);
1350  }
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillMainContent()

ilDataCollectionGlobalTemplate::fillMainContent ( )
private

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

References setVariable().

Referenced by getSpecial(), and printToStdout().

938  : void
939  {
940  if (trim($this->main_content) != "") {
941  $this->setVariable("ADM_CONTENT", $this->main_content);
942  }
943  }
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillMainMenu()

ilDataCollectionGlobalTemplate::fillMainMenu ( )
private

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

Referenced by getSpecial(), and printToStdout().

196  : void
197  {
198  }
+ Here is the caller graph for this function:

◆ fillMessage()

ilDataCollectionGlobalTemplate::fillMessage ( )
private

Fill message area.

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

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

Referenced by getSpecial(), and printToStdout().

240  : void
241  {
242  global $DIC;
243 
244  $out = "";
245 
246  foreach (self::$message_types as $m) {
247  $txt = $this->getMessageTextForType($m);
248 
249  if ($txt != "") {
251  }
252 
253  $request = $DIC->http()->request();
254  $accept_header = $request->getHeaderLine('Accept');
255  if (ilSession::has($m) && ilSession::get($m) && ($accept_header !== 'application/json')) {
256  ilSession::clear($m);
257  }
258  }
259 
260  if ($out != "") {
261  $this->setVariable("MESSAGE", $out);
262  }
263  }
static get(string $a_var)
static getSystemMessageHTML(string $a_txt, string $a_type="info")
Get HTML for a system message.
global $DIC
Definition: feed.php:28
$out
Definition: buildRTE.php:24
static has($a_var)
$txt
Definition: error.php:13
setVariable(string $variable, $value='')
Sets the given variable to the given value.
static clear(string $a_var)
+ 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 567 of file class.ilDataCollectionGlobalTemplate.php.

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

Referenced by getSpecial(), and printToStdout().

567  : void
568  {
569  $this->setVariable(
570  "LOCATION_NEWCONTENT_STYLESHEET_TAG",
571  '<link rel="stylesheet" type="text/css" href="' .
573  . '" />'
574  );
575  }
static getNewContentStyleSheetLocation(string $mode="output")
get full style sheet file name (path inclusive) of current user
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillOnLoadCode()

ilDataCollectionGlobalTemplate::fillOnLoadCode ( )
private

Fill add on load code.

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

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

Referenced by getSpecial(), and printToStdout().

422  : void
423  {
424  for ($i = 1; $i <= 3; $i++) {
425  if (is_array($this->on_load_code[$i])) {
426  $this->setCurrentBlock("on_load_code");
427  foreach ($this->on_load_code[$i] as $code) {
428  $this->setCurrentBlock("on_load_code_inner");
429  $this->setVariable("OLCODE", $code);
430  $this->parseCurrentBlock();
431  }
432  $this->setCurrentBlock("on_load_code");
433  $this->parseCurrentBlock();
434  }
435  }
436  }
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.
$i
Definition: metadata.php:41
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillPageFormAction()

ilDataCollectionGlobalTemplate::fillPageFormAction ( )
private

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

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

Referenced by fillAdminPanel().

1040  : void
1041  {
1042  if ($this->page_form_action != "") {
1043  $this->setCurrentBlock("page_form_start");
1044  $this->setVariable("PAGE_FORM_ACTION", $this->page_form_action);
1045  $this->parseCurrentBlock();
1046  $this->touchBlock("page_form_end");
1047  }
1048  }
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.
touchBlock(string $block)
overwrites ITX::touchBlock.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillPermanentLink()

ilDataCollectionGlobalTemplate::fillPermanentLink ( )
private

Fill in permanent link.

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

References setVariable().

Referenced by getSpecial(), and printToStdout().

1434  : void
1435  {
1436  if (is_array($this->permanent_link)) {
1437  $plinkgui = new ilPermanentLinkGUI(
1438  $this->permanent_link["type"],
1439  $this->permanent_link["id"],
1440  $this->permanent_link["append"],
1441  $this->permanent_link["target"]
1442  );
1443  if ($this->permanent_link["title"] != "") {
1444  $plinkgui->setTitle($this->permanent_link["title"]);
1445  }
1446  $this->setVariable("PRMLINK", $plinkgui->getHTML());
1447  }
1448  }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillRightContent()

ilDataCollectionGlobalTemplate::fillRightContent ( )
private

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

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

Referenced by getSpecial(), and printToStdout().

958  : void
959  {
960  if (trim($this->right_content) != "") {
961  $this->setCurrentBlock("right_column");
962  $this->setVariable("RIGHT_CONTENT", $this->right_content);
963  $this->parseCurrentBlock();
964  }
965  }
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.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillSideIcons()

ilDataCollectionGlobalTemplate::fillSideIcons ( )
private

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

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

References $DIC, $ilSetting, $lng, ilFrameTargetInfo\_getFrame(), ilUtil\getImagePath(), parseCurrentBlock(), setCurrentBlock(), setVariable(), and touchBlock().

Referenced by getSpecial(), and printToStdout().

1290  : void
1291  {
1292  global $DIC;
1293 
1294  $ilSetting = $DIC->settings();
1295 
1296  $lng = $DIC->language();
1297 
1298  // tree/flat icon
1299  if ($this->tree_flat_link != "") {
1300  if ($this->left_nav_content != "") {
1301  $this->touchBlock("tree_lns");
1302  }
1303 
1304  $this->setCurrentBlock("tree_mode");
1305  $this->setVariable("LINK_MODE", $this->tree_flat_link);
1306  if ($ilSetting->get("tree_frame") == "right") {
1307  if ($this->tree_flat_mode === "tree") {
1308  $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
1309  $this->setVariable("RIGHT", "Right");
1310  } else {
1311  $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
1312  $this->setVariable("RIGHT", "Right");
1313  }
1314  } else {
1315  if ($this->tree_flat_mode == "tree") {
1316  $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
1317  } else {
1318  $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
1319  }
1320  }
1321  $this->setVariable("ALT_TREE", $lng->txt($this->tree_flat_mode . "view"));
1322  $this->setVariable("TARGET_TREE", ilFrameTargetInfo::_getFrame("MainContent"));
1323  $this->parseCurrentBlock();
1324  }
1325 
1326  $this->setCurrentBlock("tree_icons");
1327  $this->parseCurrentBlock();
1328  }
$lng
static getImagePath(string $img, string $module_path="", string $mode="output", bool $offline=false)
get image path (for images located in a template directory)
setCurrentBlock(string $part="DEFAULT")
Sets the template to the given block.
parseCurrentBlock(string $block_name="DEFAULT")
Parses the given block.
global $DIC
Definition: feed.php:28
global $ilSetting
Definition: privfeed.php:17
setVariable(string $variable, $value='')
Sets the given variable to the given value.
static _getFrame(string $a_class)
touchBlock(string $block)
overwrites ITX::touchBlock.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillTabs()

ilDataCollectionGlobalTemplate::fillTabs ( )
private

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

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

Referenced by getSpecial(), and printToStdout().

823  : void
824  {
825  if ($this->blockExists("tabs_outer_start")) {
826  $this->touchBlock("tabs_outer_start");
827  $this->touchBlock("tabs_outer_end");
828  $this->touchBlock("tabs_inner_start");
829  $this->touchBlock("tabs_inner_end");
830 
831  if ($this->tabs_html != "") {
832  $this->setVariable("TABS", $this->tabs_html);
833  }
834  $this->setVariable("SUB_TABS", $this->sub_tabs_html);
835  }
836  }
blockExists(string $block_name)
check if block exists in actual template
setVariable(string $variable, $value='')
Sets the given variable to the given value.
touchBlock(string $block)
overwrites ITX::touchBlock.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillToolbar()

ilDataCollectionGlobalTemplate::fillToolbar ( )
private

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

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

Referenced by getSpecial(), and printToStdout().

974  : void
975  {
976  global $DIC;
977 
978  $ilToolbar = $DIC["ilToolbar"];
979 
980  $thtml = $ilToolbar->getHTML();
981  if ($thtml != "") {
982  $this->setCurrentBlock("toolbar_buttons");
983  $this->setVariable("BUTTONS", $thtml);
984  $this->parseCurrentBlock();
985  }
986  }
setCurrentBlock(string $part="DEFAULT")
Sets the template to the given block.
parseCurrentBlock(string $block_name="DEFAULT")
Parses the given block.
global $DIC
Definition: feed.php:28
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillWindowTitle()

ilDataCollectionGlobalTemplate::fillWindowTitle ( )
private

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

References $DIC, $ilSetting, setVariable(), and ilUtil\stripScriptHTML().

Referenced by getSpecial(), and printToStdout().

1006  : void
1007  {
1008  global $DIC;
1009 
1010  $ilSetting = $DIC->settings();
1011 
1012  if ($this->header_page_title != "") {
1013  $title = ilUtil::stripScriptHTML($this->header_page_title);
1014  $this->setVariable("PAGETITLE", "- " . $title);
1015  }
1016 
1017  if ($ilSetting->get('short_inst_name') != "") {
1018  $this->setVariable(
1019  "WINDOW_TITLE",
1020  $ilSetting->get('short_inst_name')
1021  );
1022  } else {
1023  $this->setVariable(
1024  "WINDOW_TITLE",
1025  "ILIAS"
1026  );
1027  }
1028  }
static stripScriptHTML(string $a_str, string $a_allow="", bool $a_rm_js=true)
global $DIC
Definition: feed.php:28
global $ilSetting
Definition: privfeed.php:17
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ get()

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

Implements ilGlobalTemplateInterface.

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

1484  : string
1485  {
1486  return $this->template->get($part);
1487  }

◆ getHeaderActionMenu()

ilDataCollectionGlobalTemplate::getHeaderActionMenu ( )
private

Get header action menu.

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

References $header_action.

Referenced by fillHeader().

756  : string
757  {
758  return $this->header_action;
759  }
+ Here is the caller graph for this function:

◆ getLoginTargetPar()

ilDataCollectionGlobalTemplate::getLoginTargetPar ( )
private

Get target parameter for login.

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

References $login_target_par.

1068  : string
1069  {
1070  return $this->login_target_par;
1071  }

◆ getMainMenu()

ilDataCollectionGlobalTemplate::getMainMenu ( )
private

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

Referenced by getSpecial(), and printToStdout().

192  : void
193  {
194  }
+ Here is the caller graph for this function:

◆ getMessageTextForType()

ilDataCollectionGlobalTemplate::getMessageTextForType ( string  $m)
private

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

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

Referenced by fillMessage().

265  : string
266  {
267  $txt = "";
268  if (ilSession::has($m) && ilSession::get($m) != "") {
269  $txt = ilSession::get($m);
270  } else {
271  if (isset($this->message[$m])) {
272  $txt = $this->message[$m];
273  }
274  }
275 
276  return $txt;
277  }
static get(string $a_var)
static has($a_var)
$txt
Definition: error.php:13
+ 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 ilGlobalTemplateInterface.

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

References $i.

342  : string
343  {
344  $js = "";
345  for ($i = 1; $i <= 3; $i++) {
346  if (is_array($this->on_load_code[$i])) {
347  foreach ($this->on_load_code[$i] as $code) {
348  $js .= $code . "\n";
349  }
350  }
351  }
352  if ($js) {
353  return '<script type="text/javascript">' . "\n" .
354  $js .
355  '</script>' . "\n";
356  }
357 
358  return '';
359  }
$i
Definition: metadata.php:41

◆ 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 ilGlobalTemplateInterface.

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

References ilObjLanguageAccess\_saveUsages(), blockExists(), fillAdminPanel(), fillBodyClass(), fillContentLanguage(), fillCssFiles(), fillFooter(), fillHeader(), fillInlineCss(), fillJavaScriptFiles(), fillLeftContent(), fillLeftNav(), fillLightbox(), fillMainContent(), fillMainMenu(), fillMessage(), fillNewContentStyle(), fillOnLoadCode(), fillPermanentLink(), fillRightContent(), fillSideIcons(), fillTabs(), fillToolbar(), fillWindowTitle(), getMainMenu(), getTabsHTML(), initHelp(), parseCurrentBlock(), setCenterColumnClass(), and setCurrentBlock().

1096  : string {
1097  if ($add_error_mess) {
1098  $this->fillMessage();
1099  }
1100 
1101  if ($add_ilias_footer) {
1102  $this->fillFooter();
1103  }
1104 
1105  // set standard parts (tabs and title icon)
1106  if ($add_standard_elements) {
1107  if ($this->blockExists("content") && $a_tabs) {
1108  // determine default screen id
1109  $this->getTabsHTML();
1110  }
1111 
1112  // to get also the js files for the main menu
1113  $this->getMainMenu();
1114  $this->initHelp();
1115 
1116  // these fill blocks in tpl.main.html
1117  $this->fillCssFiles();
1118  $this->fillInlineCss();
1119  $this->fillBodyClass();
1120 
1121  // these fill just plain placeholder variables in tpl.main.html
1122  $this->setCurrentBlock("DEFAULT");
1123  $this->fillNewContentStyle();
1124  $this->fillContentLanguage();
1125  $this->fillWindowTitle();
1126 
1127  // these fill blocks in tpl.adm_content.html
1128  $this->fillHeader();
1129  $this->fillSideIcons();
1130  $this->fillLeftContent();
1131  $this->fillLeftNav();
1132  $this->fillRightContent();
1133  $this->fillAdminPanel();
1134  $this->fillToolbar();
1135  $this->fillPermanentLink();
1136 
1137  $this->setCenterColumnClass();
1138 
1139  // late loading of javascipr files, since operations above may add files
1140  $this->fillJavaScriptFiles();
1141  $this->fillOnLoadCode();
1142 
1143  // these fill just plain placeholder variables in tpl.adm_content.html
1144  if ($this->blockExists("content")) {
1145  $this->setCurrentBlock("content");
1146  if ($a_tabs) {
1147  $this->fillTabs();
1148  }
1149  $this->fillMainContent();
1150  if ($a_main_menu) {
1151  $this->fillMainMenu();
1152  }
1153  $this->fillLightbox();
1154  $this->parseCurrentBlock();
1155  }
1156  }
1157 
1158  if ($part == "DEFAULT") {
1159  $html = $this->template->get();
1160  } else {
1161  $html = $this->template->get($part);
1162  }
1163 
1164  // save language usages as late as possible
1166 
1167  return $html;
1168  }
setCurrentBlock(string $part="DEFAULT")
Sets the template to the given block.
fillJavaScriptFiles(bool $a_force=false)
Probably adds javascript files.
parseCurrentBlock(string $block_name="DEFAULT")
Parses the given block.
fillSideIcons()
Fill side icons (upper icon, tree icon, web folder icon)
fillCssFiles(bool $a_force=false)
Fill in the css file tags.
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...
blockExists(string $block_name)
check if block exists in actual template
+ Here is the call graph for this function:

◆ getTabsHTML()

ilDataCollectionGlobalTemplate::getTabsHTML ( )
private

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

References $DIC, and blockExists().

Referenced by getSpecial(), and printToStdout().

838  : void
839  {
840  global $DIC;
841 
842  $ilTabs = $DIC["ilTabs"];
843 
844  if ($this->blockExists("tabs_outer_start")) {
845  $this->sub_tabs_html = $ilTabs->getSubTabHTML();
846  $this->tabs_html = $ilTabs->getHTML(true);
847  }
848  }
global $DIC
Definition: feed.php:28
blockExists(string $block_name)
check if block exists in actual template
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ hideFooter()

ilDataCollectionGlobalTemplate::hideFooter ( )

Make the template hide the footer.

Implements ilGlobalTemplateInterface.

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

93  : void
94  {
95  $this->show_footer = false;
96  }

◆ initHelp()

ilDataCollectionGlobalTemplate::initHelp ( )
private

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

References $message_types.

Referenced by getSpecial(), and printToStdout().

200  : void
201  {
202  }
+ Here is the caller graph for this function:

◆ 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 ilGlobalTemplateInterface.

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

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

586  : void
587  {
588  if ($this->standard_template_loaded) {
589  return;
590  }
591 
592  // always load jQuery
595 
596  // always load ui framework
598 
599  $this->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
600  $this->addBlockFile("STATUSLINE", "statusline", "tpl.statusline.html");
601 
602  $this->standard_template_loaded = true;
603  }
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.txt for included components)
static init(ilGlobalTemplateInterface $template=null)
static initjQuery(ilGlobalTemplateInterface $a_tpl=null)
inits and adds the jQuery JS-File to the global or a passed template
+ Here is the call graph for this function:

◆ parseCurrentBlock()

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

Parses the given block.

Implements ilGlobalTemplateInterface.

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

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

1509  : bool
1510  {
1511  return $this->template->parseCurrentBlock($block_name);
1512  }
+ 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 ilGlobalTemplateInterface.

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

References $DIC, XapiProxy\$plugin, XapiProxy\$resp, ilObjLanguageAccess\_saveUsages(), blockExists(), exit, fillAdminPanel(), fillBodyClass(), fillContentLanguage(), fillCssFiles(), fillFooter(), fillHeader(), fillInlineCss(), fillJavaScriptFiles(), fillLeftContent(), fillLeftNav(), fillLightbox(), fillMainContent(), fillMainMenu(), fillMessage(), fillNewContentStyle(), fillOnLoadCode(), fillPermanentLink(), fillRightContent(), fillSideIcons(), fillTabs(), fillToolbar(), fillWindowTitle(), getMainMenu(), getTabsHTML(), ilYuiUtil\initDom(), initHelp(), ilUIHookPluginGUI\KEEP, ILIAS\Filesystem\Stream\Streams\ofString(), parseCurrentBlock(), setCenterColumnClass(), and setCurrentBlock().

1174  : void {
1175  global $DIC;
1176 
1177  $http = $DIC->http();
1178  switch ($http->request()->getHeaderLine('Accept')) {
1179  case 'application/json':
1180  $string = json_encode([
1181  self::MESSAGE_TYPE_SUCCESS => is_null($this->message[self::MESSAGE_TYPE_FAILURE]),
1182  'message' => '',
1183  ]);
1184  $stream = \ILIAS\Filesystem\Stream\Streams::ofString($string);
1185  $http->saveResponse($http->response()->withBody($stream));
1186  $http->sendResponse();
1187  exit;
1188  default:
1189  // include yahoo dom per default
1191 
1192  header('P3P: CP="CURa ADMa DEVa TAIa PSAa PSDa IVAa IVDa OUR BUS IND UNI COM NAV INT CNT STA PRE"');
1193  header("Content-type: text/html; charset=UTF-8");
1194 
1195  $this->fillMessage();
1196 
1197  // display ILIAS footer
1198  if ($part !== false) {
1199  $this->fillFooter();
1200  }
1201 
1202  // set standard parts (tabs and title icon)
1203  $this->fillBodyClass();
1204  if ($has_tabs) {
1205  if ($this->blockExists("content")) {
1206  // determine default screen id
1207  $this->getTabsHTML();
1208  }
1209 
1210  // to get also the js files for the main menu
1211  if (!$skip_main_menu) {
1212  $this->getMainMenu();
1213  $this->initHelp();
1214  }
1215 
1216  // these fill blocks in tpl.main.html
1217  $this->fillCssFiles();
1218  $this->fillInlineCss();
1219  //$this->fillJavaScriptFiles();
1220 
1221  // these fill just plain placeholder variables in tpl.main.html
1222  $this->setCurrentBlock("DEFAULT");
1223  $this->fillNewContentStyle();
1224  $this->fillContentLanguage();
1225  $this->fillWindowTitle();
1226 
1227  // these fill blocks in tpl.adm_content.html
1228  $this->fillHeader();
1229  $this->fillSideIcons();
1230  $this->fillLeftContent();
1231  $this->fillLeftNav();
1232  $this->fillRightContent();
1233  $this->fillAdminPanel();
1234  $this->fillToolbar();
1235  $this->fillPermanentLink();
1236 
1237  $this->setCenterColumnClass();
1238 
1239  // late loading of javascipr files, since operations above may add files
1240  $this->fillJavaScriptFiles();
1241  $this->fillOnLoadCode();
1242 
1243  // these fill just plain placeholder variables in tpl.adm_content.html
1244  if ($this->blockExists("content")) {
1245  $this->setCurrentBlock("content");
1246  $this->fillTabs();
1247  $this->fillMainContent();
1248  $this->fillMainMenu();
1249  $this->fillLightbox();
1250  $this->parseCurrentBlock();
1251  }
1252  }
1253 
1254  if ($part == "DEFAULT" or is_bool($part)) {
1255  $html = $this->template->getUnmodified();
1256  } else {
1257  $html = $this->template->getUnmodified($part);
1258  }
1259 
1260  // Modification of html is done inline here and can't be done
1261  // by ilTemplate, because the "phase" is template_show in this
1262  // case here.
1263  $component_factory = $DIC["component.factory"];
1264  foreach ($component_factory->getActivePluginsInSlot("uihk") as $plugin) {
1265  $gui_class = $plugin->getUIClassInstance();
1266 
1267  $resp = $gui_class->getHTML(
1268  "",
1269  "template_show",
1270  array("tpl_id" => $this->tplIdentifier, "tpl_obj" => $this, "html" => $html)
1271  );
1272 
1273  if ($resp["mode"] != ilUIHookPluginGUI::KEEP) {
1274  $html = $gui_class->modifyHTML($html, $resp);
1275  }
1276  }
1277 
1278  // save language usages as late as possible
1280 
1281  print $html;
1282 
1283  break;
1284  }
1285  }
exit
Definition: login.php:28
setCurrentBlock(string $part="DEFAULT")
Sets the template to the given block.
fillJavaScriptFiles(bool $a_force=false)
Probably adds javascript files.
parseCurrentBlock(string $block_name="DEFAULT")
Parses the given block.
fillSideIcons()
Fill side icons (upper icon, tree icon, web folder icon)
global $DIC
Definition: feed.php:28
static initDom(?ilGlobalTemplateInterface $a_main_tpl=null)
Init YUI Dom.
fillCssFiles(bool $a_force=false)
Fill in the css file tags.
fillContentLanguage()
Add current user language to meta tags.
static ofString(string $string)
Creates a new stream with an initial value.
Definition: Streams.php:43
static _saveUsages()
Store the collected language variable usages in the user session This should be called as late as pos...
blockExists(string $block_name)
check if block exists in actual template
+ Here is the call graph for this function:

◆ printToString()

ilDataCollectionGlobalTemplate::printToString ( )

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

Implements ilGlobalTemplateInterface.

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

70  : string
71  {
72  throw new ilException('not implemented');
73  }

◆ resetCss()

ilDataCollectionGlobalTemplate::resetCss ( )
private

Reset css files.

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

544  : void
545  {
546  $this->css_files = array();
547  }

◆ resetHeaderBlock()

ilDataCollectionGlobalTemplate::resetHeaderBlock ( bool  $a_reset_header_action = true)

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

Implements ilGlobalTemplateInterface.

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

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

1453  : void
1454  {
1455  $this->setTitle(null);
1456  $this->setTitleIcon(null);
1457  $this->setDescription(null);
1458  $this->setAlertProperties(array());
1459  $this->setFileUploadRefId(null);
1460 
1461  // see setFullscreenHeader()
1462  if ($a_reset_header_action) {
1463  $this->setHeaderActionMenu(null);
1464  }
1465  }
setAlertProperties(array $alerts)
Set alert properties.
setFileUploadRefId(int $a_ref_id)
Enables the file upload into this object by dropping a file.
setDescription(string $a_descr)
Sets description below title in standard template.
setTitle(string $a_title, bool $hidden=false)
Sets title in standard template.
setTitleIcon(string $a_icon_path, string $a_icon_desc="")
set title icon
setHeaderActionMenu(string $a_header)
Set header action menu.
+ Here is the call graph for this function:

◆ resetJavascript()

ilDataCollectionGlobalTemplate::resetJavascript ( )

Reset javascript files.

Implements ilGlobalTemplateInterface.

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

367  : void
368  {
369  $this->js_files = array();
370  $this->js_files_vp = array();
371  $this->js_files_batch = array();
372  }

◆ setAlertProperties()

ilDataCollectionGlobalTemplate::setAlertProperties ( array  $alerts)

Set alert properties.

Parameters
array<int,array>$alerts

Implements ilGlobalTemplateInterface.

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

Referenced by clearHeader(), and resetHeaderBlock().

635  : void
636  {
637  $this->title_alerts = $alerts;
638  }
+ Here is the caller graph for this function:

◆ setBodyClass()

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

Sets the body-tags class.

Implements ilGlobalTemplateInterface.

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

Referenced by __construct().

527  : void
528  {
529  $this->body_class = $a_class;
530  }
+ Here is the caller graph for this function:

◆ setCenterColumnClass()

ilDataCollectionGlobalTemplate::setCenterColumnClass ( )
private

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

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

Referenced by getSpecial(), and printToStdout().

904  : void
905  {
906  if (!$this->blockExists("center_col_width")) {
907  return;
908  }
909  $center_column_class = "";
910  if (trim($this->right_content) != "" && trim($this->left_content) != "") {
911  $center_column_class = "two_side_col";
912  } else {
913  if (trim($this->right_content) != "" || trim($this->left_content) != "") {
914  $center_column_class = "one_side_col";
915  }
916  }
917 
918  switch ($center_column_class) {
919  case "one_side_col":
920  $center_column_class = "col-sm-9";
921  break;
922  case "two_side_col":
923  $center_column_class = "col-sm-6";
924  break;
925  default:
926  $center_column_class = "col-sm-12";
927  break;
928  }
929  if (trim($this->left_content) != "") {
930  $center_column_class .= " col-sm-push-3";
931  }
932 
933  $this->setCurrentBlock("center_col_width");
934  $this->setVariable("CENTER_COL", $center_column_class);
935  $this->parseCurrentBlock();
936  }
setCurrentBlock(string $part="DEFAULT")
Sets the template to the given block.
parseCurrentBlock(string $block_name="DEFAULT")
Parses the given block.
blockExists(string $block_name)
check if block exists in actual template
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setContent()

ilDataCollectionGlobalTemplate::setContent ( string  $a_html)

Sets content for standard template.

Implements ilGlobalTemplateInterface.

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

860  : void
861  {
862  if ($a_html != "") {
863  $this->main_content = $a_html;
864  }
865  }

◆ setCurrentBlock()

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

Sets the template to the given block.

Implements ilGlobalTemplateInterface.

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

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

1499  : bool
1500  {
1501  return $this->template->setCurrentBlock($part);
1502  }
+ Here is the caller graph for this function:

◆ setDescription()

ilDataCollectionGlobalTemplate::setDescription ( string  $a_descr)

Sets description below title in standard template.

Implements ilGlobalTemplateInterface.

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

Referenced by clearHeader(), and resetHeaderBlock().

624  : void
625  {
626  $this->title_desc = $a_descr;
627  }
+ 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 ilGlobalTemplateInterface.

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

Referenced by resetHeaderBlock().

1470  : void
1471  {
1472  $this->enable_fileupload = $a_ref_id;
1473  }
+ Here is the caller graph for this function:

◆ setHeaderActionMenu()

ilDataCollectionGlobalTemplate::setHeaderActionMenu ( string  $a_header)

Set header action menu.

Implements ilGlobalTemplateInterface.

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

Referenced by resetHeaderBlock().

660  : void
661  {
662  $this->header_action = $a_header;
663  }
+ Here is the caller graph for this function:

◆ setHeaderPageTitle()

ilDataCollectionGlobalTemplate::setHeaderPageTitle ( string  $a_title)

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

Implements ilGlobalTemplateInterface.

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

670  : void
671  {
672  $this->header_page_title = $a_title;
673  }

◆ setLeftContent()

ilDataCollectionGlobalTemplate::setLeftContent ( string  $a_html)

Sets content of left column.

Implements ilGlobalTemplateInterface.

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

870  : void
871  {
872  $this->left_content = $a_html;
873  }

◆ setLeftNavContent()

ilDataCollectionGlobalTemplate::setLeftNavContent ( string  $a_content)

Sets content of left navigation column.

Implements ilGlobalTemplateInterface.

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

878  : void
879  {
880  $this->left_nav_content = $a_content;
881  }

◆ setLocator()

ilDataCollectionGlobalTemplate::setLocator ( )

Insert locator.

Implements ilGlobalTemplateInterface.

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

References $DIC, $ilPluginAdmin, and setVariable().

768  : void
769  {
770  global $DIC;
771 
772  $ilLocator = $DIC["ilLocator"];
773  $ilPluginAdmin = $DIC["ilPluginAdmin"];
774 
775  $html = "";
776 
777  if (is_object($ilPluginAdmin)) {
778  include_once("./Services/UIComponent/classes/class.ilUIHookProcessor.php");
779  $html = $ilLocator->getHTML();
780  $uip = new ilUIHookProcessor(
781  "Services/Locator",
782  "main_locator",
783  ["locator_gui" => $ilLocator, "html" => $html]
784  );
785  $html = $uip->getHTML($html);
786  } else {
787  $html = $ilLocator->getHTML();
788  }
789  $this->setVariable("LOCATOR", $html);
790  }
global $ilPluginAdmin
Definition: goto.php:23
global $DIC
Definition: feed.php:28
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ 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 ilGlobalTemplateInterface.

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

1060  : void
1061  {
1062  $this->login_target_par = $a_val;
1063  }

◆ 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 ilGlobalTemplateInterface.

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

References $type, and ilSession\set().

225  : void
226  {
227  if (!in_array($type, self::$message_types) || $a_txt == "") {
228  return;
229  }
230  if (!$a_keep) {
231  $this->message[$type] = $a_txt;
232  } else {
233  ilSession::set($type, $a_txt);
234  }
235  }
$type
static set(string $a_var, $a_val)
Set a value.
+ Here is the call graph for this function:

◆ setPageFormAction()

ilDataCollectionGlobalTemplate::setPageFormAction ( string  $a_action)

Sets the pages form action.

Implements ilGlobalTemplateInterface.

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

1035  : void
1036  {
1037  $this->page_form_action = $a_action;
1038  }

◆ 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 ilGlobalTemplateInterface.

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

1421  : void {
1422  $this->permanent_link = array(
1423  "type" => $a_type,
1424  "id" => $a_id,
1425  "append" => $a_append,
1426  "target" => $a_target,
1427  "title" => $a_title,
1428  );
1429  }

◆ setRightContent()

ilDataCollectionGlobalTemplate::setRightContent ( string  $a_html)

Sets content of right column.

Implements ilGlobalTemplateInterface.

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

899  : void
900  {
901  $this->right_content = $a_html;
902  }

◆ setSubTabs()

ilDataCollectionGlobalTemplate::setSubTabs ( string  $a_tabs_html)

sets subtabs in standard template

Implements ilGlobalTemplateInterface.

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

References setVariable().

818  : void
819  {
820  $this->setVariable("SUB_TABS", $a_tabs_html);
821  }
setVariable(string $variable, $value='')
Sets the given variable to the given value.
+ Here is the call graph for this function:

◆ setTabs()

ilDataCollectionGlobalTemplate::setTabs ( string  $a_tabs_html)

sets tabs in standard template

Implements ilGlobalTemplateInterface.

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

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

804  : void
805  {
806  if ($a_tabs_html != "" && $this->blockExists("tabs_outer_start")) {
807  $this->touchBlock("tabs_outer_start");
808  $this->touchBlock("tabs_outer_end");
809  $this->touchBlock("tabs_inner_start");
810  $this->touchBlock("tabs_inner_end");
811  $this->setVariable("TABS", $a_tabs_html);
812  }
813  }
blockExists(string $block_name)
check if block exists in actual template
setVariable(string $variable, $value='')
Sets the given variable to the given value.
touchBlock(string $block)
overwrites ITX::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 ilGlobalTemplateInterface.

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

Referenced by clearHeader(), and resetHeaderBlock().

618  : void
619  {
620  $this->title = $a_title;
621  $this->header_page_title = $a_title;
622  }
+ Here is the caller graph for this function:

◆ setTitleIcon()

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

set title icon

Implements ilGlobalTemplateInterface.

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

Referenced by clearHeader(), and resetHeaderBlock().

629  : void
630  {
631  $this->icon_desc = $a_icon_desc;
632  $this->icon_path = $a_icon_path;
633  }
+ 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 ilGlobalTemplateInterface.

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

1330  : void
1331  {
1332  $this->tree_flat_link = $a_link;
1333  $this->tree_flat_mode = $a_mode;
1334  }

◆ setVariable()

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

Sets the given variable to the given value.

Parameters
mixed$value

Implements ilGlobalTemplateInterface.

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

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

1489  : void
1490  {
1491  $this->template->setVariable($variable, $value);
1492  }
+ Here is the caller graph for this function:

◆ touchBlock()

ilDataCollectionGlobalTemplate::touchBlock ( string  $block)

overwrites ITX::touchBlock.

Implements ilGlobalTemplateInterface.

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

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

1504  : bool
1505  {
1506  return $this->template->touchBlock($block);
1507  }
+ Here is the caller graph for this function:

◆ variableExists()

ilDataCollectionGlobalTemplate::variableExists ( string  $a_variablename)
private

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

1495  {
1496  return $this->template->variableExists($a_variablename);
1497  }

Field Documentation

◆ $admin_panel_arrow

bool ilDataCollectionGlobalTemplate::$admin_panel_arrow = null
protected

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

◆ $admin_panel_bottom

bool ilDataCollectionGlobalTemplate::$admin_panel_bottom = null
protected

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

◆ $admin_panel_commands_toolbar

ilToolbarGUI ilDataCollectionGlobalTemplate::$admin_panel_commands_toolbar = null
protected

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

Referenced by fillAdminPanel().

◆ $body_class

string ilDataCollectionGlobalTemplate::$body_class
protected

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

◆ $css_files

ilDataCollectionGlobalTemplate::$css_files = array()
protected

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

◆ $enable_fileupload

bool ilDataCollectionGlobalTemplate::$enable_fileupload = null
protected

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

◆ $header_action

string ilDataCollectionGlobalTemplate::$header_action
protected

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

Referenced by getHeaderActionMenu().

◆ $header_page_title

string ilDataCollectionGlobalTemplate::$header_page_title = ""
protected

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

◆ $http

ILIAS HTTP Services ilDataCollectionGlobalTemplate::$http
protected

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

◆ $icon_desc

string ilDataCollectionGlobalTemplate::$icon_desc = ""
protected

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

Referenced by fillHeader().

◆ $icon_path

string ilDataCollectionGlobalTemplate::$icon_path
protected

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

◆ $inline_css

ilDataCollectionGlobalTemplate::$inline_css = array()
protected

Stores CSS to be included directly.

array

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

◆ $js_files

ilDataCollectionGlobalTemplate::$js_files = array(0 => "./Services/JavaScript/js/Basic.js")
protected

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

◆ $js_files_batch

ilDataCollectionGlobalTemplate::$js_files_batch = array("./Services/JavaScript/js/Basic.js" => 1)
protected

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

◆ $js_files_vp

ilDataCollectionGlobalTemplate::$js_files_vp = array("./Services/JavaScript/js/Basic.js" => true)
protected

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

◆ $left_content

string ilDataCollectionGlobalTemplate::$left_content = ""
protected

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

◆ $left_nav_content

string ilDataCollectionGlobalTemplate::$left_nav_content = ""
protected

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

◆ $lightbox

ilDataCollectionGlobalTemplate::$lightbox = array()
protected

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

◆ $login_target_par

string ilDataCollectionGlobalTemplate::$login_target_par = ""
protected

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

Referenced by getLoginTargetPar().

◆ $main_content

string ilDataCollectionGlobalTemplate::$main_content = ""
protected

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

◆ $main_menu

string ilDataCollectionGlobalTemplate::$main_menu
protected

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

◆ $main_menu_spacer

string ilDataCollectionGlobalTemplate::$main_menu_spacer
protected

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

◆ $message

array ilDataCollectionGlobalTemplate::$message = array()
protected

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

◆ $message_types

ilDataCollectionGlobalTemplate::$message_types
staticprotected
Initial value:
= array(
self::MESSAGE_TYPE_FAILURE,
self::MESSAGE_TYPE_INFO,
self::MESSAGE_TYPE_SUCCESS,
self::MESSAGE_TYPE_QUESTION,
)

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

Referenced by initHelp().

◆ $on_load_code

array ilDataCollectionGlobalTemplate::$on_load_code
protected

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

◆ $page_form_action

ilDataCollectionGlobalTemplate::$page_form_action = ""
protected

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

◆ $permanent_link

ilDataCollectionGlobalTemplate::$permanent_link = false
protected

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

◆ $refinery

ILIAS Refinery Factory ilDataCollectionGlobalTemplate::$refinery
protected

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

◆ $right_content

string ilDataCollectionGlobalTemplate::$right_content = ""
protected

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

◆ $show_footer

bool ilDataCollectionGlobalTemplate::$show_footer = true
private

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

◆ $standard_template_loaded

ilDataCollectionGlobalTemplate::$standard_template_loaded = false
protected

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

◆ $sub_tabs_html

string ilDataCollectionGlobalTemplate::$sub_tabs_html = ""
protected

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

◆ $tabs_html

string ilDataCollectionGlobalTemplate::$tabs_html = ""
protected

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

◆ $template

ilTemplate ilDataCollectionGlobalTemplate::$template
protected

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

◆ $title

string ilDataCollectionGlobalTemplate::$title = ""
protected

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

◆ $title_alerts

array ilDataCollectionGlobalTemplate::$title_alerts = array()
protected

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

◆ $title_desc

string ilDataCollectionGlobalTemplate::$title_desc = ""
protected

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

◆ $tplIdentifier

string ilDataCollectionGlobalTemplate::$tplIdentifier = ""
protected

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

◆ $tree_flat_link

ilDataCollectionGlobalTemplate::$tree_flat_link = ""
protected

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

◆ $tree_flat_mode

string ilDataCollectionGlobalTemplate::$tree_flat_mode = ""
protected

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


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