ILIAS  release_7 Revision v7.30-3-g800a261c036
ilRTEGlobalTemplate Class Reference

special template class to simplify handling of ITX/PEAR More...

+ Inheritance diagram for ilRTEGlobalTemplate:
+ Collaboration diagram for ilRTEGlobalTemplate:

Public Member Functions

 __construct ( $file, $flag1, $flag2, $in_module=false, $vars="DEFAULT", $plugin=false, $a_use_cache=true)
 constructor More...
 
 printToString ()
 @inheritDoc More...
 
 hideFooter ()
 Make the template hide the footer. More...
 
 setOnScreenMessage ($a_type, $a_txt, $a_keep=false)
 Set a message to be displayed to the user. More...
 
 addJavaScript ($a_js_file, $a_add_version_parameter=true, $a_batch=2)
 Add a javascript file that should be included in the header. More...
 
 addOnLoadCode ($a_code, $a_batch=2)
 Add on load code. More...
 
 getOnLoadCodeForAsynch ()
 Get js onload code for ajax calls. More...
 
 resetJavascript ()
 Reset javascript files. More...
 
 fillJavaScriptFiles ($a_force=false)
 
 addCss ($a_css_file, $media="screen")
 Add a css file that should be included in the header. More...
 
 addInlineCss ($a_css, $media="screen")
 Add a css file that should be included in the header. More...
 
 fillCssFiles ($a_force=false)
 Fill in the css file tags. More...
 
 setBodyClass ($a_class="")
 
 loadStandardTemplate ()
 This loads the standard template "tpl.adm_content.html" and "tpl.statusline.html" the CONTENT and STATUSLINE placeholders if they are not already loaded. More...
 
 setTitle ($a_title, $hidden=false)
 Sets title in standard template. More...
 
 setDescription ($a_descr)
 Sets descripton below title in standard template. More...
 
 setTitleIcon ($a_icon_path, $a_icon_desc="")
 set title icon More...
 
 setAlertProperties (array $a_props)
 Set alert properties. More...
 
 clearHeader ()
 Clear header. More...
 
 setHeaderActionMenu ($a_header)
 Set header action menu. More...
 
 setHeaderPageTitle ($a_title)
 Sets the title of the page (for browser window). More...
 
 setLocator ()
 Insert locator. More...
 
 setTabs ($a_tabs_html)
 sets tabs in standard template More...
 
 setSubTabs ($a_tabs_html)
 sets subtabs in standard template More...
 
 setContent ($a_html)
 Sets content for standard template. More...
 
 setLeftContent ($a_html)
 Sets content of left column. More...
 
 setLeftNavContent ($a_content)
 Sets content of left navigation column. More...
 
 setRightContent ($a_html)
 Sets content of right column. More...
 
 fillWindowTitle ()
 
 setPageFormAction ($a_action)
 
 setLoginTargetPar ($a_val)
 Set target parameter for login (public sector). More...
 
 getSpecial ( $part="DEFAULT", $add_error_mess=false, $handle_referer=false, $add_ilias_footer=false, $add_standard_elements=false, $a_main_menu=true, $a_tabs=true)
 
 printToStdout ($part="DEFAULT", $a_fill_tabs=true, $a_skip_main_menu=false)
 
 setTreeFlatIcon ($a_link, $a_mode)
 set tree/flat icon More...
 
 addLightbox ($a_html, $a_id)
 Add lightbox html. More...
 
 addAdminPanelToolbar (ilToolbarGUI $toolb, $a_bottom_panel=true, $a_arrow=false)
 Add admin panel commands as toolbar. More...
 
 setPermanentLink ($a_type, $a_id, $a_append="", $a_target="", $a_title="")
 
 resetHeaderBlock ($a_reset_header_action=true)
 Reset all header properties: title, icon, description, alerts, action menu. More...
 
 enableDragDropFileUpload ($a_ref_id)
 Enables the file upload into this object by dropping a file. More...
 
 get ($part="DEFAULT")
 
 setVariable ($variable, $value='')
 
 setCurrentBlock ($part="DEFAULT")
 @access public More...
 
 touchBlock ($block)
 overwrites ITX::touchBlock. More...
 
 parseCurrentBlock ($part="DEFAULT")
 Überladene Funktion, die auf den aktuelle Block vorher noch ein replace ausführt @access public. More...
 
 addBlockFile ($var, $block, $tplname, $in_module=false)
 overwrites ITX::addBlockFile @access public More...
 
 blockExists ($a_blockname)
 check if block exists in actual template @access private More...
 
 hideFooter ()
 Make the template hide the footer. More...
 
 setOnScreenMessage ($a_type, $a_txt, $a_keep=false)
 Set a message to be displayed to the user. More...
 
 addJavaScript ($a_js_file, $a_add_version_parameter=true, $a_batch=2)
 Add a javascript file that should be included in the header. More...
 
 addOnLoadCode ($a_code, $a_batch=2)
 Add on load code. More...
 
 getOnLoadCodeForAsynch ()
 Get js onload code for ajax calls. More...
 
 resetJavascript ()
 Reset javascript files. More...
 
 fillJavaScriptFiles ($a_force=false)
 
 addCss ($a_css_file, $media="screen")
 Add a css file that should be included in the header. More...
 
 addInlineCss ($a_css, $media="screen")
 Add a css file that should be included in the header. More...
 
 setBodyClass ($a_class="")
 
 loadStandardTemplate ()
 This loads the standard template "tpl.adm_content.html" and "tpl.statusline.html" the CONTENT and STATUSLINE placeholders if they are not already loaded. More...
 
 setTitle ($a_title, $hidden=false)
 Sets title in standard template. More...
 
 setDescription ($a_descr)
 Sets descripton below title in standard template. More...
 
 setTitleIcon ($a_icon_path, $a_icon_desc="")
 set title icon More...
 
 setAlertProperties (array $a_props)
 Set alert properties. More...
 
 clearHeader ()
 Clear header. More...
 
 setHeaderActionMenu ($a_header)
 Set header action menu. More...
 
 setHeaderPageTitle ($a_title)
 Sets the title of the page (for browser window). More...
 
 setLocator ()
 Insert locator. More...
 
 setTabs ($a_tabs_html)
 sets tabs in standard template More...
 
 setSubTabs ($a_tabs_html)
 sets subtabs in standard template More...
 
 setContent ($a_html)
 Sets content for standard template. More...
 
 setLeftContent ($a_html)
 Sets content of left column. More...
 
 setLeftNavContent ($a_content)
 Sets content of left navigation column. More...
 
 setRightContent ($a_html)
 Sets content of right column. More...
 
 setPageFormAction ($a_action)
 
 setLoginTargetPar ($a_val)
 Set target parameter for login (public sector). More...
 
 getSpecial ($part="DEFAULT", $add_error_mess=false, $handle_referer=false, $add_ilias_footer=false, $add_standard_elements=false, $a_main_menu=true, $a_tabs=true)
 
 printToStdout ($part="DEFAULT", $a_fill_tabs=true, $a_skip_main_menu=false)
 
 printToString ()
 Use this method to get the finally rendered page as string. More...
 
 setTreeFlatIcon ($a_link, $a_mode)
 set tree/flat icon More...
 
 addLightbox ($a_html, $a_id)
 Add lightbox html. More...
 
 addAdminPanelToolbar (ilToolbarGUI $toolb, $a_bottom_panel=true, $a_arrow=false)
 Add admin panel commands as toolbar. More...
 
 setPermanentLink ($a_type, $a_id, $a_append="", $a_target="", $a_title="")
 
 resetHeaderBlock ($a_reset_header_action=true)
 Reset all header properties: title, icon, description, alerts, action menu. More...
 
 enableDragDropFileUpload ($a_ref_id)
 Enables the file upload into this object by dropping a file. More...
 
 get ($part="DEFAULT")
 
 setVariable ($variable, $value='')
 
 setCurrentBlock ($part="DEFAULT")
 @access public More...
 
 touchBlock ($block)
 overwrites ITX::touchBlock. More...
 
 parseCurrentBlock ($part="DEFAULT")
 Überladene Funktion, die auf den aktuelle Block vorher noch ein replace ausführt. More...
 
 addBlockFile ($var, $block, $tplname, $in_module=false)
 overwrites ITX::addBlockFile More...
 
 blockExists ($a_blockname)
 check if block exists in actual template More...
 

Data Fields

const MESSAGE_TYPE_FAILURE = 'failure'
 
const MESSAGE_TYPE_INFO = "info"
 
const MESSAGE_TYPE_SUCCESS = "success"
 
const MESSAGE_TYPE_QUESTION = "question"
 

Protected Member Functions

 fillJavascriptFile ($file, $vers)
 

Protected Attributes

 $tree_flat_link = ""
 
 $page_form_action = ""
 
 $permanent_link = false
 
 $lightbox = array()
 
 $standard_template_loaded = false
 
 $template
 
 $main_menu
 
 $main_menu_spacer
 
 $message = array()
 
 $js_files = array(0 => "./Services/JavaScript/js/Basic.js")
 
 $js_files_vp = array("./Services/JavaScript/js/Basic.js" => true)
 
 $js_files_batch = array("./Services/JavaScript/js/Basic.js" => 1)
 
 $css_files = array()
 
 $inline_css = array()
 Stores CSS to be included directly. More...
 
 $header_page_title = ""
 
 $title = ""
 
 $title_desc = ""
 
 $title_alerts = array()
 
 $header_action
 
 $tabs_html = ""
 
 $sub_tabs_html = ""
 
 $admin_panel_commands_toolbar = null
 
 $admin_panel_arrow = null
 
 $admin_panel_bottom = null
 

Static Protected Attributes

static $message_types
 

