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

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

+ Inheritance diagram for ilCOPageGlobalTemplate:
+ Collaboration diagram for ilCOPageGlobalTemplate:

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...
 
 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...
 
 fillWindowTitle ()
 
 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.ilCOPageGlobalTemplate.php.

Constructor & Destructor Documentation

◆ __construct()

ilCOPageGlobalTemplate::__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.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::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 1649 of file class.ilCOPageGlobalTemplate.php.

1650 {
1651 $this->admin_panel_commands_toolbar = $toolb;
1652 $this->admin_panel_arrow = $a_arrow;
1653 $this->admin_panel_bottom = $a_bottom_panel;
1654 }

◆ addBlockFile()

ilCOPageGlobalTemplate::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 1819 of file class.ilCOPageGlobalTemplate.php.

1820 {
1821 return $this->template->addBlockFile($var, $block, $tplname, $in_module);
1822 }

Referenced by loadStandardTemplate().

+ Here is the caller graph for this function:

◆ addCss()

ilCOPageGlobalTemplate::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.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::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.ilCOPageGlobalTemplate.php.

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

◆ addJavaScript()

ilCOPageGlobalTemplate::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.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::addLightbox (   $a_html,
  $a_id 
)

Add lightbox html.

Implements ilGlobalTemplateInterface.

Definition at line 1611 of file class.ilCOPageGlobalTemplate.php.

1612 {
1613 $this->lightbox[$a_id] = $a_html;
1614 }

◆ addOnLoadCode()

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

Add on load code.

Implements ilGlobalTemplateInterface.

Definition at line 450 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::blockExists (   $a_blockname)

check if block exists in actual template @access private

Parameters
stringblockname
Returns
boolean

Implements ilGlobalTemplateInterface.

Definition at line 1830 of file class.ilCOPageGlobalTemplate.php.

1831 {
1832 return $this->template->blockExists($a_blockname);
1833 }

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

+ Here is the caller graph for this function:

◆ clearHeader()

ilCOPageGlobalTemplate::clearHeader ( )

Clear header.

Implements ilGlobalTemplateInterface.

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

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

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

+ Here is the call graph for this function:

◆ enableDragDropFileUpload()

ilCOPageGlobalTemplate::enableDragDropFileUpload (   $a_ref_id)

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

Implements ilGlobalTemplateInterface.

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

1750 {
1751 $this->enable_fileupload = $a_ref_id;
1752 }

Referenced by resetHeaderBlock().

+ Here is the caller graph for this function:

◆ fillAdminPanel()

ilCOPageGlobalTemplate::fillAdminPanel ( )
private

Put admin panel into template:

  • creation selector
  • admin view on/off button

Definition at line 1661 of file class.ilCOPageGlobalTemplate.php.

1662 {
1663 global $DIC;
1664 $lng = $DIC->language();
1665
1666 if ($this->admin_panel_commands_toolbar === null) {
1667 return;
1668 }
1669
1671 assert($toolbar instanceof \ilToolbarGUI);
1672
1673 // Add arrow if desired.
1674 if ($this->admin_panel_arrow) {
1675 $toolb->setLeadingImage(ilUtil::getImagePath("arrow_upright.svg"), $lng->txt("actions"));
1676 }
1677
1678 $this->fillPageFormAction();
1679
1680 // Add top admin bar.
1681 $this->setCurrentBlock("adm_view_components");
1682 $this->setVariable("ADM_PANEL1", $toolb->getHTML());
1683 $this->parseCurrentBlock();
1684
1685 // Add bottom admin bar if user wants one.
1686 if ($this->admin_panel_bottom) {
1687 $this->setCurrentBlock("adm_view_components2");
1688
1689 // Replace previously set arrow image.
1690 if ($this->admin_panel_arrow) {
1691 $toolb->setLeadingImage(ilUtil::getImagePath("arrow_downright.svg"), $lng->txt("actions"));
1692 }
1693
1694 $this->setVariable("ADM_PANEL2", $toolb->getHTML());
1695 $this->parseCurrentBlock();
1696 }
1697 }
setCurrentBlock($part="DEFAULT")
@access public
parseCurrentBlock($part="DEFAULT")
Überladene Funktion, die auf den aktuelle Block vorher noch ein replace ausführt @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()

