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

	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")
	public More...

	touchBlock ($block)
	overwrites ITX::touchBlock. More...

	parseCurrentBlock ($part="DEFAULT")
	Überladene Funktion, die auf den aktuelle Block vorher noch ein replace ausführt public. More...

	addBlockFile ($var, $block, $tplname, $in_module=false)
	overwrites ITX::addBlockFile public More...

	blockExists ($a_blockname)
	check if block exists in actual template private 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	$file	templatefile (mit oder ohne pfad)
boolean	$flag1	remove unknown variables
boolean	$flag2	remove empty blocks
boolean	$in_module	should be set to true, if template file is in module subdirectory
array	$vars	variables to replace public

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

References XapiProxy\$plugin, and setBodyClass().

       {
         $this->setBodyClass("std");
         $this->template = new ilTemplate($file, $flag1, $flag2, $in_module, $vars, $plugin, $a_use_cache);
     }

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.

     {
         $this->admin_panel_commands_toolbar = $toolb;
         $this->admin_panel_arrow = $a_arrow;
         $this->admin_panel_bottom = $a_bottom_panel;
     }

◆ addBlockFile()

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

overwrites ITX::addBlockFile public

Parameters

	string
	string
string	$tplname	template name
boolean	$in_module	should 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.

Referenced by loadStandardTemplate().

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

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.

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

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

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

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

     {
         // three batches currently
         if ($a_batch < 1 || $a_batch > 3) {
             $a_batch = 2;
         }
 
         // ensure jquery files being loaded first
         if (is_int(strpos($a_js_file, "Services/jQuery")) ||
             is_int(strpos($a_js_file, "/jquery.js")) ||
             is_int(strpos($a_js_file, "/jquery-min.js"))) {
             $a_batch = 0;
         }
 
         if (!in_array($a_js_file, $this->js_files)) {
             $this->js_files[] = $a_js_file;
             $this->js_files_vp[$a_js_file] = $a_add_version_parameter;
             $this->js_files_batch[$a_js_file] = $a_batch;
         }
     }

◆ addLightbox()

ilCOPageGlobalTemplate::addLightbox	(	$a_html,
		$a_id
	)

Add lightbox html.

Implements ilGlobalTemplateInterface.

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

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

◆ addOnLoadCode()

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

Add on load code.

Implements ilGlobalTemplateInterface.

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

     {
         // three batches currently
         if ($a_batch < 1 || $a_batch > 3) {
             $a_batch = 2;
         }
         $this->on_load_code[$a_batch][] = $a_code;
     }

◆ blockExists()

ilCOPageGlobalTemplate::blockExists ( $a_blockname )

check if block exists in actual template private

Parameters

string blockname

Returns: boolean

Implements ilGlobalTemplateInterface.

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

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

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

Here is the caller graph for this function:

◆ clearHeader()

ilCOPageGlobalTemplate::clearHeader ( )

Clear header.

Implements ilGlobalTemplateInterface.

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

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

     {
         $this->setTitle("");
         $this->setTitleIcon("");
         $this->setDescription("");
         $this->setAlertProperties(array());
     }

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.