Private Member Functions

 fillFooter ()
 Fill the footer area. More...
 
 getMainMenu ()
 
 fillMainMenu ()
 
 initHelp ()
 Init help. More...
 
 fillMessage ()
 Fill message area. More...
 
 getMessageTextForType ($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...
 
 fillPageFormAction ()
 
 getLoginTargetPar ()
 Get target parameter for login. More...
 
 handleReferer ()
 TODO: this is nice, but shouldn't be done here (-> maybe at the end of ilias.php!?, alex) More...
 
 fillScreenReaderFocus ()
 Accessibility focus for screen readers. More...
 
 fillSideIcons ()
 Fill side icons (upper icon, tree icon, webfolder icon) More...
 
 fillLightbox ()
 Fill lightbox content. More...
 
 fillAdminPanel ()
 Put admin panel into template: More...
 
 fillPermanentLink ()
 Fill in permanent link. More...
 
 variableExists ($a_variablename)
 

Private Attributes

 $show_footer = true
 

Detailed Description

special template class to simplify handling of ITX/PEAR

Author
Stefan Kesseler skess.nosp@m.eler.nosp@m.@data.nosp@m.bay..nosp@m.de
Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e
Version
$Id$

Definition at line 13 of file class.ilRTEGlobalTemplate.php.

Constructor & Destructor Documentation

◆ __construct()

ilRTEGlobalTemplate::__construct (   $file,
  $flag1,
  $flag2,
  $in_module = false,
  $vars = "DEFAULT",
  $plugin = false,
  $a_use_cache = true 
)

constructor

Parameters
string$filetemplatefile (mit oder ohne pfad)
boolean$flag1remove unknown variables
boolean$flag2remove empty blocks
boolean$in_moduleshould be set to true, if template file is in module subdirectory
array$varsvariables to replace @access public

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

44 {
45 $this->setBodyClass("std");
46 $this->template = new ilTemplate($file, $flag1, $flag2, $in_module, $vars, $plugin, $a_use_cache);
47 }
special template class to simplify handling of ITX/PEAR

References XapiProxy\$plugin, and setBodyClass().

+ Here is the call graph for this function:

Member Function Documentation

◆ addAdminPanelToolbar()

ilRTEGlobalTemplate::addAdminPanelToolbar ( ilToolbarGUI  $toolb,
  $a_bottom_panel = true,
  $a_arrow = false 
)

Add admin panel commands as toolbar.

Parameters
ilToolbarGUI$toolb
bool$a_top_only

Implements ilGlobalTemplateInterface.

Definition at line 1666 of file class.ilRTEGlobalTemplate.php.

1667 {
1668 $this->admin_panel_commands_toolbar = $toolb;
1669 $this->admin_panel_arrow = $a_arrow;
1670 $this->admin_panel_bottom = $a_bottom_panel;
1671 }

◆ addBlockFile()

ilRTEGlobalTemplate::addBlockFile (   $var,
  $block,
  $tplname,
  $in_module = false 
)

overwrites ITX::addBlockFile @access public

Parameters
string
string
string$tplnametemplate name
boolean$in_moduleshould be set to true, if template file is in module subdirectory
Returns
boolean/string

Implements ilGlobalTemplateInterface.

Definition at line 1836 of file class.ilRTEGlobalTemplate.php.

1837 {
1838 return $this->template->addBlockFile($var, $block, $tplname, $in_module);
1839 }

Referenced by loadStandardTemplate().

+ Here is the caller graph for this function:

◆ addCss()

ilRTEGlobalTemplate::addCss (   $a_css_file,
  $media = "screen" 
)

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

Implements ilGlobalTemplateInterface.

Definition at line 589 of file class.ilRTEGlobalTemplate.php.

590 {
591 if (!array_key_exists($a_css_file . $media, $this->css_files)) {
592 $this->css_files[$a_css_file . $media] = array("file" => $a_css_file, "media" => $media);
593 }
594 }

◆ addInlineCss()

ilRTEGlobalTemplate::addInlineCss (   $a_css,
  $media = "screen" 
)

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

Implements ilGlobalTemplateInterface.

Definition at line 603 of file class.ilRTEGlobalTemplate.php.

604 {
605 $this->inline_css[] = array("css" => $a_css, "media" => $media);
606 }

◆ addJavaScript()

ilRTEGlobalTemplate::addJavaScript (   $a_js_file,
  $a_add_version_parameter = true,
  $a_batch = 2 
)

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

Implements ilGlobalTemplateInterface.

Definition at line 426 of file class.ilRTEGlobalTemplate.php.

427 {
428 // three batches currently
429 if ($a_batch < 1 || $a_batch > 3) {
430 $a_batch = 2;
431 }
432
433 // ensure jquery files being loaded first
434 if (is_int(strpos($a_js_file, "Services/jQuery")) ||
435 is_int(strpos($a_js_file, "/jquery.js")) ||
436 is_int(strpos($a_js_file, "/jquery-min.js"))) {
437 $a_batch = 0;
438 }
439
440 if (!in_array($a_js_file, $this->js_files)) {
441 $this->js_files[] = $a_js_file;
442 $this->js_files_vp[$a_js_file] = $a_add_version_parameter;
443 $this->js_files_batch[$a_js_file] = $a_batch;
444 }
445 }

◆ addLightbox()

ilRTEGlobalTemplate::addLightbox (   $a_html,
  $a_id 
)

Add lightbox html.

Implements ilGlobalTemplateInterface.

Definition at line 1628 of file class.ilRTEGlobalTemplate.php.

1629 {
1630 $this->lightbox[$a_id] = $a_html;
1631 }

◆ addOnLoadCode()

ilRTEGlobalTemplate::addOnLoadCode (   $a_code,
  $a_batch = 2 
)

Add on load code.

Implements ilGlobalTemplateInterface.

Definition at line 450 of file class.ilRTEGlobalTemplate.php.

451 {
452 // three batches currently
453 if ($a_batch < 1 || $a_batch > 3) {
454 $a_batch = 2;
455 }
456 $this->on_load_code[$a_batch][] = $a_code;
457 }

◆ blockExists()

ilRTEGlobalTemplate::blockExists (   $a_blockname)

check if block exists in actual template @access private

Parameters
stringblockname
Returns
boolean

Implements ilGlobalTemplateInterface.

Definition at line 1847 of file class.ilRTEGlobalTemplate.php.

1848 {
1849 return $this->template->blockExists($a_blockname);
1850 }

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

+ Here is the caller graph for this function:

◆ clearHeader()

ilRTEGlobalTemplate::clearHeader ( )

Clear header.

Implements ilGlobalTemplateInterface.

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

789 {
790 $this->setTitle("");
791 $this->setTitleIcon("");
792 $this->setDescription("");
793 $this->setAlertProperties(array());
794 }
setAlertProperties(array $a_props)
Set alert properties.
setDescription($a_descr)
Sets descripton below title in standard template.
setTitleIcon($a_icon_path, $a_icon_desc="")
set title icon
setTitle($a_title, $hidden=false)
Sets title in standard template.

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

+ Here is the call graph for this function:

◆ enableDragDropFileUpload()

ilRTEGlobalTemplate::enableDragDropFileUpload (   $a_ref_id)

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

Implements ilGlobalTemplateInterface.

Definition at line 1766 of file class.ilRTEGlobalTemplate.php.

1767 {
1768 $this->enable_fileupload = $a_ref_id;
1769 }

Referenced by resetHeaderBlock().

+ Here is the caller graph for this function:

◆ fillAdminPanel()

ilRTEGlobalTemplate::fillAdminPanel ( )
private

Put admin panel into template:

  • creation selector
  • admin view on/off button

Definition at line 1678 of file class.ilRTEGlobalTemplate.php.

1679 {
1680 global $DIC;
1681 $lng = $DIC->language();
1682
1683 if ($this->admin_panel_commands_toolbar === null) {
1684 return;
1685 }
1686
1688 assert($toolbar instanceof \ilToolbarGUI);
1689
1690 // Add arrow if desired.
1691 if ($this->admin_panel_arrow) {
1692 $toolb->setLeadingImage(ilUtil::getImagePath("arrow_upright.svg"), $lng->txt("actions"));
1693 }
1694
1695 $this->fillPageFormAction();
1696
1697 // Add top admin bar.
1698 $this->setCurrentBlock("adm_view_components");
1699 $this->setVariable("ADM_PANEL1", $toolb->getHTML());
1700 $this->parseCurrentBlock();
1701
1702 // Add bottom admin bar if user wants one.
1703 if ($this->admin_panel_bottom) {
1704 $this->setCurrentBlock("adm_view_components2");
1705
1706 // Replace previously set arrow image.
1707 if ($this->admin_panel_arrow) {
1708 $toolb->setLeadingImage(ilUtil::getImagePath("arrow_downright.svg"), $lng->txt("actions"));
1709 }
1710
1711 $this->setVariable("ADM_PANEL2", $toolb->getHTML());
1712 $this->parseCurrentBlock();
1713 }
1714 }
parseCurrentBlock($part="DEFAULT")
Überladene Funktion, die auf den aktuelle Block vorher noch ein replace ausführt @access public.
setVariable($variable, $value='')
setCurrentBlock($part="DEFAULT")
@access public
static getImagePath($img, $module_path="", $mode="output", $offline=false)
get image path (for images located in a template directory)
global $DIC
Definition: goto.php:24
$lng

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

Referenced by getSpecial(), and printToStdout().

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

◆ fillBodyClass()

ilRTEGlobalTemplate::fillBodyClass ( )
private

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

653 {
654 if ($this->body_class != "" && $this->blockExists("body_class")) {
655 $this->setCurrentBlock("body_class");
656 $this->setVariable("BODY_CLASS", $this->body_class);
657 $this->parseCurrentBlock();
658 }
659 }
blockExists($a_blockname)
check if block exists in actual template @access private

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

Referenced by getSpecial(), and printToStdout().

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

◆ fillContentLanguage()

ilRTEGlobalTemplate::fillContentLanguage ( )
private

Add current user language to meta tags.

Definition at line 1160 of file class.ilRTEGlobalTemplate.php.

1161 {
1162 global $DIC;
1163
1164 $lng = $DIC->language();
1165 $ilUser = $DIC->user();
1166
1167 $contentLanguage = 'en';
1168 $rtl = array('ar','fa','ur','he');//, 'de'); //make a list of rtl languages
1169 /* rtl-review: add "de" for testing with ltr lang shown in rtl
1170 * and set unicode-bidi to bidi-override for mirror effect */
1171 $textdir = 'ltr';
1172 if (is_object($ilUser)) {
1173 if ($ilUser->getLanguage()) {
1174 $contentLanguage = $ilUser->getLanguage();
1175 } elseif (is_object($lng)) {
1176 $contentLanguage = $lng->getDefaultLanguage();
1177 }
1178 }
1179 $this->setVariable('META_CONTENT_LANGUAGE', $contentLanguage);
1180 if (in_array($contentLanguage, $rtl)) {
1181 $textdir = 'rtl';
1182 }
1183 $this->setVariable('LANGUAGE_DIRECTION', $textdir);
1184 return true;
1185 }
$ilUser
Definition: imgupload.php:18

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

Referenced by getSpecial(), and printToStdout().

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

◆ fillCssFiles()

ilRTEGlobalTemplate::fillCssFiles (   $a_force = false)

Fill in the css file tags.

Parameters
boolean$a_force

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

619 {
620 if (!$this->blockExists("css_file")) {
621 return;
622 }
623 foreach ($this->css_files as $css) {
624 $filename = $css["file"];
625 if (strpos($filename, "?") > 0) {
626 $filename = substr($filename, 0, strpos($filename, "?"));
627 }
628 if (is_file($filename) || $a_force) {
629 $this->setCurrentBlock("css_file");
630 $this->setVariable("CSS_FILE", $css["file"]);
631 $this->setVariable("CSS_MEDIA", $css["media"]);
632 $this->parseCurrentBlock();
633 }
634 }
635 }
$filename
Definition: buildRTE.php:89

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

Referenced by getSpecial(), and printToStdout().

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

◆ fillFooter()

ilRTEGlobalTemplate::fillFooter ( )
private

Fill the footer area.

Definition at line 83 of file class.ilRTEGlobalTemplate.php.

84 {
85 global $DIC;
86
87 $ilSetting = $DIC->settings();
88
89 $lng = $DIC->language();
90
91 $ilCtrl = $DIC->ctrl();
92 $ilDB = $DIC->database();
93
94 if (!$this->show_footer) {
95 return;
96 }
97
98 $ftpl = new ilTemplate("tpl.footer.html", true, true, "Services/UICore");
99
100 $php = "";
101 if (DEVMODE) {
102 $php = ", PHP " . phpversion();
103 }
104 $ftpl->setVariable("ILIAS_VERSION", $ilSetting->get("ilias_version") . $php);
105
106 $link_items = array();
107
108 // imprint
109 include_once "Services/Imprint/classes/class.ilImprint.php";
110 if ($_REQUEST["baseClass"] != "ilImprintGUI" && ilImprint::isActive()) {
111 include_once "Services/Link/classes/class.ilLink.php";
112 $link_items[ilLink::_getStaticLink(0, "impr")] = array($lng->txt("imprint"), true);
113 }
114
115 // system support contacts
116 include_once("./Modules/SystemFolder/classes/class.ilSystemSupportContactsGUI.php");
118 $link_items[$l] = array(ilSystemSupportContactsGUI::getFooterText(), false);
119 }
120
121 if (DEVMODE) {
122 if (function_exists("tidy_parse_string")) {
123 $link_items[ilUtil::appendUrlParameterString($_SERVER["REQUEST_URI"], "do_dev_validate=xhtml")] = array("Validate", true);
124 $link_items[ilUtil::appendUrlParameterString($_SERVER["REQUEST_URI"], "do_dev_validate=accessibility")] = array("Accessibility", true);
125 }
126 }
127
128 // output translation link
129 include_once("Services/Language/classes/class.ilObjLanguageAccess.php");
131 $link_items[ilObjLanguageAccess::_getTranslationLink()] = array($lng->txt('translation'), true);
132 }
133
134 $cnt = 0;
135 foreach ($link_items as $url => $caption) {
136 $cnt++;
137 if ($caption[1]) {
138 $ftpl->touchBlock("blank");
139 }
140 if ($cnt < sizeof($link_items)) {
141 $ftpl->touchBlock("item_separator");
142 }
143
144 $ftpl->setCurrentBlock("items");
145 $ftpl->setVariable("URL_ITEM", ilUtil::secureUrl($url));
146 $ftpl->setVariable("TXT_ITEM", $caption[0]);
147 $ftpl->parseCurrentBlock();
148 }
149
150 if (DEVMODE) {
151 // execution time
152 $t1 = explode(" ", $GLOBALS['ilGlobalStartTime']);
153 $t2 = explode(" ", microtime());
154 $diff = $t2[0] - $t1[0] + $t2[1] - $t1[1];
155
156 $mem_usage = array();
157 if (function_exists("memory_get_usage")) {
158 $mem_usage[] =
159 "Memory Usage: " . memory_get_usage() . " Bytes";
160 }
161 if (function_exists("xdebug_peak_memory_usage")) {
162 $mem_usage[] =
163 "XDebug Peak Memory Usage: " . xdebug_peak_memory_usage() . " Bytes";
164 }
165 $mem_usage[] = round($diff, 4) . " Seconds";
166
167 if (sizeof($mem_usage)) {
168 $ftpl->setVariable("MEMORY_USAGE", "<br>" . implode(" | ", $mem_usage));
169 }
170
171 if (!empty($_GET["do_dev_validate"]) && $ftpl->blockExists("xhtml_validation")) {
172 require_once("Services/XHTMLValidator/classes/class.ilValidatorAdapter.php");
173 $template2 = clone($this);
174 $ftpl->setCurrentBlock("xhtml_validation");
175 $ftpl->setVariable(
176 "VALIDATION",
177 ilValidatorAdapter::validate($template2->get(
178 "DEFAULT",
179 false,
180 false,
181 false,
182 true
183 ), $_GET["do_dev_validate"])
184 );
185 $ftpl->parseCurrentBlock();
186 }
187
188 // controller history
189 if (is_object($ilCtrl) && $ftpl->blockExists("c_entry") &&
190 $ftpl->blockExists("call_history")) {
191 $hist = $ilCtrl->getCallHistory();
192 foreach ($hist as $entry) {
193 $ftpl->setCurrentBlock("c_entry");
194 $ftpl->setVariable("C_ENTRY", $entry["class"]);
195 if (is_object($ilDB)) {
196 $file = $ilCtrl->lookupClassPath($entry["class"]);
197 $add = $entry["mode"] . " - " . $entry["cmd"];
198 if ($file != "") {
199 $add .= " - " . $file;
200 }
201 $ftpl->setVariable("C_FILE", $add);
202 }
203 $ftpl->parseCurrentBlock();
204 }
205 $ftpl->setCurrentBlock("call_history");
206 $ftpl->parseCurrentBlock();
207 }
208
209 // included files
210 if (is_object($ilCtrl) && $ftpl->blockExists("i_entry") &&
211 $ftpl->blockExists("included_files")) {
212 $fs = get_included_files();
213 $ifiles = array();
214 $total = 0;
215 foreach ($fs as $f) {
216 $ifiles[] = array("file" => $f, "size" => filesize($f));
217 $total += filesize($f);
218 }
219 $ifiles = ilUtil::sortArray($ifiles, "size", "desc", true);
220 foreach ($ifiles as $f) {
221 $ftpl->setCurrentBlock("i_entry");
222 $ftpl->setVariable("I_ENTRY", $f["file"] . " (" . $f["size"] . " Bytes, " . round(100 / $total * $f["size"], 2) . "%)");
223 $ftpl->parseCurrentBlock();
224 }
225 $ftpl->setCurrentBlock("i_entry");
226 $ftpl->setVariable("I_ENTRY", "Total (" . $total . " Bytes, 100%)");
227 $ftpl->parseCurrentBlock();
228 $ftpl->setCurrentBlock("included_files");
229 $ftpl->parseCurrentBlock();
230 }
231 }
232
233 // BEGIN Usability: Non-Delos Skins can display the elapsed time in the footer
234 // The corresponding $ilBench->start invocation is in inc.header.php
235 $ilBench = $DIC["ilBench"];
236 $ilBench->stop("Core", "ElapsedTimeUntilFooter");
237 $ftpl->setVariable(
238 "ELAPSED_TIME",
239 ", " . number_format($ilBench->getMeasuredTime("Core", "ElapsedTimeUntilFooter"), 1) . ' seconds'
240 );
241 // END Usability: Non-Delos Skins can display the elapsed time in the footer
242
243 $this->setVariable("FOOTER", $ftpl->get());
244 }
if(!defined('PATH_SEPARATOR')) $GLOBALS['_PEAR_default_error_mode']
Definition: PEAR.php:64
$total
Definition: Utf8Test.php:87
$_GET["client_id"]
static isActive()
static _checkTranslate()
Permission check for translations.
static _isPageTranslation()
Check if the current request is a page translation.
static _getTranslationLink()
Get the link to translate the current page.
static appendUrlParameterString($a_url, $a_par, $xml_style=false)
append URL parameter string ("par1=value1&par2=value2...") to given URL string
static sortArray( $array, $a_array_sortby, $a_array_sortorder=0, $a_numeric=false, $a_keep_keys=false)
sortArray
static secureUrl($url)
Prepare secure href attribute.
static validate($a_html, $a_mode)
global $ilBench
Definition: ilias.php:21
global $ilSetting
Definition: privfeed.php:17
$url
$_SERVER['HTTP_HOST']
Definition: raiseError.php:10
global $ilDB