ilCOPageGlobalTemplate::fillBodyClass ( )
private

Definition at line 652 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::fillContentLanguage ( )
private

Add current user language to meta tags.

Definition at line 1162 of file class.ilCOPageGlobalTemplate.php.

1163 {
1164 global $DIC;
1165 $lng = $DIC->language();
1166
1167 if (is_object($lng)) {
1168 $this->setVariable('META_CONTENT_LANGUAGE', $lng->getContentLanguage());
1169 $this->setVariable('LANGUAGE_DIRECTION', $lng->getTextDirection());
1170 }
1171 }

References $DIC, $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()

ilCOPageGlobalTemplate::fillCssFiles (   $a_force = false)

Fill in the css file tags.

Parameters
boolean$a_force

Definition at line 618 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::fillFooter ( )
private

Fill the footer area.

Definition at line 83 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::fillHeader ( )
private

Fill header.

Definition at line 831 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::fillInlineCss ( )
private

Fill in the inline css.

Parameters
boolean$a_force

Definition at line 674 of file class.ilCOPageGlobalTemplate.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()

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

Definition at line 556 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::fillJavaScriptFiles (   $a_force = false)

Implements ilGlobalTemplateInterface.

Definition at line 500 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::fillLeftContent ( )
private

Definition at line 1111 of file class.ilCOPageGlobalTemplate.php.

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

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

ilCOPageGlobalTemplate::fillLeftNav ( )
private

Fill left navigation frame.

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

1061 {
1062 if (trim($this->left_nav_content) != "") {
1063 $this->setCurrentBlock("left_nav");
1064 $this->setVariable("LEFT_NAV_CONTENT", $this->left_nav_content);
1065 $this->parseCurrentBlock();
1066 $this->touchBlock("left_nav_space");
1067 }
1068 }
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()

ilCOPageGlobalTemplate::fillLightbox ( )
private

Fill lightbox content.

Parameters

return

Definition at line 1622 of file class.ilCOPageGlobalTemplate.php.

1623 {
1624 $html = "";
1625
1626 foreach ($this->lightbox as $lb) {
1627 $html .= $lb;
1628 }
1629 $this->setVariable("LIGHTBOX", $html);
1630 }

References setVariable().

Referenced by getSpecial(), and printToStdout().

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

◆ fillMainContent()

ilCOPageGlobalTemplate::fillMainContent ( )
private

Definition at line 1104 of file class.ilCOPageGlobalTemplate.php.

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

References setVariable().

Referenced by getSpecial(), and printToStdout().

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

◆ fillMainMenu()

ilCOPageGlobalTemplate::fillMainMenu ( )
private

Definition at line 276 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::fillMessage ( )
private

Fill message area.

Definition at line 354 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::fillNewContentStyle ( )
private

Fill Content Style.

Definition at line 689 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::fillOnLoadCode ( )
private

Fill add on load code.

Definition at line 536 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::fillPageFormAction ( )
private

Definition at line 1207 of file class.ilCOPageGlobalTemplate.php.

1208 {
1209 if ($this->page_form_action != "") {
1210 $this->setCurrentBlock("page_form_start");
1211 $this->setVariable("PAGE_FORM_ACTION", $this->page_form_action);
1212 $this->parseCurrentBlock();
1213 $this->touchBlock("page_form_end");
1214 }
1215 }

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

ilCOPageGlobalTemplate::fillPermanentLink ( )
private

Fill in permanent link.

Definition at line 1712 of file class.ilCOPageGlobalTemplate.php.