Referenced by resetHeaderBlock().

     {
         $this->enable_fileupload = $a_ref_id;
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         global $DIC;
         $lng = $DIC->language();
 
         if ($this->admin_panel_commands_toolbar === null) {
             return;
         }
 
         $toolb = $this->admin_panel_commands_toolbar;
         assert($toolbar instanceof \ilToolbarGUI);
 
         // Add arrow if desired.
         if ($this->admin_panel_arrow) {
             $toolb->setLeadingImage(ilUtil::getImagePath("arrow_upright.svg"), $lng->txt("actions"));
         }
 
         $this->fillPageFormAction();
 
         // Add top admin bar.
         $this->setCurrentBlock("adm_view_components");
         $this->setVariable("ADM_PANEL1", $toolb->getHTML());
         $this->parseCurrentBlock();
 
         // Add bottom admin bar if user wants one.
         if ($this->admin_panel_bottom) {
             $this->setCurrentBlock("adm_view_components2");
 
             // Replace previously set arrow image.
             if ($this->admin_panel_arrow) {
                 $toolb->setLeadingImage(ilUtil::getImagePath("arrow_downright.svg"), $lng->txt("actions"));
             }
 
             $this->setVariable("ADM_PANEL2", $toolb->getHTML());
             $this->parseCurrentBlock();
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         if ($this->body_class != "" && $this->blockExists("body_class")) {
             $this->setCurrentBlock("body_class");
             $this->setVariable("BODY_CLASS", $this->body_class);
             $this->parseCurrentBlock();
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         global $DIC;
         $lng = $DIC->language();
 
         if (is_object($lng)) {
             $this->setVariable('META_CONTENT_LANGUAGE', $lng->getContentLanguage());
             $this->setVariable('LANGUAGE_DIRECTION', $lng->getTextDirection());
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         if (!$this->blockExists("css_file")) {
             return;
         }
         foreach ($this->css_files as $css) {
             $filename = $css["file"];
             if (strpos($filename, "?") > 0) {
                 $filename = substr($filename, 0, strpos($filename, "?"));
             }
             if (is_file($filename) || $a_force) {
                 $this->setCurrentBlock("css_file");
                 $this->setVariable("CSS_FILE", $css["file"]);
                 $this->setVariable("CSS_MEDIA", $css["media"]);
                 $this->parseCurrentBlock();
             }
         }
     }

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.

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

     {
         global $DIC;
 
         $ilSetting = $DIC->settings();
 
         $lng = $DIC->language();
 
         $ilCtrl = $DIC->ctrl();
         $ilDB = $DIC->database();
 
         if (!$this->show_footer) {
             return;
         }
 
         $ftpl = new ilTemplate("tpl.footer.html", true, true, "Services/UICore");
 
         $php = "";
         if (DEVMODE) {
             $php = ", PHP " . phpversion();
         }
         $ftpl->setVariable("ILIAS_VERSION", $ilSetting->get("ilias_version") . $php);
 
         $link_items = array();
 
         // imprint
         include_once "Services/Imprint/classes/class.ilImprint.php";
         if ($_REQUEST["baseClass"] != "ilImprintGUI" && ilImprint::isActive()) {
             include_once "Services/Link/classes/class.ilLink.php";
             $link_items[ilLink::_getStaticLink(0, "impr")] = array($lng->txt("imprint"), true);
         }
 
         // system support contacts
         include_once("./Modules/SystemFolder/classes/class.ilSystemSupportContactsGUI.php");
         if (($l = ilSystemSupportContactsGUI::getFooterLink()) != "") {
             $link_items[$l] = array(ilSystemSupportContactsGUI::getFooterText(), false);
         }
 
         if (DEVMODE) {
             if (function_exists("tidy_parse_string")) {
                 $link_items[ilUtil::appendUrlParameterString($_SERVER["REQUEST_URI"], "do_dev_validate=xhtml")] = array("Validate", true);
                 $link_items[ilUtil::appendUrlParameterString($_SERVER["REQUEST_URI"], "do_dev_validate=accessibility")] = array("Accessibility", true);
             }
         }
 
         // output translation link
         include_once("Services/Language/classes/class.ilObjLanguageAccess.php");
         if (ilObjLanguageAccess::_checkTranslate() and !ilObjLanguageAccess::_isPageTranslation()) {
             $link_items[ilObjLanguageAccess::_getTranslationLink()] = array($lng->txt('translation'), true);
         }
 
         $cnt = 0;
         foreach ($link_items as $url => $caption) {
             $cnt++;
             if ($caption[1]) {
                 $ftpl->touchBlock("blank");
             }
             if ($cnt < sizeof($link_items)) {
                 $ftpl->touchBlock("item_separator");
             }
 
             $ftpl->setCurrentBlock("items");
             $ftpl->setVariable("URL_ITEM", ilUtil::secureUrl($url));
             $ftpl->setVariable("TXT_ITEM", $caption[0]);
             $ftpl->parseCurrentBlock();
         }
 
         if (DEVMODE) {
             // execution time
             $t1 = explode(" ", $GLOBALS['ilGlobalStartTime']);
             $t2 = explode(" ", microtime());
             $diff = $t2[0] - $t1[0] + $t2[1] - $t1[1];
 
             $mem_usage = array();
             if (function_exists("memory_get_usage")) {
                 $mem_usage[] =
                     "Memory Usage: " . memory_get_usage() . " Bytes";
             }
             if (function_exists("xdebug_peak_memory_usage")) {
                 $mem_usage[] =
                     "XDebug Peak Memory Usage: " . xdebug_peak_memory_usage() . " Bytes";
             }
             $mem_usage[] = round($diff, 4) . " Seconds";
 
             if (sizeof($mem_usage)) {
                 $ftpl->setVariable("MEMORY_USAGE", "<br>" . implode(" | ", $mem_usage));
             }
 
             if (!empty($_GET["do_dev_validate"]) && $ftpl->blockExists("xhtml_validation")) {
                 require_once("Services/XHTMLValidator/classes/class.ilValidatorAdapter.php");
                 $template2 = clone($this);
                 $ftpl->setCurrentBlock("xhtml_validation");
                 $ftpl->setVariable(
                     "VALIDATION",
                     ilValidatorAdapter::validate($template2->get(
                         "DEFAULT",
                         false,
                         false,
                         false,
                         true
                     ), $_GET["do_dev_validate"])
                 );
                 $ftpl->parseCurrentBlock();
             }
 
             // controller history
             if (is_object($ilCtrl) && $ftpl->blockExists("c_entry") &&
                 $ftpl->blockExists("call_history")) {
                 $hist = $ilCtrl->getCallHistory();
                 foreach ($hist as $entry) {
                     $ftpl->setCurrentBlock("c_entry");
                     $ftpl->setVariable("C_ENTRY", $entry["class"]);
                     if (is_object($ilDB)) {
                         $file = $ilCtrl->lookupClassPath($entry["class"]);
                         $add = $entry["mode"] . " - " . $entry["cmd"];
                         if ($file != "") {
                             $add .= " - " . $file;
                         }
                         $ftpl->setVariable("C_FILE", $add);
                     }
                     $ftpl->parseCurrentBlock();
                 }
                 $ftpl->setCurrentBlock("call_history");
                 $ftpl->parseCurrentBlock();
             }
 
             // included files
             if (is_object($ilCtrl) && $ftpl->blockExists("i_entry") &&
                 $ftpl->blockExists("included_files")) {
                 $fs = get_included_files();
                 $ifiles = array();
                 $total = 0;
                 foreach ($fs as $f) {
                     $ifiles[] = array("file" => $f, "size" => filesize($f));
                     $total += filesize($f);
                 }
                 $ifiles = ilUtil::sortArray($ifiles, "size", "desc", true);
                 foreach ($ifiles as $f) {
                     $ftpl->setCurrentBlock("i_entry");
                     $ftpl->setVariable("I_ENTRY", $f["file"] . " (" . $f["size"] . " Bytes, " . round(100 / $total * $f["size"], 2) . "%)");
                     $ftpl->parseCurrentBlock();
                 }
                 $ftpl->setCurrentBlock("i_entry");
                 $ftpl->setVariable("I_ENTRY", "Total (" . $total . " Bytes, 100%)");
                 $ftpl->parseCurrentBlock();
                 $ftpl->setCurrentBlock("included_files");
                 $ftpl->parseCurrentBlock();
             }
         }
 
         // BEGIN Usability: Non-Delos Skins can display the elapsed time in the footer
         // The corresponding $ilBench->start invocation is in inc.header.php
         $ilBench = $DIC["ilBench"];
         $ilBench->stop("Core", "ElapsedTimeUntilFooter");
         $ftpl->setVariable(
             "ELAPSED_TIME",
             ", " . number_format($ilBench->getMeasuredTime("Core", "ElapsedTimeUntilFooter"), 1) . ' seconds'
         );
         // END Usability: Non-Delos Skins can display the elapsed time in the footer
 
         $this->setVariable("FOOTER", $ftpl->get());
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         global $DIC;
 
         $lng = $DIC->language();
 
         $icon = false;
         if ($this->icon_path != "") {
             $icon = true;
             $this->setCurrentBlock("header_image");
             if ($this->icon_desc != "") {
                 $this->setVariable("IMAGE_DESC", $lng->txt("icon") . " " . $this->icon_desc);
                 $this->setVariable("IMAGE_ALT", $lng->txt("icon") . " " . $this->icon_desc);
             }
 
             $this->setVariable("IMG_HEADER", $this->icon_path);
             $this->parseCurrentBlock();
             $header = true;
         }
 
         if ($this->title != "") {
             $title = ilUtil::stripScriptHTML($this->title);
             $this->setVariable("HEADER", $title);
 
             $header = true;
         }
 
         if ($header) {
             $this->setCurrentBlock("header_image");
             $this->parseCurrentBlock();
         }
 
         if ($this->title_desc != "") {
             $this->setCurrentBlock("header_desc");
             $this->setVariable("H_DESCRIPTION", $this->title_desc);
             $this->parseCurrentBlock();
         }
 
         $header = $this->getHeaderActionMenu();
         if ($header) {
             $this->setCurrentBlock("head_action_inner");
             $this->setVariable("HEAD_ACTION", $header);
             $this->parseCurrentBlock();
         }
 
         if (count((array) $this->title_alerts)) {
             foreach ($this->title_alerts as $alert) {
                 $this->setCurrentBlock('header_alert');
                 if (!($alert['propertyNameVisible'] === false)) {
                     $this->setVariable('H_PROP', $alert['property'] . ':');
                 }
                 $this->setVariable('H_VALUE', $alert['value']);
                 $this->parseCurrentBlock();
             }
         }
 
         // add file upload drop zone in header
         if ($this->enable_fileupload != null) {
             $ref_id = $this->enable_fileupload;
             $upload_id = "dropzone_" . $ref_id;
 
             include_once("./Services/FileUpload/classes/class.ilFileUploadGUI.php");
             $upload = new ilFileUploadGUI($upload_id, $ref_id, true);
 
             $this->setVariable("FILEUPLOAD_DROPZONE_ID", " id=\"$upload_id\"");
 
             $this->setCurrentBlock("header_fileupload");
             $this->setVariable("HEADER_FILEUPLOAD_SCRIPT", $upload->getHTML());
             $this->parseCurrentBlock();
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         if (!$this->blockExists("css_inline")) {
             return;
         }
         foreach ($this->inline_css as $css) {
             $this->setCurrentBlock("css_inline");
             $this->setVariable("CSS_INLINE", $css["css"]);
             $this->parseCurrentBlock();
         }
     }

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.

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

Referenced by fillJavaScriptFiles().

     {
         $this->setCurrentBlock("js_file");
         if ($this->js_files_vp[$file]) {
             $this->setVariable("JS_FILE", ilUtil::appendUrlParameterString($file, $vers));
         } else {
             $this->setVariable("JS_FILE", $file);
         }
         $this->parseCurrentBlock();
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         global $DIC;
 
         $ilSetting = $DIC->settings();
 
         if (is_object($ilSetting)) {            // maybe this one can be removed
             $vers = "vers=" . str_replace(array(".", " "), "-", $ilSetting->get("ilias_version"));
 
             if (DEVMODE) {
                 $vers .= '-' . time();
             }
         }
         if ($this->blockExists("js_file")) {
             // three batches
             for ($i = 0; $i <= 3; $i++) {
                 reset($this->js_files);
                 foreach ($this->js_files as $file) {
                     if ($this->js_files_batch[$file] == $i) {
                         if (is_file($file) || substr($file, 0, 4) == "http" || substr($file, 0, 2) == "//" || $a_force) {
                             $this->fillJavascriptFile($file, $vers);
                         } elseif (substr($file, 0, 2) == './') { // #13962
                             $url_parts = parse_url($file);
                             if (is_file($url_parts['path'])) {
                                 $this->fillJavascriptFile($file, $vers);
                             }
                         }
                     }
                 }
             }
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         if (trim($this->left_content) != "") {
             $this->setCurrentBlock("left_column");
             $this->setVariable("LEFT_CONTENT", $this->left_content);
             $left_col_class = (trim($this->right_content) == "")
                 ? "col-sm-3 col-sm-pull-9"
                 : "col-sm-3 col-sm-pull-6";
             $this->setVariable("LEFT_COL_CLASS", $left_col_class);
             $this->parseCurrentBlock();
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         if (trim($this->left_nav_content) != "") {
             $this->setCurrentBlock("left_nav");
             $this->setVariable("LEFT_NAV_CONTENT", $this->left_nav_content);
             $this->parseCurrentBlock();
             $this->touchBlock("left_nav_space");
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillLightbox()

ilCOPageGlobalTemplate::fillLightbox ( )

private

Fill lightbox content.

Parameters

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

References setVariable().

Referenced by getSpecial(), and printToStdout().

     {
         $html = "";
 
         foreach ($this->lightbox as $lb) {
             $html .= $lb;
         }
         $this->setVariable("LIGHTBOX", $html);
     }

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.

References setVariable().

Referenced by getSpecial(), and printToStdout().

     {
         if (trim($this->main_content) != "") {
             $this->setVariable("ADM_CONTENT", $this->main_content);
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         global $DIC;
         $tpl = $DIC["tpl"];
         if ($this->variableExists('MAINMENU')) {
             $tpl->setVariable("MAINMENU", $this->main_menu);
             $tpl->setVariable("MAINMENU_SPACER", $this->main_menu_spacer);
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         global $DIC;
 
         $out = "";
 
         foreach (self::$message_types as $m) {
             $txt = $this->getMessageTextForType($m);
 
             if ($txt != "") {
                 $out .= ilUtil::getSystemMessageHTML($txt, $m);
             }
 
             $request = $DIC->http()->request();
             $accept_header = $request->getHeaderLine('Accept');
             if (isset($_SESSION[$m]) && $_SESSION[$m] && ($accept_header !== 'application/json')) {
                 unset($_SESSION[$m]);
             }
         }
 
         if ($out != "") {
             $this->setVariable("MESSAGE", $out);
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         $this->setVariable(
             "LOCATION_NEWCONTENT_STYLESHEET_TAG",
             '<link rel="stylesheet" type="text/css" href="' .
             ilUtil::getNewContentStyleSheetLocation()
             . '" />'
         );
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         for ($i = 1; $i <= 3; $i++) {
             if (is_array($this->on_load_code[$i])) {
                 $this->setCurrentBlock("on_load_code");
                 foreach ($this->on_load_code[$i] as $code) {
                     $this->setCurrentBlock("on_load_code_inner");
                     $this->setVariable("OLCODE", $code);
                     $this->parseCurrentBlock();
                 }
                 $this->setCurrentBlock("on_load_code");
                 $this->parseCurrentBlock();
             }
         }
     }

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.

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

Referenced by fillAdminPanel().

     {
         if ($this->page_form_action != "") {
             $this->setCurrentBlock("page_form_start");
             $this->setVariable("PAGE_FORM_ACTION", $this->page_form_action);
             $this->parseCurrentBlock();
             $this->touchBlock("page_form_end");
         }
     }

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.

References setVariable().

Referenced by getSpecial(), and printToStdout().

     {
         if (is_array($this->permanent_link)) {
             include_once("./Services/PermanentLink/classes/class.ilPermanentLinkGUI.php");
             $plinkgui = new ilPermanentLinkGUI(
                 $this->permanent_link["type"],
                 $this->permanent_link["id"],
                 $this->permanent_link["append"],
                 $this->permanent_link["target"]
             );
             if ($this->permanent_link["title"] != "") {
                 $plinkgui->setTitle($this->permanent_link["title"]);
             }
             $this->setVariable("PRMLINK", $plinkgui->getHTML());
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         if (trim($this->right_content) != "") {
             $this->setCurrentBlock("right_column");
             $this->setVariable("RIGHT_CONTENT", $this->right_content);
             $this->parseCurrentBlock();
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         global $DIC;
 
         $ilUser = $DIC->user();
 
         if (is_object($ilUser) && $ilUser->getPref("screen_reader_optimization") && $this->blockExists("sr_focus")) {
             $this->touchBlock("sr_focus");
         }
     }

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.

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

     {
         global $DIC;
 
         $ilSetting = $DIC->settings();
 
         $lng = $DIC->language();
 
         // tree/flat icon
         if ($this->tree_flat_link != "") {
             if ($this->left_nav_content != "") {
                 $this->touchBlock("tree_lns");
             }
 
             $this->setCurrentBlock("tree_mode");
             $this->setVariable("LINK_MODE", $this->tree_flat_link);
             if ($ilSetting->get("tree_frame") == "right") {
                 if ($this->tree_flat_mode == "tree") {
                     $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
                     $this->setVariable("RIGHT", "Right");
                 } else {
                     $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
                     $this->setVariable("RIGHT", "Right");
                 }
             } else {
                 if ($this->tree_flat_mode == "tree") {
                     $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
                 } else {
                     $this->setVariable("IMG_TREE", ilUtil::getImagePath("icon_sidebar_on.svg"));
                 }
             }
             $this->setVariable("ALT_TREE", $lng->txt($this->tree_flat_mode . "view"));
             $this->setVariable("TARGET_TREE", ilFrameTargetInfo::_getFrame("MainContent"));
             include_once("./Services/Accessibility/classes/class.ilAccessKeyGUI.php");
             $this->setVariable(
                 "TREE_ACC_KEY",
                 ilAccessKeyGUI::getAttribute(($this->tree_flat_mode == "tree")
                     ? ilAccessKey::TREE_ON
                     : ilAccessKey::TREE_OFF)
             );
             $this->parseCurrentBlock();
         }
 
         $this->setCurrentBlock("tree_icons");
         $this->parseCurrentBlock();
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         if ($this->blockExists("tabs_outer_start")) {
             $this->touchBlock("tabs_outer_start");
             $this->touchBlock("tabs_outer_end");
             $this->touchBlock("tabs_inner_start");
             $this->touchBlock("tabs_inner_end");
 
             if ($this->tabs_html != "") {
                 $this->setVariable("TABS", $this->tabs_html);
             }
             $this->setVariable("SUB_TABS", $this->sub_tabs_html);
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         global $DIC;
 
         $ilToolbar = $DIC["ilToolbar"];
         ;
 
         $thtml = $ilToolbar->getHTML();
         if ($thtml != "") {
             $this->setCurrentBlock("toolbar_buttons");
             $this->setVariable("BUTTONS", $thtml);
             $this->parseCurrentBlock();
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         global $DIC;
 
         $ilSetting = $DIC->settings();
 
         if ($this->header_page_title != "") {
             $title = ilUtil::stripScriptHTML($this->header_page_title);
             $this->setVariable("PAGETITLE", "- " . $title);
         }
 
         if ($ilSetting->get('short_inst_name') != "") {
             $this->setVariable(
                 "WINDOW_TITLE",
                 $ilSetting->get('short_inst_name')
             );
         } else {
             $this->setVariable(
                 "WINDOW_TITLE",
                 "ILIAS"
             );
         }
     }

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.

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

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

     {
         return $this->header_action;
     }

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.

Referenced by getMainMenu().

     {
         return $this->login_target_par;
     }

Here is the caller graph for this function:

◆ getMainMenu()

ilCOPageGlobalTemplate::getMainMenu ( )

private

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

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

Referenced by getSpecial(), and printToStdout().

     {
         global $DIC;
 
         $ilMainMenu = $DIC["ilMainMenu"];
 
         if ($this->variableExists('MAINMENU')) {
             $ilMainMenu->setLoginTargetPar($this->getLoginTargetPar());
             $this->main_menu = $ilMainMenu->getHTML();
             $this->main_menu_spacer = $ilMainMenu->getSpacerClass();
         }
     }

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.

References $_SESSION, and $txt.

Referenced by fillMessage().

     {
         $txt = "";
         if (isset($_SESSION[$m]) && $_SESSION[$m] != "") {
             $txt = $_SESSION[$m];
         } else {
             if (isset($this->message[$m])) {
                 $txt = $this->message[$m];
             }
         }
 
         return $txt;
     }

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.

References $i.

     {
         $js = "";
         for ($i = 1; $i <= 3; $i++) {
             if (is_array($this->on_load_code[$i])) {
                 foreach ($this->on_load_code[$i] as $code) {
                     $js .= $code . "\n";
                 }
             }
         }
         if ($js) {
             return '<script type="text/javascript">' . "\n" .
                 $js .
                 '</script>' . "\n";
         }
     }

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

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

       {
         global $DIC;
 
         if ($add_error_mess) {
             $this->fillMessage();
         }
 
         if ($add_ilias_footer) {
             $this->fillFooter();
         }
 
         // set standard parts (tabs and title icon)
         if ($add_standard_elements) {
             if ($this->blockExists("content") && $a_tabs) {
                 // determine default screen id
                 $this->getTabsHTML();
             }
 
             // to get also the js files for the main menu
             $this->getMainMenu();
             $this->initHelp();
 
             // these fill blocks in tpl.main.html
             $this->fillCssFiles();
             $this->fillInlineCss();
             $this->fillBodyClass();
 
             // these fill just plain placeholder variables in tpl.main.html
             $this->setCurrentBlock("DEFAULT");
             $this->fillNewContentStyle();
             $this->fillContentLanguage();
             $this->fillWindowTitle();
 
             // these fill blocks in tpl.adm_content.html
             $this->fillHeader();
             $this->fillSideIcons();
             $this->fillScreenReaderFocus();
             $this->fillLeftContent();
             $this->fillLeftNav();
             $this->fillRightContent();
             $this->fillAdminPanel();
             $this->fillToolbar();
             $this->fillPermanentLink();
 
             $this->setCenterColumnClass();
 
             // late loading of javascipr files, since operations above may add files
             $this->fillJavaScriptFiles();
             $this->fillOnLoadCode();
 
             // these fill just plain placeholder variables in tpl.adm_content.html
             if ($this->blockExists("content")) {
                 $this->setCurrentBlock("content");
                 if ($a_tabs) {
                     $this->fillTabs();
                 }
                 $this->fillMainContent();
                 if ($a_main_menu) {
                     $this->fillMainMenu();
                 }
                 $this->fillLightbox();
                 $this->parseCurrentBlock();
             }
         }
 
         if ($handle_referer) {
             $this->handleReferer();
         }
 
         if ($part == "DEFAULT") {
             $html = $this->template->get();
         } else {
             $html = $this->template->get($part);
         }
 
         // save language usages as late as possible
         ilObjLanguageAccess::_saveUsages();
 
         return $html;
     }

Here is the call graph for this function:

◆ getTabsHTML()

ilCOPageGlobalTemplate::getTabsHTML ( )

private

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

References $DIC, and blockExists().

Referenced by getSpecial(), and printToStdout().

     {
         global $DIC;
 
         $ilTabs = $DIC["ilTabs"];
 
         if ($this->blockExists("tabs_outer_start")) {
             $this->sub_tabs_html = $ilTabs->getSubTabHTML();
             $this->tabs_html = $ilTabs->getHTML(true);
         }
     }

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.

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

Referenced by getSpecial(), and printToStdout().

     {
         if (((substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "error.php")
             && (substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "adm_menu.php")
             && (substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "chat.php"))) {
             // referer is modified if query string contains cmd=gateway and $_POST is not empty.
             // this is a workaround to display formular again in case of error and if the referer points to another page
             $url_parts = @parse_url($_SERVER["REQUEST_URI"]);
             if (!$url_parts) {
                 $protocol = (isset($_SERVER['HTTPS']) ? 'https' : 'http') . '://';
                 $host = $_SERVER['HTTP_HOST'];
                 $path = $_SERVER['REQUEST_URI'];
                 $url_parts = @parse_url($protocol . $host . $path);
             }
 
             if (isset($url_parts["query"]) && preg_match("/cmd=gateway/", $url_parts["query"]) && (isset($_POST["cmd"]["create"]))) {
                 foreach ($_POST as $key => $val) {
                     if (is_array($val)) {
                         $val = key($val);
                     }
 
                     $str .= "&" . $key . "=" . $val;
                 }
 
                 $_SESSION["referer"] = preg_replace("/cmd=gateway/", substr($str, 1), $_SERVER["REQUEST_URI"]);
                 $_SESSION['referer_ref_id'] = (int) $_GET['ref_id'];
             } elseif (isset($url_parts["query"]) && preg_match("/cmd=post/", $url_parts["query"]) && (isset($_POST["cmd"]["create"]))) {
                 foreach ($_POST as $key => $val) {
                     if (is_array($val)) {
                         $val = key($val);
                     }
 
                     $str .= "&" . $key . "=" . $val;
                 }
 
                 $_SESSION["referer"] = preg_replace("/cmd=post/", substr($str, 1), $_SERVER["REQUEST_URI"]);
                 if (isset($_GET['ref_id'])) {
                     $_SESSION['referer_ref_id'] = (int) $_GET['ref_id'];
                 } else {
                     $_SESSION['referer_ref_id'] = 0;
                 }
             } else {
                 $_SESSION["referer"] = $_SERVER["REQUEST_URI"];
                 if (isset($_GET['ref_id'])) {
                     $_SESSION['referer_ref_id'] = (int) $_GET['ref_id'];
                 } else {
                     $_SESSION['referer_ref_id'] = 0;
                 }
             }
 
             unset($_SESSION["error_post_vars"]);
         }
     }

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.

     {
         $this->show_footer = false;
     }

◆ initHelp()

ilCOPageGlobalTemplate::initHelp ( )

private

Init help.

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

Referenced by getSpecial(), and printToStdout().

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

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.

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

     {
         if ($this->standard_template_loaded) {
             return;
         }
 
         // always load jQuery
         include_once("./Services/jQuery/classes/class.iljQueryUtil.php");
         iljQueryUtil::initjQuery();
         iljQueryUtil::initjQueryUI();
 
         // always load ui framework
         include_once("./Services/UICore/classes/class.ilUIFramework.php");
         ilUIFramework::init();
 
         $this->addBlockFile("CONTENT", "content", "tpl.adm_content.html");
         $this->addBlockFile("STATUSLINE", "statusline", "tpl.statusline.html");
 
         $this->standard_template_loaded = true;
     }

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 public.

Parameters

string

Returns: string

Implements ilGlobalTemplateInterface.

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

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

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

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_tabs	fill template variable {TABS} with content of ilTabs
bool	$a_skip_main_menu

Implements ilGlobalTemplateInterface.

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

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(), setCenterColumnClass(), and setCurrentBlock().

     {
         global $DIC;
 
         $http = $DIC->http();
         switch ($http->request()->getHeaderLine('Accept')) {
             case 'application/json':
                 $string = json_encode([
                     self::MESSAGE_TYPE_SUCCESS => is_null($this->message[self::MESSAGE_TYPE_FAILURE]),
                     'message' => '',
                 ]);
                 $stream = \ILIAS\Filesystem\Stream\Streams::ofString($string);
                 $http->saveResponse($http->response()->withBody($stream));
                 $http->sendResponse();
                 exit;
             default:
                 // include yahoo dom per default
                 include_once("./Services/YUI/classes/class.ilYuiUtil.php");
                 ilYuiUtil::initDom();
 
                 header('P3P: CP="CURa ADMa DEVa TAIa PSAa PSDa IVAa IVDa OUR BUS IND UNI COM NAV INT CNT STA PRE"');
                 header("Content-type: text/html; charset=UTF-8");
 
                 $this->fillMessage();
 
                 // display ILIAS footer
                 if ($part !== false) {
                     $this->fillFooter();
                 }
 
                 // set standard parts (tabs and title icon)
                 $this->fillBodyClass();
                 if ($a_fill_tabs) {
                     if ($this->blockExists("content")) {
                         // determine default screen id
                         $this->getTabsHTML();
                     }
 
                     // to get also the js files for the main menu
                     if (!$a_skip_main_menu) {
                         $this->getMainMenu();
                         $this->initHelp();
                     }
 
                     // these fill blocks in tpl.main.html
                     $this->fillCssFiles();
                     $this->fillInlineCss();
                     //$this->fillJavaScriptFiles();
 
                     // these fill just plain placeholder variables in tpl.main.html
                     $this->setCurrentBlock("DEFAULT");
                     $this->fillNewContentStyle();
                     $this->fillContentLanguage();
                     $this->fillWindowTitle();
 
                     // these fill blocks in tpl.adm_content.html
                     $this->fillHeader();
                     $this->fillSideIcons();
                     $this->fillScreenReaderFocus();
                     $this->fillLeftContent();
                     $this->fillLeftNav();
                     $this->fillRightContent();
                     $this->fillAdminPanel();
                     $this->fillToolbar();
                     $this->fillPermanentLink();
 
                     $this->setCenterColumnClass();
 
                     // late loading of javascipr files, since operations above may add files
                     $this->fillJavaScriptFiles();
                     $this->fillOnLoadCode();
 
                     // these fill just plain placeholder variables in tpl.adm_content.html
                     if ($this->blockExists("content")) {
                         $this->setCurrentBlock("content");
                         $this->fillTabs();
                         $this->fillMainContent();
                         $this->fillMainMenu();
                         $this->fillLightbox();
                         $this->parseCurrentBlock();
                     }
                 }
 
                 if ($part == "DEFAULT" or is_bool($part)) {
                     $html = $this->template->getUnmodified();
                 } else {
                     $html = $this->template->getUnmodified($part);
                 }
 
                 // Modification of html is done inline here and can't be done
                 // by ilTemplate, because the "phase" is template_show in this
                 // case here.
                 $ilPluginAdmin = $DIC["ilPluginAdmin"];
                 $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "UIComponent", "uihk");
                 foreach ($pl_names as $pl) {
                     $ui_plugin = ilPluginAdmin::getPluginObject(IL_COMP_SERVICE, "UIComponent", "uihk", $pl);
                     $gui_class = $ui_plugin->getUIClassInstance();
 
                     $resp = $gui_class->getHTML(
                         "",
                         "template_show",
                         array("tpl_id" => $this->tplIdentifier, "tpl_obj" => $this, "html" => $html)
                     );
 
                     if ($resp["mode"] != ilUIHookPluginGUI::KEEP) {
                         $html = $gui_class->modifyHTML($html, $resp);
                     }
                 }
 
                 // save language usages as late as possible
                 ilObjLanguageAccess::_saveUsages();
 
                 print $html;
 
                 $this->handleReferer();
                 break;
         }
     }

Here is the call graph for this function:

◆ printToString()

ilCOPageGlobalTemplate::printToString ( )

Implements ilGlobalTemplateInterface.

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

                                     : string
     {
         throw new ilException('not implemented');
     }

◆ resetCss()

ilCOPageGlobalTemplate::resetCss ( )

private

Reset css files.

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

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

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

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

     {
         $this->setTitle(null);
         $this->setTitleIcon(null);
         $this->setDescription(null);
         $this->setAlertProperties(array());
         $this->enableDragDropFileUpload(null);
 
         // see setFullscreenHeader()
         if ($a_reset_header_action) {
             $this->setHeaderActionMenu(null);
         }
     }

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.

     {
         $this->js_files = array();
         $this->js_files_vp = array();
         $this->js_files_batch = array();
     }

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

Referenced by clearHeader(), and resetHeaderBlock().

     {
         $this->title_alerts = $a_props;
     }

Here is the caller graph for this function:

◆ setBodyClass()

ilCOPageGlobalTemplate::setBodyClass ( $a_class = "" )

Implements ilGlobalTemplateInterface.

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

Referenced by __construct().

     {
         $this->body_class = $a_class;
     }

Here is the caller graph for this function:

◆ setCenterColumnClass()

ilCOPageGlobalTemplate::setCenterColumnClass ( )

private

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

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

Referenced by getSpecial(), and printToStdout().

     {
         if (!$this->blockExists("center_col_width")) {
             return;
         }
         $center_column_class = "";
         if (trim($this->right_content) != "" && trim($this->left_content) != "") {
             $center_column_class = "two_side_col";
         } elseif (trim($this->right_content) != "" || trim($this->left_content) != "") {
             $center_column_class = "one_side_col";
         }
 
         switch ($center_column_class) {
             case "one_side_col": $center_column_class = "col-sm-9"; break;
             case "two_side_col": $center_column_class = "col-sm-6"; break;
             default: $center_column_class = "col-sm-12"; break;
         }
         if (trim($this->left_content) != "") {
             $center_column_class .= " col-sm-push-3";
         }
 
         $this->setCurrentBlock("center_col_width");
         $this->setVariable("CENTER_COL", $center_column_class);
         $this->parseCurrentBlock();
     }

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.

     {
         if ($a_html != "") {
             $this->main_content = $a_html;
         }
     }

◆ setCurrentBlock()

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

public

Parameters

string

Returns: ???

Implements ilGlobalTemplateInterface.

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

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

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

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.

Referenced by clearHeader(), and resetHeaderBlock().

     {
         $this->title_desc = $a_descr;
     }

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.

Referenced by resetHeaderBlock().

     {
         $this->header_action = $a_header;
     }

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.

     {
         $this->header_page_title = $a_title;
     }

◆ setLeftContent()

ilCOPageGlobalTemplate::setLeftContent ( $a_html )

Sets content of left column.

Implements ilGlobalTemplateInterface.

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

     {
         $this->left_content = $a_html;
     }

◆ setLeftNavContent()

ilCOPageGlobalTemplate::setLeftNavContent ( $a_content )

Sets content of left navigation column.

Implements ilGlobalTemplateInterface.

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

     {
         $this->left_nav_content = $a_content;
     }

◆ setLocator()

ilCOPageGlobalTemplate::setLocator ( )

Insert locator.

Implements ilGlobalTemplateInterface.

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

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

     {
         global $DIC;
 
         $ilMainMenu = $DIC["ilMainMenu"];
         $ilLocator = $DIC["ilLocator"];
 
         $ilPluginAdmin = $DIC["ilPluginAdmin"];
 
         // blog/portfolio
         if ($ilMainMenu->getMode() == ilMainMenuGUI::MODE_TOPBAR_REDUCED ||
             $ilMainMenu->getMode() == ilMainMenuGUI::MODE_TOPBAR_ONLY) {
             $this->setVariable("LOCATOR", "");
             return;
         }
 
         $html = "";
         if (is_object($ilPluginAdmin)) {
             include_once("./Services/UIComponent/classes/class.ilUIHookProcessor.php");
             $uip = new ilUIHookProcessor(
                 "Services/Locator",
                 "main_locator",
                 array("locator_gui" => $ilLocator)
             );
             if (!$uip->replaced()) {
                 $html = $ilLocator->getHTML();
             }
             $html = $uip->getHTML($html);
         } else {
             $html = $ilLocator->getHTML();
         }
 
         $this->setVariable("LOCATOR", $html);
     }

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.

     {
         $this->login_target_par = $a_val;
     }

◆ 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	::MESSAGE_TYPE_SUCCESS, ::MESSAGE_TYPE_FAILURE,, ::MESSAGE_TYPE_QUESTION, ::MESSAGE_TYPE_INFO
string	$a_txt	The message to be sent
bool	$a_keep	Keep this message over one redirect

Implements ilGlobalTemplateInterface.

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

References $_SESSION.

     {
         if (!in_array($a_type, self::$message_types) || $a_txt == "") {
             return;
         }
         if (!$a_keep) {
             $this->message[$a_type] = $a_txt;
         } else {
             $_SESSION[$a_type] = $a_txt;
         }
     }

◆ setPageFormAction()

ilCOPageGlobalTemplate::setPageFormAction ( $a_action )

Implements ilGlobalTemplateInterface.

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

     {
         $this->page_form_action = $a_action;
     }

◆ setPermanentLink()

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

Implements ilGlobalTemplateInterface.

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

     {
         $this->permanent_link = array(
             "type" => $a_type,
             "id" => $a_id,
             "append" => $a_append,
             "target" => $a_target,
             "title" => $a_title);
     }

◆ setRightContent()

ilCOPageGlobalTemplate::setRightContent ( $a_html )

Sets content of right column.

Implements ilGlobalTemplateInterface.

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

     {
         $this->right_content = $a_html;
     }

◆ setSubTabs()

ilCOPageGlobalTemplate::setSubTabs ( $a_tabs_html )

sets subtabs in standard template

Implements ilGlobalTemplateInterface.

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

References setVariable().

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

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.

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

     {
         if ($a_tabs_html != "" && $this->blockExists("tabs_outer_start")) {
             $this->touchBlock("tabs_outer_start");
             $this->touchBlock("tabs_outer_end");
             $this->touchBlock("tabs_inner_start");
             $this->touchBlock("tabs_inner_end");
             $this->setVariable("TABS", $a_tabs_html);
         }
     }

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.

Referenced by clearHeader(), and resetHeaderBlock().

     {
         $this->title = $a_title;
         $this->header_page_title = $a_title;
     }

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.

Referenced by clearHeader(), and resetHeaderBlock().

     {
         $this->icon_desc = $a_icon_desc;
         $this->icon_path = $a_icon_path;
     }

Here is the caller graph for this function:

◆ setTreeFlatIcon()

ilCOPageGlobalTemplate::setTreeFlatIcon	(	$a_link,
		$a_mode
	)

set tree/flat icon

Parameters

string	link target
strong	mode ("tree" \| "flat")

Implements ilGlobalTemplateInterface.

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

     {
         $this->tree_flat_link = $a_link;
         $this->tree_flat_mode = $a_mode;
     }

◆ setVariable()

ilCOPageGlobalTemplate::setVariable	(	$variable,
		$value = `''`
	)

Implements ilGlobalTemplateInterface.

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

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

     {
         return $this->template->setVariable($variable, $value);
     }

Here is the caller graph for this function:

◆ touchBlock()

ilCOPageGlobalTemplate::touchBlock ( $block )

overwrites ITX::touchBlock.

public

Parameters

string

Returns: ???

Implements ilGlobalTemplateInterface.

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

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

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

Here is the caller graph for this function:

◆ variableExists()

ilCOPageGlobalTemplate::variableExists ( $a_variablename )

private

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

Referenced by fillMainMenu(), and getMainMenu().

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

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:

Services/COPage/classes/class.ilCOPageGlobalTemplate.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAdminPanelToolbar()

◆ addBlockFile()

◆ addCss()

◆ addInlineCss()

◆ addJavaScript()

◆ addLightbox()

◆ addOnLoadCode()

◆ blockExists()

◆ clearHeader()

◆ enableDragDropFileUpload()

◆ fillAdminPanel()

◆ fillBodyClass()

◆ fillContentLanguage()

◆ fillCssFiles()

◆ fillFooter()

◆ fillHeader()

◆ fillInlineCss()

◆ fillJavascriptFile()

◆ fillJavaScriptFiles()

◆ fillLeftContent()

◆ fillLeftNav()

◆ fillLightbox()

◆ fillMainContent()

◆ fillMainMenu()

◆ fillMessage()

◆ fillNewContentStyle()

◆ fillOnLoadCode()

◆ fillPageFormAction()

◆ fillPermanentLink()

◆ fillRightContent()

◆ fillScreenReaderFocus()

◆ fillSideIcons()

◆ fillTabs()

◆ fillToolbar()

◆ fillWindowTitle()

◆ get()

◆ getHeaderActionMenu()

◆ getLoginTargetPar()

◆ getMainMenu()

◆ getMessageTextForType()

◆ getOnLoadCodeForAsynch()

◆ getSpecial()

◆ getTabsHTML()

◆ handleReferer()

◆ hideFooter()

◆ initHelp()

◆ loadStandardTemplate()

◆ parseCurrentBlock()

◆ printToStdout()

◆ printToString()

◆ resetCss()

◆ resetHeaderBlock()

◆ resetJavascript()

◆ setAlertProperties()

◆ setBodyClass()

◆ setCenterColumnClass()

◆ setContent()

◆ setCurrentBlock()

◆ setDescription()

◆ setHeaderActionMenu()

◆ setHeaderPageTitle()

◆ setLeftContent()

◆ setLeftNavContent()

◆ setLocator()

◆ setLoginTargetPar()

◆ setOnScreenMessage()

◆ setPageFormAction()

◆ setPermanentLink()

◆ setRightContent()