References $_GET, $_SERVER, $DIC, Vendor\Package\$f, $GLOBALS, $ilBench, $ilDB, $ilSetting, $lng, $total, $url, ilObjLanguageAccess\_checkTranslate(), ilLink\_getStaticLink(), ilObjLanguageAccess\_getTranslationLink(), ilObjLanguageAccess\_isPageTranslation(), ilUtil\appendUrlParameterString(), ilSystemSupportContactsGUI\getFooterLink(), ilSystemSupportContactsGUI\getFooterText(), ilImprint\isActive(), ilUtil\secureUrl(), setVariable(), ilUtil\sortArray(), and ilValidatorAdapter\validate().

Referenced by getSpecial(), and printToStdout().

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

◆ fillHeader()

ilRTEGlobalTemplate::fillHeader ( )
private

Fill header.

Definition at line 831 of file class.ilRTEGlobalTemplate.php.

832 {
833 global $DIC;
834
835 $lng = $DIC->language();
836
837 $icon = false;
838 if ($this->icon_path != "") {
839 $icon = true;
840 $this->setCurrentBlock("header_image");
841 if ($this->icon_desc != "") {
842 $this->setVariable("IMAGE_DESC", $lng->txt("icon") . " " . $this->icon_desc);
843 $this->setVariable("IMAGE_ALT", $lng->txt("icon") . " " . $this->icon_desc);
844 }
845
846 $this->setVariable("IMG_HEADER", $this->icon_path);
847 $this->parseCurrentBlock();
848 $header = true;
849 }
850
851 if ($this->title != "") {
852 $title = ilUtil::stripScriptHTML($this->title);
853 $this->setVariable("HEADER", $title);
854
855 $header = true;
856 }
857
858 if ($header) {
859 $this->setCurrentBlock("header_image");
860 $this->parseCurrentBlock();
861 }
862
863 if ($this->title_desc != "") {
864 $this->setCurrentBlock("header_desc");
865 $this->setVariable("H_DESCRIPTION", $this->title_desc);
866 $this->parseCurrentBlock();
867 }
868
869 $header = $this->getHeaderActionMenu();
870 if ($header) {
871 $this->setCurrentBlock("head_action_inner");
872 $this->setVariable("HEAD_ACTION", $header);
873 $this->parseCurrentBlock();
874 }
875
876 if (count((array) $this->title_alerts)) {
877 foreach ($this->title_alerts as $alert) {
878 $this->setCurrentBlock('header_alert');
879 if (!($alert['propertyNameVisible'] === false)) {
880 $this->setVariable('H_PROP', $alert['property'] . ':');
881 }
882 $this->setVariable('H_VALUE', $alert['value']);
883 $this->parseCurrentBlock();
884 }
885 }
886
887 // add file upload drop zone in header
888 if ($this->enable_fileupload != null) {
889 $ref_id = $this->enable_fileupload;
890 $upload_id = "dropzone_" . $ref_id;
891
892 include_once("./Services/FileUpload/classes/class.ilFileUploadGUI.php");
893 $upload = new ilFileUploadGUI($upload_id, $ref_id, true);
894
895 $this->setVariable("FILEUPLOAD_DROPZONE_ID", " id=\"$upload_id\"");
896
897 $this->setCurrentBlock("header_fileupload");
898 $this->setVariable("HEADER_FILEUPLOAD_SCRIPT", $upload->getHTML());
899 $this->parseCurrentBlock();
900 }
901 }
getHeaderActionMenu()
Get header action menu.
static stripScriptHTML($a_str, $a_allow="", $a_rm_js=true)
strip only html tags (4.0) from text $allowed contains tags to be allowed, in format tags a and b ar...