1713 {
1714 if (is_array($this->permanent_link)) {
1715 include_once("./Services/PermanentLink/classes/class.ilPermanentLinkGUI.php");
1716 $plinkgui = new ilPermanentLinkGUI(
1717 $this->permanent_link["type"],
1718 $this->permanent_link["id"],
1719 $this->permanent_link["append"],
1720 $this->permanent_link["target"]
1721 );
1722 if ($this->permanent_link["title"] != "") {
1723 $plinkgui->setTitle($this->permanent_link["title"]);
1724 }
1725 $this->setVariable("PRMLINK", $plinkgui->getHTML());
1726 }
1727 }
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()

ilCOPageGlobalTemplate::fillRightContent ( )
private

Definition at line 1124 of file class.ilCOPageGlobalTemplate.php.

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

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

ilCOPageGlobalTemplate::fillScreenReaderFocus ( )
private

Accessibility focus for screen readers.

Definition at line 1535 of file class.ilCOPageGlobalTemplate.php.

1536 {
1537 global $DIC;
1538
1539 $ilUser = $DIC->user();
1540
1541 if (is_object($ilUser) && $ilUser->getPref("screen_reader_optimization") && $this->blockExists("sr_focus")) {
1542 $this->touchBlock("sr_focus");
1543 }
1544 }
$ilUser
Definition: imgupload.php:18

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

ilCOPageGlobalTemplate::fillSideIcons ( )
private

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

Definition at line 1549 of file class.ilCOPageGlobalTemplate.php.