References $DIC, $lng, $title, getHeaderActionMenu(), parseCurrentBlock(), setCurrentBlock(), setVariable(), and ilUtil\stripScriptHTML().

Referenced by getSpecial(), and printToStdout().

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

◆ fillInlineCss()

ilRTEGlobalTemplate::fillInlineCss ( )
private

Fill in the inline css.

Parameters
boolean$a_force

Definition at line 674 of file class.ilRTEGlobalTemplate.php.

675 {
676 if (!$this->blockExists("css_inline")) {
677 return;
678 }
679 foreach ($this->inline_css as $css) {
680 $this->setCurrentBlock("css_inline");
681 $this->setVariable("CSS_INLINE", $css["css"]);
682 $this->parseCurrentBlock();
683 }
684 }

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

Referenced by getSpecial(), and printToStdout().

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

◆ fillJavascriptFile()

ilRTEGlobalTemplate::fillJavascriptFile (   $file,
  $vers 
)
protected
Parameters
string$file
string$vers

Definition at line 556 of file class.ilRTEGlobalTemplate.php.

557 {
558 $this->setCurrentBlock("js_file");
559 if ($this->js_files_vp[$file]) {
560 $this->setVariable("JS_FILE", ilUtil::appendUrlParameterString($file, $vers));
561 } else {
562 $this->setVariable("JS_FILE", $file);
563 }
564 $this->parseCurrentBlock();
565 }

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()

ilRTEGlobalTemplate::fillJavaScriptFiles (   $a_force = false)

Implements ilGlobalTemplateInterface.

Definition at line 500 of file class.ilRTEGlobalTemplate.php.

501 {
502 global $DIC;
503
504 $ilSetting = $DIC->settings();
505
506 if (is_object($ilSetting)) { // maybe this one can be removed
507 $vers = "vers=" . str_replace(array(".", " "), "-", $ilSetting->get("ilias_version"));
508
509 if (DEVMODE) {
510 $vers .= '-' . time();
511 }
512 }
513 if ($this->blockExists("js_file")) {
514 // three batches
515 for ($i = 0; $i <= 3; $i++) {
516 reset($this->js_files);
517 foreach ($this->js_files as $file) {
518 if ($this->js_files_batch[$file] == $i) {
519 if (is_file($file) || substr($file, 0, 4) == "http" || substr($file, 0, 2) == "//" || $a_force) {
520 $this->fillJavascriptFile($file, $vers);
521 } elseif (substr($file, 0, 2) == './') { // #13962
522 $url_parts = parse_url($file);
523 if (is_file($url_parts['path'])) {
524 $this->fillJavascriptFile($file, $vers);
525 }
526 }
527 }
528 }
529 }
530 }
531 }
$i
Definition: metadata.php:24

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

Referenced by getSpecial(), and printToStdout().

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

◆ fillLeftContent()

ilRTEGlobalTemplate::fillLeftContent ( )
private

Definition at line 1109 of file class.ilRTEGlobalTemplate.php.

1110 {
1111 if (trim($this->left_content) != "") {
1112 $this->setCurrentBlock("left_column");
1113 $this->setVariable("LEFT_CONTENT", $this->left_content);
1114 $left_col_class = (trim($this->right_content) == "")
1115 ? "col-sm-3 col-sm-pull-9"
1116 : "col-sm-3 col-sm-pull-6";
1117 $this->setVariable("LEFT_COL_CLASS", $left_col_class);
1118 $this->parseCurrentBlock();
1119 }
1120 }

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

Referenced by getSpecial(), and printToStdout().

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

◆ fillLeftNav()

ilRTEGlobalTemplate::fillLeftNav ( )
private

Fill left navigation frame.

Definition at line 1058 of file class.ilRTEGlobalTemplate.php.

1059 {
1060 if (trim($this->left_nav_content) != "") {
1061 $this->setCurrentBlock("left_nav");
1062 $this->setVariable("LEFT_NAV_CONTENT", $this->left_nav_content);
1063 $this->parseCurrentBlock();
1064 $this->touchBlock("left_nav_space");
1065 }
1066 }
touchBlock($block)
overwrites ITX::touchBlock.

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

Referenced by getSpecial(), and printToStdout().

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

◆ fillLightbox()

ilRTEGlobalTemplate::fillLightbox ( )
private

Fill lightbox content.

Parameters

return

Definition at line 1639 of file class.ilRTEGlobalTemplate.php.

1640 {
1641 $html = "";
1642
1643 foreach ($this->lightbox as $lb) {
1644 $html .= $lb;
1645 }
1646 $this->setVariable("LIGHTBOX", $html);
1647 }

References setVariable().

Referenced by getSpecial(), and printToStdout().

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

◆ fillMainContent()

ilRTEGlobalTemplate::fillMainContent ( )
private

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

1103 {
1104 if (trim($this->main_content) != "") {
1105 $this->setVariable("ADM_CONTENT", $this->main_content);
1106 }
1107 }

References setVariable().

Referenced by getSpecial(), and printToStdout().

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

◆ fillMainMenu()

ilRTEGlobalTemplate::fillMainMenu ( )
private

Definition at line 276 of file class.ilRTEGlobalTemplate.php.

277 {
278 global $DIC;
279 $tpl = $DIC["tpl"];
280 if ($this->variableExists('MAINMENU')) {
281 $tpl->setVariable("MAINMENU", $this->main_menu);
282 $tpl->setVariable("MAINMENU_SPACER", $this->main_menu_spacer);
283 }
284 }
if($DIC->http() ->request() ->getMethod()=="GET" &&isset($DIC->http() ->request() ->getQueryParams()['tex'])) $tpl
Definition: latex.php:41

References $DIC, $tpl, and variableExists().

Referenced by getSpecial(), and printToStdout().

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

◆ fillMessage()

ilRTEGlobalTemplate::fillMessage ( )
private

Fill message area.

Definition at line 354 of file class.ilRTEGlobalTemplate.php.

355 {
356 global $DIC;
357
358 $out = "";
359
360 foreach (self::$message_types as $m) {
361 $txt = $this->getMessageTextForType($m);
362
363 if ($txt != "") {
365 }
366
367 $request = $DIC->http()->request();
368 $accept_header = $request->getHeaderLine('Accept');
369 if (isset($_SESSION[$m]) && $_SESSION[$m] && ($accept_header !== 'application/json')) {
370 unset($_SESSION[$m]);
371 }
372 }
373
374 if ($out != "") {
375 $this->setVariable("MESSAGE", $out);
376 }
377 }
$_SESSION["AccountId"]
static getSystemMessageHTML($a_txt, $a_type="info")
Get HTML for a system message.
$txt
Definition: error.php:13

References $_SESSION, $DIC, $out, $txt, getMessageTextForType(), ilUtil\getSystemMessageHTML(), and setVariable().

Referenced by getSpecial(), and printToStdout().

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

◆ fillNewContentStyle()

ilRTEGlobalTemplate::fillNewContentStyle ( )
private

Fill Content Style.

Definition at line 689 of file class.ilRTEGlobalTemplate.php.

690 {
691 $this->setVariable(
692 "LOCATION_NEWCONTENT_STYLESHEET_TAG",
693 '<link rel="stylesheet" type="text/css" href="' .
695 . '" />'
696 );
697 }
static getNewContentStyleSheetLocation($mode="output")
get full style sheet file name (path inclusive) of current user

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

Referenced by getSpecial(), and printToStdout().

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

◆ fillOnLoadCode()

ilRTEGlobalTemplate::fillOnLoadCode ( )
private

Fill add on load code.

Definition at line 536 of file class.ilRTEGlobalTemplate.php.

537 {
538 for ($i = 1; $i <= 3; $i++) {
539 if (is_array($this->on_load_code[$i])) {
540 $this->setCurrentBlock("on_load_code");
541 foreach ($this->on_load_code[$i] as $code) {
542 $this->setCurrentBlock("on_load_code_inner");
543 $this->setVariable("OLCODE", $code);
544 $this->parseCurrentBlock();
545 }
546 $this->setCurrentBlock("on_load_code");
547 $this->parseCurrentBlock();
548 }
549 }
550 }

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

Referenced by getSpecial(), and printToStdout().

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

◆ fillPageFormAction()

ilRTEGlobalTemplate::fillPageFormAction ( )
private

Definition at line 1224 of file class.ilRTEGlobalTemplate.php.

1225 {
1226 if ($this->page_form_action != "") {
1227 $this->setCurrentBlock("page_form_start");
1228 $this->setVariable("PAGE_FORM_ACTION", $this->page_form_action);
1229 $this->parseCurrentBlock();
1230 $this->touchBlock("page_form_end");
1231 }
1232 }

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

Referenced by fillAdminPanel().

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

◆ fillPermanentLink()

ilRTEGlobalTemplate::fillPermanentLink ( )
private

Fill in permanent link.