1550 {
1551 global $DIC;
1552
1553 $ilSetting = $DIC->settings();
1554
1555 $lng = $DIC->language();
1556
1557 // tree/flat icon
1558 if ($this->tree_flat_link != "") {
1559 if ($this->left_nav_content != "") {
1560 $this->touchBlock("tree_lns");
1561 }
1562
1563 $this->setCurrentBlock("tree_mode");
1564 $this->setVariable("LINK_MODE", $this->tree_flat_link);
1565 if ($ilSetting->get("tree_frame") == "right") {
1566 if ($this->tree_flat_mode == "tree") {
1567 $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
1568 $this->setVariable("RIGHT", "Right");
1569 } else {
1570 $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
1571 $this->setVariable("RIGHT", "Right");
1572 }
1573 } else {
1574 if ($this->tree_flat_mode == "tree") {
1575 $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
1576 } else {
1577 $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
1578 }
1579 }
1580 $this->setVariable("ALT_TREE", $lng->txt($this->tree_flat_mode . "view"));
1581 $this->setVariable("TARGET_TREE", ilFrameTargetInfo::_getFrame("MainContent"));
1582 include_once("./Services/Accessibility/classes/class.ilAccessKeyGUI.php");
1583 $this->setVariable(
1584 "TREE_ACC_KEY",
1585 ilAccessKeyGUI::getAttribute(($this->tree_flat_mode == "tree")
1588 );
1589 $this->parseCurrentBlock();
1590 }
1591
1592 $this->setCurrentBlock("tree_icons");
1593 $this->parseCurrentBlock();
1594 }
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()

ilCOPageGlobalTemplate::fillTabs ( )
private

Definition at line 997 of file class.ilCOPageGlobalTemplate.php.

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

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

ilCOPageGlobalTemplate::fillToolbar ( )
private

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

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

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

ilCOPageGlobalTemplate::fillWindowTitle ( )
private

Definition at line 1173 of file class.ilCOPageGlobalTemplate.php.

1174 {
1175 global $DIC;
1176
1177 $ilSetting = $DIC->settings();
1178
1179 if ($this->header_page_title != "") {
1180 $title = ilUtil::stripScriptHTML($this->header_page_title);
1181 $this->setVariable("PAGETITLE", "- " . $title);
1182 }
1183
1184 if ($ilSetting->get('short_inst_name') != "") {
1185 $this->setVariable(
1186 "WINDOW_TITLE",
1187 $ilSetting->get('short_inst_name')
1188 );
1189 } else {
1190 $this->setVariable(
1191 "WINDOW_TITLE",
1192 "ILIAS"
1193 );
1194 }
1195 }

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

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

Implements ilGlobalTemplateInterface.

Definition at line 1763 of file class.ilCOPageGlobalTemplate.php.

1764 {
1765 return $this->template->get($part);
1766 }

◆ getHeaderActionMenu()

ilCOPageGlobalTemplate::getHeaderActionMenu ( )
private

Get header action menu.

Returns
int ref id

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

References $header_action.

Referenced by fillHeader().

+ Here is the caller graph for this function:

◆ getLoginTargetPar()

ilCOPageGlobalTemplate::getLoginTargetPar ( )
private

Get target parameter for login.

Definition at line 1235 of file class.ilCOPageGlobalTemplate.php.

1236 {
1237 return $this->login_target_par;
1238 }

Referenced by getMainMenu().

+ Here is the caller graph for this function:

◆ getMainMenu()

ilCOPageGlobalTemplate::getMainMenu ( )
private

Definition at line 263 of file class.ilCOPageGlobalTemplate.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()

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

Definition at line 385 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::getOnLoadCodeForAsynch ( )

Get js onload code for ajax calls.

Returns
string

Implements ilGlobalTemplateInterface.

Definition at line 464 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::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 1259 of file class.ilCOPageGlobalTemplate.php.

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

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

ilCOPageGlobalTemplate::getTabsHTML ( )
private

Definition at line 1012 of file class.ilCOPageGlobalTemplate.php.

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

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

ilCOPageGlobalTemplate::handleReferer ( )
private

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

Definition at line 1477 of file class.ilCOPageGlobalTemplate.php.

1478 {
1479 if (((substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "error.php")
1480 && (substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "adm_menu.php")
1481 && (substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "chat.php"))) {
1482 // referer is modified if query string contains cmd=gateway and $_POST is not empty.
1483 // this is a workaround to display formular again in case of error and if the referer points to another page
1484 $url_parts = @parse_url($_SERVER["REQUEST_URI"]);
1485 if (!$url_parts) {
1486 $protocol = (isset($_SERVER['HTTPS']) ? 'https' : 'http') . '://';
1487 $host = $_SERVER['HTTP_HOST'];
1488 $path = $_SERVER['REQUEST_URI'];
1489 $url_parts = @parse_url($protocol . $host . $path);
1490 }
1491
1492 if (isset($url_parts["query"]) && preg_match("/cmd=gateway/", $url_parts["query"]) && (isset($_POST["cmd"]["create"]))) {
1493 foreach ($_POST as $key => $val) {
1494 if (is_array($val)) {
1495 $val = key($val);
1496 }
1497
1498 $str .= "&" . $key . "=" . $val;
1499 }
1500
1501 $_SESSION["referer"] = preg_replace("/cmd=gateway/", substr($str, 1), $_SERVER["REQUEST_URI"]);
1502 $_SESSION['referer_ref_id'] = (int) $_GET['ref_id'];
1503 } elseif (isset($url_parts["query"]) && preg_match("/cmd=post/", $url_parts["query"]) && (isset($_POST["cmd"]["create"]))) {
1504 foreach ($_POST as $key => $val) {
1505 if (is_array($val)) {
1506 $val = key($val);
1507 }
1508
1509 $str .= "&" . $key . "=" . $val;
1510 }
1511
1512 $_SESSION["referer"] = preg_replace("/cmd=post/", substr($str, 1), $_SERVER["REQUEST_URI"]);
1513 if (isset($_GET['ref_id'])) {
1514 $_SESSION['referer_ref_id'] = (int) $_GET['ref_id'];
1515 } else {
1516 $_SESSION['referer_ref_id'] = 0;
1517 }
1518 } else {
1519 $_SESSION["referer"] = $_SERVER["REQUEST_URI"];
1520 if (isset($_GET['ref_id'])) {
1521 $_SESSION['referer_ref_id'] = (int) $_GET['ref_id'];
1522 } else {
1523 $_SESSION['referer_ref_id'] = 0;
1524 }
1525 }
1526
1527 unset($_SESSION["error_post_vars"]);
1528 }
1529 }
$_POST["username"]

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

Referenced by getSpecial(), and printToStdout().

+ Here is the caller graph for this function:

◆ hideFooter()

ilCOPageGlobalTemplate::hideFooter ( )

Make the template hide the footer.

Implements ilGlobalTemplateInterface.

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

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

◆ initHelp()

ilCOPageGlobalTemplate::initHelp ( )
private

Init help.

Definition at line 296 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::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.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::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 1805 of file class.ilCOPageGlobalTemplate.php.

1806 {
1807 return $this->template->parseCurrentBlock($part);
1808 }

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

ilCOPageGlobalTemplate::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 1353 of file class.ilCOPageGlobalTemplate.php.

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

ilCOPageGlobalTemplate::printToString ( )

@inheritDoc

Implements ilGlobalTemplateInterface.

Definition at line 52 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::resetCss ( )
private

Reset css files.

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

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

◆ resetHeaderBlock()

ilCOPageGlobalTemplate::resetHeaderBlock (   $a_reset_header_action = true)

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

Implements ilGlobalTemplateInterface.

Definition at line 1732 of file class.ilCOPageGlobalTemplate.php.

1733 {
1734 $this->setTitle(null);
1735 $this->setTitleIcon(null);
1736 $this->setDescription(null);
1737 $this->setAlertProperties(array());
1738 $this->enableDragDropFileUpload(null);
1739
1740 // see setFullscreenHeader()
1741 if ($a_reset_header_action) {
1742 $this->setHeaderActionMenu(null);
1743 }
1744 }
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()

ilCOPageGlobalTemplate::resetJavascript ( )

Reset javascript files.

Implements ilGlobalTemplateInterface.

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

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

◆ setAlertProperties()

ilCOPageGlobalTemplate::setAlertProperties ( array  $a_props)

Set alert properties.

Parameters
array$a_props
Returns
void

Implements ilGlobalTemplateInterface.

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

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

Referenced by clearHeader(), and resetHeaderBlock().

+ Here is the caller graph for this function:

◆ setBodyClass()

ilCOPageGlobalTemplate::setBodyClass (   $a_class = "")

Implements ilGlobalTemplateInterface.

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

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

Referenced by __construct().

+ Here is the caller graph for this function:

◆ setCenterColumnClass()

ilCOPageGlobalTemplate::setCenterColumnClass ( )
private

Definition at line 1078 of file class.ilCOPageGlobalTemplate.php.

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

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

ilCOPageGlobalTemplate::setContent (   $a_html)

Sets content for standard template.

Implements ilGlobalTemplateInterface.

Definition at line 1034 of file class.ilCOPageGlobalTemplate.php.

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

◆ setCurrentBlock()

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

@access public

Parameters
string
Returns
???

Implements ilGlobalTemplateInterface.

Definition at line 1783 of file class.ilCOPageGlobalTemplate.php.

1784 {
1785 return $this->template->setCurrentBlock($part);
1786 }

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

ilCOPageGlobalTemplate::setDescription (   $a_descr)

Sets descripton below title in standard template.

Implements ilGlobalTemplateInterface.

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

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

Referenced by clearHeader(), and resetHeaderBlock().

+ Here is the caller graph for this function:

◆ setHeaderActionMenu()

ilCOPageGlobalTemplate::setHeaderActionMenu (   $a_header)

Set header action menu.

Parameters
string$a_gui$a_header

Implements ilGlobalTemplateInterface.

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

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

Referenced by resetHeaderBlock().

+ Here is the caller graph for this function:

◆ setHeaderPageTitle()

ilCOPageGlobalTemplate::setHeaderPageTitle (   $a_title)

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

Implements ilGlobalTemplateInterface.

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

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

◆ setLeftContent()

ilCOPageGlobalTemplate::setLeftContent (   $a_html)

Sets content of left column.

Implements ilGlobalTemplateInterface.

Definition at line 1044 of file class.ilCOPageGlobalTemplate.php.

1045 {
1046 $this->left_content = $a_html;
1047 }

◆ setLeftNavContent()

ilCOPageGlobalTemplate::setLeftNavContent (   $a_content)

Sets content of left navigation column.

Implements ilGlobalTemplateInterface.

Definition at line 1052 of file class.ilCOPageGlobalTemplate.php.

1053 {
1054 $this->left_nav_content = $a_content;
1055 }

◆ setLocator()

ilCOPageGlobalTemplate::setLocator ( )

Insert locator.

Implements ilGlobalTemplateInterface.

Definition at line 923 of file class.ilCOPageGlobalTemplate.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 $uip = new ilUIHookProcessor(
943 "Services/Locator",
944 "main_locator",
945 array("locator_gui" => $ilLocator)
946 );
947 if (!$uip->replaced()) {
948 $html = $ilLocator->getHTML();
949 }
950 $html = $uip->getHTML($html);
951 } else {
952 $html = $ilLocator->getHTML();
953 }
954
955 $this->setVariable("LOCATOR", $html);
956 }
Class ilUIHookProcessor.

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

+ Here is the call graph for this function:

◆ setLoginTargetPar()

ilCOPageGlobalTemplate::setLoginTargetPar (   $a_val)

Set target parameter for login (public sector).

This is used by the main menu

Implements ilGlobalTemplateInterface.

Definition at line 1227 of file class.ilCOPageGlobalTemplate.php.

1228 {
1229 $this->login_target_par = $a_val;
1230 }

◆ setOnScreenMessage()

ilCOPageGlobalTemplate::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.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::setPageFormAction (   $a_action)

Implements ilGlobalTemplateInterface.

Definition at line 1202 of file class.ilCOPageGlobalTemplate.php.

1203 {
1204 $this->page_form_action = $a_action;
1205 }

◆ setPermanentLink()

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

Implements ilGlobalTemplateInterface.

Definition at line 1699 of file class.ilCOPageGlobalTemplate.php.

1700 {
1701 $this->permanent_link = array(
1702 "type" => $a_type,
1703 "id" => $a_id,
1704 "append" => $a_append,
1705 "target" => $a_target,
1706 "title" => $a_title);
1707 }

◆ setRightContent()

ilCOPageGlobalTemplate::setRightContent (   $a_html)

Sets content of right column.

Implements ilGlobalTemplateInterface.

Definition at line 1073 of file class.ilCOPageGlobalTemplate.php.