Definition at line 1729 of file class.ilRTEGlobalTemplate.php.

1730 {
1731 if (is_array($this->permanent_link)) {
1732 include_once("./Services/PermanentLink/classes/class.ilPermanentLinkGUI.php");
1733 $plinkgui = new ilPermanentLinkGUI(
1734 $this->permanent_link["type"],
1735 $this->permanent_link["id"],
1736 $this->permanent_link["append"],
1737 $this->permanent_link["target"]
1738 );
1739 if ($this->permanent_link["title"] != "") {
1740 $plinkgui->setTitle($this->permanent_link["title"]);
1741 }
1742 $this->setVariable("PRMLINK", $plinkgui->getHTML());
1743 }
1744 }
Class for permanent links.

References setVariable().

Referenced by getSpecial(), and printToStdout().

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

◆ fillRightContent()

ilRTEGlobalTemplate::fillRightContent ( )
private

Definition at line 1122 of file class.ilRTEGlobalTemplate.php.

1123 {
1124 if (trim($this->right_content) != "") {
1125 $this->setCurrentBlock("right_column");
1126 $this->setVariable("RIGHT_CONTENT", $this->right_content);
1127 $this->parseCurrentBlock();
1128 }
1129 }

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

Referenced by getSpecial(), and printToStdout().

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

◆ fillScreenReaderFocus()

ilRTEGlobalTemplate::fillScreenReaderFocus ( )
private

Accessibility focus for screen readers.

Definition at line 1552 of file class.ilRTEGlobalTemplate.php.

1553 {
1554 global $DIC;
1555
1556 $ilUser = $DIC->user();
1557
1558 if (is_object($ilUser) && $ilUser->getPref("screen_reader_optimization") && $this->blockExists("sr_focus")) {
1559 $this->touchBlock("sr_focus");
1560 }
1561 }

References $DIC, $ilUser, and touchBlock().

Referenced by getSpecial(), and printToStdout().

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

◆ fillSideIcons()

ilRTEGlobalTemplate::fillSideIcons ( )
private

Fill side icons (upper icon, tree icon, webfolder icon)

Definition at line 1566 of file class.ilRTEGlobalTemplate.php.