1074 {
1075 $this->right_content = $a_html;
1076 }

◆ setSubTabs()

ilCOPageGlobalTemplate::setSubTabs (   $a_tabs_html)

sets subtabs in standard template

Implements ilGlobalTemplateInterface.

Definition at line 992 of file class.ilCOPageGlobalTemplate.php.

993 {
994 $this->setVariable("SUB_TABS", $a_tabs_html);
995 }

References setVariable().

+ Here is the call graph for this function:

◆ setTabs()

ilCOPageGlobalTemplate::setTabs (   $a_tabs_html)

sets tabs in standard template

Implements ilGlobalTemplateInterface.

Definition at line 978 of file class.ilCOPageGlobalTemplate.php.

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

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

+ Here is the call graph for this function:

◆ setTitle()

ilCOPageGlobalTemplate::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.ilCOPageGlobalTemplate.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()

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

set title icon

Implements ilGlobalTemplateInterface.

Definition at line 769 of file class.ilCOPageGlobalTemplate.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()

ilCOPageGlobalTemplate::setTreeFlatIcon (   $a_link,
  $a_mode 
)

set tree/flat icon

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

Implements ilGlobalTemplateInterface.

Definition at line 1601 of file class.ilCOPageGlobalTemplate.php.

1602 {
1603 $this->tree_flat_link = $a_link;
1604 $this->tree_flat_mode = $a_mode;
1605 }

◆ setVariable()

◆ touchBlock()

ilCOPageGlobalTemplate::touchBlock (   $block)

overwrites ITX::touchBlock.

@access public

Parameters
string
Returns
???

Implements ilGlobalTemplateInterface.

Definition at line 1794 of file class.ilCOPageGlobalTemplate.php.