1567 {
1568 global $DIC;
1569
1570 $ilSetting = $DIC->settings();
1571
1572 $lng = $DIC->language();
1573
1574 // tree/flat icon
1575 if ($this->tree_flat_link != "") {
1576 if ($this->left_nav_content != "") {
1577 $this->touchBlock("tree_lns");
1578 }
1579
1580 $this->setCurrentBlock("tree_mode");
1581 $this->setVariable("LINK_MODE", $this->tree_flat_link);
1582 if ($ilSetting->get("tree_frame") == "right") {
1583 if ($this->tree_flat_mode == "tree") {
1584 $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
1585 $this->setVariable("RIGHT", "Right");
1586 } else {
1587 $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
1588 $this->setVariable("RIGHT", "Right");
1589 }
1590 } else {
1591 if ($this->tree_flat_mode == "tree") {
1592 $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
1593 } else {
1594 $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
1595 }
1596 }
1597 $this->setVariable("ALT_TREE", $lng->txt($this->tree_flat_mode . "view"));
1598 $this->setVariable("TARGET_TREE", ilFrameTargetInfo::_getFrame("MainContent"));
1599 include_once("./Services/Accessibility/classes/class.ilAccessKeyGUI.php");
1600 $this->setVariable(
1601 "TREE_ACC_KEY",
1602 ilAccessKeyGUI::getAttribute(($this->tree_flat_mode == "tree")
1605 );
1606 $this->parseCurrentBlock();
1607 }
1608
1609 $this->setCurrentBlock("tree_icons");
1610 $this->parseCurrentBlock();
1611 }
static getAttribute($a_func_id)
Get accesskey HTML attribute.
static _getFrame($a_class, $a_type='')
Get content frame name.

References $DIC, $ilSetting, $lng, ilFrameTargetInfo\_getFrame(), ilAccessKeyGUI\getAttribute(), ilUtil\getImagePath(), parseCurrentBlock(), setCurrentBlock(), setVariable(), touchBlock(), ilAccessKey\TREE_OFF, and ilAccessKey\TREE_ON.

Referenced by getSpecial(), and printToStdout().

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

◆ fillTabs()

ilRTEGlobalTemplate::fillTabs ( )
private

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

996 {
997 if ($this->blockExists("tabs_outer_start")) {
998 $this->touchBlock("tabs_outer_start");
999 $this->touchBlock("tabs_outer_end");
1000 $this->touchBlock("tabs_inner_start");
1001 $this->touchBlock("tabs_inner_end");
1002
1003 if ($this->tabs_html != "") {
1004 $this->setVariable("TABS", $this->tabs_html);
1005 }
1006 $this->setVariable("SUB_TABS", $this->sub_tabs_html);
1007 }
1008 }

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

Referenced by getSpecial(), and printToStdout().

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

◆ fillToolbar()

ilRTEGlobalTemplate::fillToolbar ( )
private

Definition at line 1138 of file class.ilRTEGlobalTemplate.php.

1139 {
1140 global $DIC;
1141
1142 $ilToolbar = $DIC["ilToolbar"];
1143 ;
1144
1145 $thtml = $ilToolbar->getHTML();
1146 if ($thtml != "") {
1147 $this->setCurrentBlock("toolbar_buttons");
1148 $this->setVariable("BUTTONS", $thtml);
1149 $this->parseCurrentBlock();
1150 }
1151 }

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

Referenced by getSpecial(), and printToStdout().

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

◆ fillWindowTitle()

ilRTEGlobalTemplate::fillWindowTitle ( )

Definition at line 1190 of file class.ilRTEGlobalTemplate.php.

1191 {
1192 global $DIC;
1193
1194 $ilSetting = $DIC->settings();
1195
1196 if ($this->header_page_title != "") {
1197 $title = ilUtil::stripScriptHTML($this->header_page_title);
1198 $this->setVariable("PAGETITLE", "- " . $title);
1199 }
1200
1201 if ($ilSetting->get('short_inst_name') != "") {
1202 $this->setVariable(
1203 "WINDOW_TITLE",
1204 $ilSetting->get('short_inst_name')
1205 );
1206 } else {
1207 $this->setVariable(
1208 "WINDOW_TITLE",
1209 "ILIAS"
1210 );
1211 }
1212 }

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

Referenced by getSpecial(), and printToStdout().

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

◆ get()

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

Implements ilGlobalTemplateInterface.

Definition at line 1780 of file class.ilRTEGlobalTemplate.php.

1781 {
1782 return $this->template->get($part);
1783 }

◆ getHeaderActionMenu()

ilRTEGlobalTemplate::getHeaderActionMenu ( )
private

Get header action menu.

Returns
int ref id

Definition at line 908 of file class.ilRTEGlobalTemplate.php.

References $header_action.

Referenced by fillHeader().

+ Here is the caller graph for this function:

◆ getLoginTargetPar()

ilRTEGlobalTemplate::getLoginTargetPar ( )
private

Get target parameter for login.

Definition at line 1252 of file class.ilRTEGlobalTemplate.php.

1253 {
1254 return $this->login_target_par;
1255 }

Referenced by getMainMenu().

+ Here is the caller graph for this function:

◆ getMainMenu()

ilRTEGlobalTemplate::getMainMenu ( )
private

Definition at line 263 of file class.ilRTEGlobalTemplate.php.

264 {
265 global $DIC;
266
267 $ilMainMenu = $DIC["ilMainMenu"];
268
269 if ($this->variableExists('MAINMENU')) {
270 $ilMainMenu->setLoginTargetPar($this->getLoginTargetPar());
271 $this->main_menu = $ilMainMenu->getHTML();
272 $this->main_menu_spacer = $ilMainMenu->getSpacerClass();
273 }
274 }
getLoginTargetPar()
Get target parameter for login.

References $DIC, getLoginTargetPar(), and variableExists().

Referenced by getSpecial(), and printToStdout().

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

◆ getMessageTextForType()

ilRTEGlobalTemplate::getMessageTextForType (   $m)
private
Parameters
$m
Returns
mixed|string

Definition at line 385 of file class.ilRTEGlobalTemplate.php.

386 {
387 $txt = "";
388 if (isset($_SESSION[$m]) && $_SESSION[$m] != "") {
389 $txt = $_SESSION[$m];
390 } else {
391 if (isset($this->message[$m])) {
392 $txt = $this->message[$m];
393 }
394 }
395
396 return $txt;
397 }

References $_SESSION, and $txt.

Referenced by fillMessage().

+ Here is the caller graph for this function:

◆ getOnLoadCodeForAsynch()

ilRTEGlobalTemplate::getOnLoadCodeForAsynch ( )

Get js onload code for ajax calls.

Returns
string

Implements ilGlobalTemplateInterface.

Definition at line 464 of file class.ilRTEGlobalTemplate.php.

465 {
466 $js = "";
467 for ($i = 1; $i <= 3; $i++) {
468 if (is_array($this->on_load_code[$i])) {
469 foreach ($this->on_load_code[$i] as $code) {
470 $js .= $code . "\n";
471 }
472 }
473 }
474 if ($js) {
475 return '<script type="text/javascript">' . "\n" .
476 $js .
477 '</script>' . "\n";
478 }
479 }

References $i.

◆ getSpecial()

ilRTEGlobalTemplate::getSpecial (   $part = "DEFAULT",
  $add_error_mess = false,
  $handle_referer = false,
  $add_ilias_footer = false,
  $add_standard_elements = false,
  $a_main_menu = true,
  $a_tabs = true 
)
Parameters
string
Returns
string

Implements ilGlobalTemplateInterface.

Definition at line 1276 of file class.ilRTEGlobalTemplate.php.

1284 {
1285 global $DIC;
1286
1287 if ($add_error_mess) {
1288 $this->fillMessage();
1289 }
1290
1291 if ($add_ilias_footer) {
1292 $this->fillFooter();
1293 }
1294
1295 // set standard parts (tabs and title icon)
1296 if ($add_standard_elements) {
1297 if ($this->blockExists("content") && $a_tabs) {
1298 // determine default screen id
1299 $this->getTabsHTML();
1300 }
1301
1302 // to get also the js files for the main menu
1303 $this->getMainMenu();
1304 $this->initHelp();
1305
1306 // these fill blocks in tpl.main.html
1307 $this->fillCssFiles();
1308 $this->fillInlineCss();
1309 $this->fillBodyClass();
1310
1311 // these fill just plain placeholder variables in tpl.main.html
1312 $this->setCurrentBlock("DEFAULT");
1313 $this->fillNewContentStyle();
1314 $this->fillContentLanguage();
1315 $this->fillWindowTitle();
1316
1317 // these fill blocks in tpl.adm_content.html
1318 $this->fillHeader();
1319 $this->fillSideIcons();
1320 $this->fillScreenReaderFocus();
1321 $this->fillLeftContent();
1322 $this->fillLeftNav();
1323 $this->fillRightContent();
1324 $this->fillAdminPanel();
1325 $this->fillToolbar();
1326 $this->fillPermanentLink();
1327
1328 $this->setCenterColumnClass();
1329
1330 // late loading of javascipr files, since operations above may add files
1331 $this->fillJavaScriptFiles();
1332 $this->fillOnLoadCode();
1333
1334 // these fill just plain placeholder variables in tpl.adm_content.html
1335 if ($this->blockExists("content")) {
1336 $this->setCurrentBlock("content");
1337 if ($a_tabs) {
1338 $this->fillTabs();
1339 }
1340 $this->fillMainContent();
1341 if ($a_main_menu) {
1342 $this->fillMainMenu();
1343 }
1344 $this->fillLightbox();
1345 $this->parseCurrentBlock();
1346 }
1347 }
1348
1349 if ($handle_referer) {
1350 $this->handleReferer();
1351 }
1352
1353 if ($part == "DEFAULT") {
1354 $html = $this->template->get();
1355 } else {
1356 $html = $this->template->get($part);
1357 }
1358
1359 // save language usages as late as possible
1361
1362 return $html;
1363 }
static _saveUsages()
Store the collected language variable usages in the user session This should be called as late as pos...
fillLeftNav()
Fill left navigation frame.
fillMessage()
Fill message area.
fillOnLoadCode()
Fill add on load code.
fillCssFiles($a_force=false)
Fill in the css file tags.
handleReferer()
TODO: this is nice, but shouldn't be done here (-> maybe at the end of ilias.php!?...
fillPermanentLink()
Fill in permanent link.
fillFooter()
Fill the footer area.
fillScreenReaderFocus()
Accessibility focus for screen readers.
fillNewContentStyle()
Fill Content Style.
fillContentLanguage()
Add current user language to meta tags.
fillSideIcons()
Fill side icons (upper icon, tree icon, webfolder icon)
fillInlineCss()
Fill in the inline css.
fillLightbox()
Fill lightbox content.
fillAdminPanel()
Put admin panel into template:

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

+ Here is the call graph for this function:

◆ getTabsHTML()

ilRTEGlobalTemplate::getTabsHTML ( )
private

Definition at line 1010 of file class.ilRTEGlobalTemplate.php.

1011 {
1012 global $DIC;
1013
1014 $ilTabs = $DIC["ilTabs"];
1015
1016 if ($this->blockExists("tabs_outer_start")) {
1017 $this->sub_tabs_html = $ilTabs->getSubTabHTML();
1018 $this->tabs_html = $ilTabs->getHTML(true);
1019 }
1020 }

References $DIC, and blockExists().

Referenced by getSpecial(), and printToStdout().

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

◆ handleReferer()

ilRTEGlobalTemplate::handleReferer ( )
private

TODO: this is nice, but shouldn't be done here (-> maybe at the end of ilias.php!?, alex)

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

1495 {
1496 if (((substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "error.php")
1497 && (substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "adm_menu.php")
1498 && (substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "chat.php"))) {
1499 // referer is modified if query string contains cmd=gateway and $_POST is not empty.
1500 // this is a workaround to display formular again in case of error and if the referer points to another page
1501 $url_parts = @parse_url($_SERVER["REQUEST_URI"]);
1502 if (!$url_parts) {
1503 $protocol = (isset($_SERVER['HTTPS']) ? 'https' : 'http') . '://';
1504 $host = $_SERVER['HTTP_HOST'];
1505 $path = $_SERVER['REQUEST_URI'];
1506 $url_parts = @parse_url($protocol . $host . $path);
1507 }
1508
1509 if (isset($url_parts["query"]) && preg_match("/cmd=gateway/", $url_parts["query"]) && (isset($_POST["cmd"]["create"]))) {
1510 foreach ($_POST as $key => $val) {
1511 if (is_array($val)) {
1512 $val = key($val);
1513 }
1514
1515 $str .= "&" . $key . "=" . $val;
1516 }
1517
1518 $_SESSION["referer"] = preg_replace("/cmd=gateway/", substr($str, 1), $_SERVER["REQUEST_URI"]);
1519 $_SESSION['referer_ref_id'] = (int) $_GET['ref_id'];
1520 } elseif (isset($url_parts["query"]) && preg_match("/cmd=post/", $url_parts["query"]) && (isset($_POST["cmd"]["create"]))) {
1521 foreach ($_POST as $key => $val) {
1522 if (is_array($val)) {
1523 $val = key($val);
1524 }
1525
1526 $str .= "&" . $key . "=" . $val;
1527 }
1528
1529 $_SESSION["referer"] = preg_replace("/cmd=post/", substr($str, 1), $_SERVER["REQUEST_URI"]);
1530 if (isset($_GET['ref_id'])) {
1531 $_SESSION['referer_ref_id'] = (int) $_GET['ref_id'];
1532 } else {
1533 $_SESSION['referer_ref_id'] = 0;
1534 }
1535 } else {
1536 $_SESSION["referer"] = $_SERVER["REQUEST_URI"];
1537 if (isset($_GET['ref_id'])) {
1538 $_SESSION['referer_ref_id'] = (int) $_GET['ref_id'];
1539 } else {
1540 $_SESSION['referer_ref_id'] = 0;
1541 }
1542 }
1543
1544 unset($_SESSION["error_post_vars"]);
1545 }
1546 }
$_POST["username"]

References $_GET, $_POST, $_SERVER, and $_SESSION.

Referenced by getSpecial(), and printToStdout().

+ Here is the caller graph for this function:

◆ hideFooter()

ilRTEGlobalTemplate::hideFooter ( )

Make the template hide the footer.

Implements ilGlobalTemplateInterface.

Definition at line 75 of file class.ilRTEGlobalTemplate.php.

76 {
77 $this->show_footer = false;
78 }

◆ initHelp()

ilRTEGlobalTemplate::initHelp ( )
private

Init help.

Definition at line 296 of file class.ilRTEGlobalTemplate.php.

297 {
298 include_once("./Services/Help/classes/class.ilHelpGUI.php");
299 //ilHelpGUI::initHelp($this);
300 }

Referenced by getSpecial(), and printToStdout().

+ Here is the caller graph for this function:

◆ loadStandardTemplate()

ilRTEGlobalTemplate::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 713 of file class.ilRTEGlobalTemplate.php.

714 {
715 if ($this->standard_template_loaded) {
716 return;
717 }
718
719 // always load jQuery
720 include_once("./Services/jQuery/classes/class.iljQueryUtil.php");
723
724 // always load ui framework
725 include_once("./Services/UICore/classes/class.ilUIFramework.php");
727
728 $this->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
729 $this->addBlockFile("STATUSLINE", "statusline", "tpl.statusline.html");
730
731 $this->standard_template_loaded = true;
732 }
addBlockFile($var, $block, $tplname, $in_module=false)
overwrites ITX::addBlockFile @access public
static init(ilGlobalTemplateInterface $a_tpl=null)
Init.
static initjQuery(ilGlobalTemplateInterface $a_tpl=null)
inits and adds the jQuery JS-File to the global or a passed template
static initjQueryUI($a_tpl=null)
inits and adds the jQuery-UI JS-File to the global template (see included_components....

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

+ Here is the call graph for this function:

◆ parseCurrentBlock()

ilRTEGlobalTemplate::parseCurrentBlock (   $part = "DEFAULT")

Überladene Funktion, die auf den aktuelle Block vorher noch ein replace ausführt @access public.

Parameters
string
Returns
string

Implements ilGlobalTemplateInterface.

Definition at line 1822 of file class.ilRTEGlobalTemplate.php.

1823 {
1824 return $this->template->parseCurrentBlock($part);
1825 }

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

+ Here is the caller graph for this function:

◆ printToStdout()

ilRTEGlobalTemplate::printToStdout (   $part = "DEFAULT",
  $a_fill_tabs = true,
  $a_skip_main_menu = false 
)
Parameters
string | bool$part
bool$a_fill_tabsfill template variable {TABS} with content of ilTabs
bool$a_skip_main_menu

Implements ilGlobalTemplateInterface.

Definition at line 1370 of file class.ilRTEGlobalTemplate.php.

1371 {
1372 global $DIC;
1373
1374 $http = $DIC->http();
1375 switch ($http->request()->getHeaderLine('Accept')) {
1376 case 'application/json':
1377 $string = json_encode([
1378 self::MESSAGE_TYPE_SUCCESS => is_null($this->message[self::MESSAGE_TYPE_FAILURE]),
1379 'message' => '',
1380 ]);
1382 $http->saveResponse($http->response()->withBody($stream));
1383 $http->sendResponse();
1384 exit;
1385 default:
1386 // include yahoo dom per default
1387 include_once("./Services/YUI/classes/class.ilYuiUtil.php");
1389
1390 header('P3P: CP="CURa ADMa DEVa TAIa PSAa PSDa IVAa IVDa OUR BUS IND UNI COM NAV INT CNT STA PRE"');
1391 header("Content-type: text/html; charset=UTF-8");
1392
1393 $this->fillMessage();
1394
1395 // display ILIAS footer
1396 if ($part !== false) {
1397 $this->fillFooter();
1398 }
1399
1400 // set standard parts (tabs and title icon)
1401 $this->fillBodyClass();
1402 if ($a_fill_tabs) {
1403 if ($this->blockExists("content")) {
1404 // determine default screen id
1405 $this->getTabsHTML();
1406 }
1407
1408 // to get also the js files for the main menu
1409 if (!$a_skip_main_menu) {
1410 $this->getMainMenu();
1411 $this->initHelp();
1412 }
1413
1414 // these fill blocks in tpl.main.html
1415 $this->fillCssFiles();
1416 $this->fillInlineCss();
1417 //$this->fillJavaScriptFiles();
1418
1419 // these fill just plain placeholder variables in tpl.main.html
1420 $this->setCurrentBlock("DEFAULT");
1421 $this->fillNewContentStyle();
1422 $this->fillContentLanguage();
1423 $this->fillWindowTitle();
1424
1425 // these fill blocks in tpl.adm_content.html
1426 $this->fillHeader();
1427 $this->fillSideIcons();
1428 $this->fillScreenReaderFocus();
1429 $this->fillLeftContent();
1430 $this->fillLeftNav();
1431 $this->fillRightContent();
1432 $this->fillAdminPanel();
1433 $this->fillToolbar();
1434 $this->fillPermanentLink();
1435
1436 $this->setCenterColumnClass();
1437
1438 // late loading of javascipr files, since operations above may add files
1439 $this->fillJavaScriptFiles();
1440 $this->fillOnLoadCode();
1441
1442 // these fill just plain placeholder variables in tpl.adm_content.html
1443 if ($this->blockExists("content")) {
1444 $this->setCurrentBlock("content");
1445 $this->fillTabs();
1446 $this->fillMainContent();
1447 $this->fillMainMenu();
1448 $this->fillLightbox();
1449 $this->parseCurrentBlock();
1450 }
1451 }
1452
1453 if ($part == "DEFAULT" or is_bool($part)) {
1454 $html = $this->template->getUnmodified();
1455 } else {
1456 $html = $this->template->getUnmodified($part);
1457 }
1458
1459 // Modification of html is done inline here and can't be done
1460 // by ilTemplate, because the "phase" is template_show in this
1461 // case here.
1462 $ilPluginAdmin = $DIC["ilPluginAdmin"];
1463 $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "UIComponent", "uihk");
1464 foreach ($pl_names as $pl) {
1465 $ui_plugin = ilPluginAdmin::getPluginObject(IL_COMP_SERVICE, "UIComponent", "uihk", $pl);
1466 $gui_class = $ui_plugin->getUIClassInstance();
1467
1468 $resp = $gui_class->getHTML(
1469 "",
1470 "template_show",
1471 array("tpl_id" => $this->tplIdentifier, "tpl_obj" => $this, "html" => $html)
1472 );
1473
1474 if ($resp["mode"] != ilUIHookPluginGUI::KEEP) {
1475 $html = $gui_class->modifyHTML($html, $resp);
1476 }
1477 }
1478
1479 // save language usages as late as possible
1481
1482 print $html;
1483
1484 $this->handleReferer();
1485 break;
1486 }
1487 }
if(! $in) print
static ofString($string)
Creates a new stream with an initial value.
Definition: Streams.php:25
const IL_COMP_SERVICE
static getPluginObject($a_ctype, $a_cname, $a_slot_id, $a_pname)
Get Plugin Object.
static initDom(ilGlobalTemplateInterface $a_main_tpl=null)
Init YUI Dom.
exit
Definition: login.php:29
$http
Definition: raiseError.php:7

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

+ Here is the call graph for this function:

◆ printToString()

ilRTEGlobalTemplate::printToString ( )

@inheritDoc

Implements ilGlobalTemplateInterface.

Definition at line 52 of file class.ilRTEGlobalTemplate.php.

52 : string
53 {
54 throw new ilException('not implemented');
55 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

◆ resetCss()

ilRTEGlobalTemplate::resetCss ( )
private

Reset css files.

Definition at line 664 of file class.ilRTEGlobalTemplate.php.

665 {
666 $this->css_files = array();
667 }

◆ resetHeaderBlock()

ilRTEGlobalTemplate::resetHeaderBlock (   $a_reset_header_action = true)

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

Implements ilGlobalTemplateInterface.

Definition at line 1749 of file class.ilRTEGlobalTemplate.php.

1750 {
1751 $this->setTitle(null);
1752 $this->setTitleIcon(null);
1753 $this->setDescription(null);
1754 $this->setAlertProperties(array());
1755 $this->enableDragDropFileUpload(null);
1756
1757 // see setFullscreenHeader()
1758 if ($a_reset_header_action) {
1759 $this->setHeaderActionMenu(null);
1760 }
1761 }
setHeaderActionMenu($a_header)
Set header action menu.
enableDragDropFileUpload($a_ref_id)
Enables the file upload into this object by dropping a file.

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

+ Here is the call graph for this function:

◆ resetJavascript()

ilRTEGlobalTemplate::resetJavascript ( )

Reset javascript files.

Implements ilGlobalTemplateInterface.

Definition at line 487 of file class.ilRTEGlobalTemplate.php.

488 {
489 $this->js_files = array();
490 $this->js_files_vp = array();
491 $this->js_files_batch = array();
492 }

◆ setAlertProperties()

ilRTEGlobalTemplate::setAlertProperties ( array  $a_props)

Set alert properties.

Parameters
array$a_props
Returns
void

Implements ilGlobalTemplateInterface.

Definition at line 780 of file class.ilRTEGlobalTemplate.php.

781 {
782 $this->title_alerts = $a_props;
783 }

Referenced by clearHeader(), and resetHeaderBlock().

+ Here is the caller graph for this function:

◆ setBodyClass()

ilRTEGlobalTemplate::setBodyClass (   $a_class = "")

Implements ilGlobalTemplateInterface.

Definition at line 647 of file class.ilRTEGlobalTemplate.php.

648 {
649 $this->body_class = $a_class;
650 }

Referenced by __construct().

+ Here is the caller graph for this function:

◆ setCenterColumnClass()

ilRTEGlobalTemplate::setCenterColumnClass ( )
private

Definition at line 1076 of file class.ilRTEGlobalTemplate.php.

1077 {
1078 if (!$this->blockExists("center_col_width")) {
1079 return;
1080 }
1081 $center_column_class = "";
1082 if (trim($this->right_content) != "" && trim($this->left_content) != "") {
1083 $center_column_class = "two_side_col";
1084 } elseif (trim($this->right_content) != "" || trim($this->left_content) != "") {
1085 $center_column_class = "one_side_col";
1086 }
1087
1088 switch ($center_column_class) {
1089 case "one_side_col": $center_column_class = "col-sm-9"; break;
1090 case "two_side_col": $center_column_class = "col-sm-6"; break;
1091 default: $center_column_class = "col-sm-12"; break;
1092 }
1093 if (trim($this->left_content) != "") {
1094 $center_column_class .= " col-sm-push-3";
1095 }
1096
1097 $this->setCurrentBlock("center_col_width");
1098 $this->setVariable("CENTER_COL", $center_column_class);
1099 $this->parseCurrentBlock();
1100 }

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

Referenced by getSpecial(), and printToStdout().

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

◆ setContent()

ilRTEGlobalTemplate::setContent (   $a_html)

Sets content for standard template.

Implements ilGlobalTemplateInterface.

Definition at line 1032 of file class.ilRTEGlobalTemplate.php.

1033 {
1034 if ($a_html != "") {
1035 $this->main_content = $a_html;
1036 }
1037 }

◆ setCurrentBlock()

ilRTEGlobalTemplate::setCurrentBlock (   $part = "DEFAULT")

@access public

Parameters
string
Returns
???

Implements ilGlobalTemplateInterface.

Definition at line 1800 of file class.ilRTEGlobalTemplate.php.

1801 {
1802 return $this->template->setCurrentBlock($part);
1803 }

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

+ Here is the caller graph for this function:

◆ setDescription()

ilRTEGlobalTemplate::setDescription (   $a_descr)

Sets descripton below title in standard template.

Implements ilGlobalTemplateInterface.

Definition at line 761 of file class.ilRTEGlobalTemplate.php.

762 {
763 $this->title_desc = $a_descr;
764 }

Referenced by clearHeader(), and resetHeaderBlock().

+ Here is the caller graph for this function:

◆ setHeaderActionMenu()

ilRTEGlobalTemplate::setHeaderActionMenu (   $a_header)

Set header action menu.

Parameters
string$a_gui$a_header

Implements ilGlobalTemplateInterface.

Definition at line 810 of file class.ilRTEGlobalTemplate.php.

811 {
812 $this->header_action = $a_header;
813 }

Referenced by resetHeaderBlock().

+ Here is the caller graph for this function:

◆ setHeaderPageTitle()

ilRTEGlobalTemplate::setHeaderPageTitle (   $a_title)

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

Implements ilGlobalTemplateInterface.

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

824 {
825 $this->header_page_title = $a_title;
826 }

◆ setLeftContent()

ilRTEGlobalTemplate::setLeftContent (   $a_html)

Sets content of left column.

Implements ilGlobalTemplateInterface.

Definition at line 1042 of file class.ilRTEGlobalTemplate.php.

1043 {
1044 $this->left_content = $a_html;
1045 }

◆ setLeftNavContent()

ilRTEGlobalTemplate::setLeftNavContent (   $a_content)

Sets content of left navigation column.

Implements ilGlobalTemplateInterface.

Definition at line 1050 of file class.ilRTEGlobalTemplate.php.

1051 {
1052 $this->left_nav_content = $a_content;
1053 }

◆ setLocator()

ilRTEGlobalTemplate::setLocator ( )

Insert locator.

Implements ilGlobalTemplateInterface.

Definition at line 923 of file class.ilRTEGlobalTemplate.php.

924 {
925 global $DIC;
926
927 $ilMainMenu = $DIC["ilMainMenu"];
928 $ilLocator = $DIC["ilLocator"];
929
930 $ilPluginAdmin = $DIC["ilPluginAdmin"];
931
932 // blog/portfolio
933 if ($ilMainMenu->getMode() == ilMainMenuGUI::MODE_TOPBAR_REDUCED ||
934 $ilMainMenu->getMode() == ilMainMenuGUI::MODE_TOPBAR_ONLY) {
935 $this->setVariable("LOCATOR", "");
936 return;
937 }
938
939 $html = "";
940 if (is_object($ilPluginAdmin)) {
941 include_once("./Services/UIComponent/classes/class.ilUIHookProcessor.php");
942 $html = $ilLocator->getHTML();
943 $uip = new ilUIHookProcessor(
944 "Services/Locator",
945 "main_locator",
946 array("locator_gui" => $ilLocator, "html" => $html)
947 );
948 $html = $uip->getHTML($html);
949 } else {
950 $html = $ilLocator->getHTML();
951 }
952
953 $this->setVariable("LOCATOR", $html);
954 }
Class ilUIHookProcessor.

References $DIC, ilMainMenuGUI\MODE_TOPBAR_ONLY, ilMainMenuGUI\MODE_TOPBAR_REDUCED, and setVariable().

+ Here is the call graph for this function:

◆ setLoginTargetPar()

ilRTEGlobalTemplate::setLoginTargetPar (   $a_val)

Set target parameter for login (public sector).

This is used by the main menu

Implements ilGlobalTemplateInterface.

Definition at line 1244 of file class.ilRTEGlobalTemplate.php.

1245 {
1246 $this->login_target_par = $a_val;
1247 }

◆ setOnScreenMessage()

ilRTEGlobalTemplate::setOnScreenMessage (   $a_type,
  $a_txt,
  $a_keep = false 
)

Set a message to be displayed to the user.

Please use ilUtil::sendInfo(), ilUtil::sendSuccess() and ilUtil::sendFailure()

Parameters
string$a_type\ilTemplate::MESSAGE_TYPE_SUCCESS, \ilTemplate::MESSAGE_TYPE_FAILURE,, \ilTemplate::MESSAGE_TYPE_QUESTION, \ilTemplate::MESSAGE_TYPE_INFO
string$a_txtThe message to be sent
bool$a_keepKeep this message over one redirect

Implements ilGlobalTemplateInterface.

Definition at line 339 of file class.ilRTEGlobalTemplate.php.

340 {
341 if (!in_array($a_type, self::$message_types) || $a_txt == "") {
342 return;
343 }
344 if (!$a_keep) {
345 $this->message[$a_type] = $a_txt;
346 } else {
347 $_SESSION[$a_type] = $a_txt;
348 }
349 }

References $_SESSION.

◆ setPageFormAction()

ilRTEGlobalTemplate::setPageFormAction (   $a_action)

Implements ilGlobalTemplateInterface.

Definition at line 1219 of file class.ilRTEGlobalTemplate.php.

1220 {
1221 $this->page_form_action = $a_action;
1222 }

◆ setPermanentLink()

ilRTEGlobalTemplate::setPermanentLink (   $a_type,
  $a_id,
  $a_append = "",
  $a_target = "",
  $a_title = "" 
)

Implements ilGlobalTemplateInterface.

Definition at line 1716 of file class.ilRTEGlobalTemplate.php.

1717 {
1718 $this->permanent_link = array(
1719 "type" => $a_type,
1720 "id" => $a_id,
1721 "append" => $a_append,
1722 "target" => $a_target,
1723 "title" => $a_title);
1724 }

◆ setRightContent()

ilRTEGlobalTemplate::setRightContent (   $a_html)

Sets content of right column.

Implements ilGlobalTemplateInterface.

Definition at line 1071 of file class.ilRTEGlobalTemplate.php.

1072 {
1073 $this->right_content = $a_html;
1074 }

◆ setSubTabs()

ilRTEGlobalTemplate::setSubTabs (   $a_tabs_html)

sets subtabs in standard template

Implements ilGlobalTemplateInterface.

Definition at line 990 of file class.ilRTEGlobalTemplate.php.

991 {
992 $this->setVariable("SUB_TABS", $a_tabs_html);
993 }

References setVariable().

+ Here is the call graph for this function:

◆ setTabs()

ilRTEGlobalTemplate::setTabs (   $a_tabs_html)

sets tabs in standard template

Implements ilGlobalTemplateInterface.

Definition at line 976 of file class.ilRTEGlobalTemplate.php.

977 {
978 if ($a_tabs_html != "" && $this->blockExists("tabs_outer_start")) {
979 $this->touchBlock("tabs_outer_start");
980 $this->touchBlock("tabs_outer_end");
981 $this->touchBlock("tabs_inner_start");
982 $this->touchBlock("tabs_inner_end");
983 $this->setVariable("TABS", $a_tabs_html);
984 }
985 }

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

+ Here is the call graph for this function:

◆ setTitle()

ilRTEGlobalTemplate::setTitle (   $a_title,
  $hidden = false 
)

Sets title in standard template.

Will override the header_page_title.

Implements ilGlobalTemplateInterface.

Definition at line 752 of file class.ilRTEGlobalTemplate.php.

753 {
754 $this->title = $a_title;
755 $this->header_page_title = $a_title;
756 }

Referenced by clearHeader(), and resetHeaderBlock().

+ Here is the caller graph for this function:

◆ setTitleIcon()

ilRTEGlobalTemplate::setTitleIcon (   $a_icon_path,
  $a_icon_desc = "" 
)

set title icon

Implements ilGlobalTemplateInterface.

Definition at line 769 of file class.ilRTEGlobalTemplate.php.

770 {
771 $this->icon_desc = $a_icon_desc;
772 $this->icon_path = $a_icon_path;
773 }

Referenced by clearHeader(), and resetHeaderBlock().

+ Here is the caller graph for this function:

◆ setTreeFlatIcon()

ilRTEGlobalTemplate::setTreeFlatIcon (   $a_link,
  $a_mode 
)

set tree/flat icon

Parameters
stringlink target
strongmode ("tree" | "flat")

Implements ilGlobalTemplateInterface.

Definition at line 1618 of file class.ilRTEGlobalTemplate.php.

1619 {
1620 $this->tree_flat_link = $a_link;
1621 $this->tree_flat_mode = $a_mode;
1622 }

◆ setVariable()

◆ touchBlock()

ilRTEGlobalTemplate::touchBlock (   $block)

overwrites ITX::touchBlock.

@access public

Parameters
string
Returns
???

Implements ilGlobalTemplateInterface.

Definition at line 1811 of file class.ilRTEGlobalTemplate.php.

1812 {
1813 return $this->template->touchBlock($block);
1814 }

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

+ Here is the caller graph for this function:

◆ variableExists()

ilRTEGlobalTemplate::variableExists (   $a_variablename)
private

Definition at line 1790 of file class.ilRTEGlobalTemplate.php.

1791 {
1792 return $this->template->variableExists($a_variablename);
1793 }

Referenced by fillMainMenu(), and getMainMenu().

+ Here is the caller graph for this function:

Field Documentation

◆ $admin_panel_arrow

ilRTEGlobalTemplate::$admin_panel_arrow = null
protected

Definition at line 1657 of file class.ilRTEGlobalTemplate.php.

◆ $admin_panel_bottom

ilRTEGlobalTemplate::$admin_panel_bottom = null
protected

Definition at line 1658 of file class.ilRTEGlobalTemplate.php.

◆ $admin_panel_commands_toolbar

ilRTEGlobalTemplate::$admin_panel_commands_toolbar = null
protected

Definition at line 1656 of file class.ilRTEGlobalTemplate.php.

Referenced by fillAdminPanel().

◆ $css_files

ilRTEGlobalTemplate::$css_files = array()
protected

Definition at line 578 of file class.ilRTEGlobalTemplate.php.

◆ $header_action

ilRTEGlobalTemplate::$header_action
protected

Definition at line 745 of file class.ilRTEGlobalTemplate.php.

Referenced by getHeaderActionMenu().

◆ $header_page_title

ilRTEGlobalTemplate::$header_page_title = ""
protected

Definition at line 741 of file class.ilRTEGlobalTemplate.php.

◆ $inline_css

ilRTEGlobalTemplate::$inline_css = array()
protected

Stores CSS to be included directly.

array

Definition at line 584 of file class.ilRTEGlobalTemplate.php.

◆ $js_files

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

Definition at line 409 of file class.ilRTEGlobalTemplate.php.

◆ $js_files_batch

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

Definition at line 421 of file class.ilRTEGlobalTemplate.php.

◆ $js_files_vp

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

Definition at line 415 of file class.ilRTEGlobalTemplate.php.

◆ $lightbox

ilRTEGlobalTemplate::$lightbox = array()
protected

Definition at line 19 of file class.ilRTEGlobalTemplate.php.

◆ $main_menu

ilRTEGlobalTemplate::$main_menu
protected

Definition at line 256 of file class.ilRTEGlobalTemplate.php.

◆ $main_menu_spacer

ilRTEGlobalTemplate::$main_menu_spacer
protected

Definition at line 261 of file class.ilRTEGlobalTemplate.php.

◆ $message

ilRTEGlobalTemplate::$message = array()
protected

Definition at line 326 of file class.ilRTEGlobalTemplate.php.

◆ $message_types

ilRTEGlobalTemplate::$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 319 of file class.ilRTEGlobalTemplate.php.

◆ $page_form_action

ilRTEGlobalTemplate::$page_form_action = ""
protected

Definition at line 16 of file class.ilRTEGlobalTemplate.php.

◆ $permanent_link

ilRTEGlobalTemplate::$permanent_link = false
protected

Definition at line 17 of file class.ilRTEGlobalTemplate.php.

◆ $show_footer

ilRTEGlobalTemplate::$show_footer = true
private

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

◆ $standard_template_loaded

ilRTEGlobalTemplate::$standard_template_loaded = false
protected

Definition at line 20 of file class.ilRTEGlobalTemplate.php.

◆ $sub_tabs_html

ilRTEGlobalTemplate::$sub_tabs_html = ""
protected

Definition at line 971 of file class.ilRTEGlobalTemplate.php.

◆ $tabs_html

ilRTEGlobalTemplate::$tabs_html = ""
protected

Definition at line 966 of file class.ilRTEGlobalTemplate.php.

◆ $template

ilRTEGlobalTemplate::$template
protected

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

◆ $title

ilRTEGlobalTemplate::$title = ""
protected

Definition at line 742 of file class.ilRTEGlobalTemplate.php.

Referenced by fillHeader(), and fillWindowTitle().

◆ $title_alerts

ilRTEGlobalTemplate::$title_alerts = array()
protected

Definition at line 744 of file class.ilRTEGlobalTemplate.php.

◆ $title_desc

ilRTEGlobalTemplate::$title_desc = ""
protected

Definition at line 743 of file class.ilRTEGlobalTemplate.php.

◆ $tree_flat_link

ilRTEGlobalTemplate::$tree_flat_link = ""
protected

Definition at line 15 of file class.ilRTEGlobalTemplate.php.

◆ MESSAGE_TYPE_FAILURE

const ilRTEGlobalTemplate::MESSAGE_TYPE_FAILURE = 'failure'

Definition at line 311 of file class.ilRTEGlobalTemplate.php.

◆ MESSAGE_TYPE_INFO

const ilRTEGlobalTemplate::MESSAGE_TYPE_INFO = "info"

Definition at line 312 of file class.ilRTEGlobalTemplate.php.

◆ MESSAGE_TYPE_QUESTION

const ilRTEGlobalTemplate::MESSAGE_TYPE_QUESTION = "question"

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

◆ MESSAGE_TYPE_SUCCESS

const ilRTEGlobalTemplate::MESSAGE_TYPE_SUCCESS = "success"

Definition at line 313 of file class.ilRTEGlobalTemplate.php.


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