1795 {
1796 return $this->template->touchBlock($block);
1797 }

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

+ Here is the caller graph for this function:

◆ variableExists()

ilCOPageGlobalTemplate::variableExists (   $a_variablename)
private

Definition at line 1773 of file class.ilCOPageGlobalTemplate.php.

1774 {
1775 return $this->template->variableExists($a_variablename);
1776 }

Referenced by fillMainMenu(), and getMainMenu().

+ Here is the caller graph for this function:

Field Documentation

◆ $admin_panel_arrow

ilCOPageGlobalTemplate::$admin_panel_arrow = null
protected

Definition at line 1640 of file class.ilCOPageGlobalTemplate.php.

◆ $admin_panel_bottom

ilCOPageGlobalTemplate::$admin_panel_bottom = null
protected

Definition at line 1641 of file class.ilCOPageGlobalTemplate.php.

◆ $admin_panel_commands_toolbar

ilCOPageGlobalTemplate::$admin_panel_commands_toolbar = null
protected

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

Referenced by fillAdminPanel().

◆ $css_files

ilCOPageGlobalTemplate::$css_files = array()
protected

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

◆ $header_action

ilCOPageGlobalTemplate::$header_action
protected

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

Referenced by getHeaderActionMenu().

◆ $header_page_title

ilCOPageGlobalTemplate::$header_page_title = ""
protected

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

◆ $inline_css

ilCOPageGlobalTemplate::$inline_css = array()
protected

Stores CSS to be included directly.

array

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

◆ $js_files

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

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

◆ $js_files_batch

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

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

◆ $js_files_vp

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

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

◆ $lightbox

ilCOPageGlobalTemplate::$lightbox = array()
protected

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

◆ $main_menu

ilCOPageGlobalTemplate::$main_menu
protected

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

◆ $main_menu_spacer

ilCOPageGlobalTemplate::$main_menu_spacer
protected

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

◆ $message

ilCOPageGlobalTemplate::$message = array()
protected

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

◆ $message_types

ilCOPageGlobalTemplate::$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.ilCOPageGlobalTemplate.php.

◆ $page_form_action

ilCOPageGlobalTemplate::$page_form_action = ""
protected

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

◆ $permanent_link

ilCOPageGlobalTemplate::$permanent_link = false
protected

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

◆ $show_footer

ilCOPageGlobalTemplate::$show_footer = true
private

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

◆ $standard_template_loaded

ilCOPageGlobalTemplate::$standard_template_loaded = false
protected

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

◆ $sub_tabs_html

ilCOPageGlobalTemplate::$sub_tabs_html = ""
protected

Definition at line 973 of file class.ilCOPageGlobalTemplate.php.

◆ $tabs_html

ilCOPageGlobalTemplate::$tabs_html = ""
protected

Definition at line 968 of file class.ilCOPageGlobalTemplate.php.

◆ $template

ilCOPageGlobalTemplate::$template
protected

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

◆ $title

ilCOPageGlobalTemplate::$title = ""
protected

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

Referenced by fillHeader(), and fillWindowTitle().

◆ $title_alerts

ilCOPageGlobalTemplate::$title_alerts = array()
protected

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

◆ $title_desc

ilCOPageGlobalTemplate::$title_desc = ""
protected

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

◆ $tree_flat_link

ilCOPageGlobalTemplate::$tree_flat_link = ""
protected

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

◆ MESSAGE_TYPE_FAILURE

const ilCOPageGlobalTemplate::MESSAGE_TYPE_FAILURE = 'failure'

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

◆ MESSAGE_TYPE_INFO

const ilCOPageGlobalTemplate::MESSAGE_TYPE_INFO = "info"

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

◆ MESSAGE_TYPE_QUESTION

const ilCOPageGlobalTemplate::MESSAGE_TYPE_QUESTION = "question"

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

◆ MESSAGE_TYPE_SUCCESS

const ilCOPageGlobalTemplate::MESSAGE_TYPE_SUCCESS = "success"

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


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