ilTemplate Class Reference

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

Inheritance diagram for ilTemplate:

Collaboration diagram for ilTemplate:

Public Member Functions
	__construct ( $file, $flag1, $flag2, $in_module=false, $vars="DEFAULT", $plugin=false, $a_use_cache=true)
	constructor More...
	init ()
	setAddFooter ($value)
	getAddFooter ()
	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...
	get ( $part="DEFAULT", $add_error_mess=false, $handle_referer=false, $add_ilias_footer=false, $add_standard_elements=false, $a_main_menu=true, $a_tabs=true)
	??? public More...
	setMessage ($a_type, $a_txt, $a_keep=false)
	Set message. More...
	hasMessage ($a_type)
	fillMessage ()
	getMessageHTML ($a_txt, $a_type="info")
	Get HTML for a system message. More...
	getContentType ()
	Get the content type for the template output. More...
	setContentType ($a_content_type="text/html")
	Set the content type for the template output. More...
	show ($part="DEFAULT", $a_fill_tabs=true, $a_skip_main_menu=false)
	fillContentLanguage ()
	Add current user language to meta tags. More...
	fillWindowTitle ()
	getTabsHTML ()
	Get tabs HTML. More...
	fillTabs ()
	fillToolbar ()
	fillPageFormAction ()
	fillJavaScriptFiles ($a_force=false)
	fillCssFiles ($a_force=false)
	Fill in the css file tags. More...
	fillInlineCss ()
	Fill in the inline css. More...
	setContentStyleSheet ($a_style)
	Set content style (used for page content editor) More...
	fillContentStyle ()
	Fill Content Style. More...
	getMainMenu ()
	fillMainMenu ()
	initHelp ()
	Init help. More...
	addILIASFooter ()
	add ILIAS footer More...
	handleReferer ()
	TODO: this is nice, but shouldn't be done here (-> maybe at the end of ilias.php!?, alex) More...
	blockExists ($a_blockname)
	check if block exists in actual template private More...
	fillVars ()
	all template vars defined in $vars will be replaced automatically without setting and parsing them with setVariable & parseCurrentBlock private More...
	setCurrentBlock ($part="DEFAULT")
	Überladene Funktion, die sich hier lokal noch den aktuellen Block merkt. 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...
	replaceFromDatabase (&$DB, $block, $conv, $select="default")
	??? TODO: Adjust var names to ilias. More...
	prepareForFormular ($vars)
	Wird angewendet, wenn die Daten in ein Formular replaced werden sollen, Dann wird erst noch ein htmlspecialchars drumherum gemacht. More...
	replace ()
	??? public More...
	replaceDefault ()
	??? public More...
	checkTopic ($a_block, $a_topic)
	checks for a topic in the template private More...
	includeNavigation ()
	check if there is a NAVIGATION-topic public More...
	includeTree ()
	check if there is a TREE-topic public More...
	fileExists ($filename)
	check if a file exists public More...
	addBlockFile ($var, $block, $tplname, $in_module=false)
	overwrites ITX::addBlockFile public More...
	loadTemplatefile ( $filename, $removeUnknownVariables=true, $removeEmptyBlocks=true)
	Reads a template file from the disk. More...
	getTemplatePath ($a_tplname, $a_in_module=false, $a_plugin=false)
	builds a full template path with template and module name More...
	getTemplateIdentifier ($a_tplname, $a_in_module=false)
	get a unique template identifier More...
	setHeaderPageTitle ($a_title)
	setStyleSheetLocation ($a_stylesheet)
	setNewContentStyleSheetLocation ($a_stylesheet)
	getStandardTemplate ()
	setTitle ($a_title)
	sets title in standard template More...
	setTitleUrl ($a_url)
	sets title url in standard template More...
	setTitleColor ($a_val)
	Set title color. More...
	getTitleColor ()
	Get title color. More...
	setAlertProperties (array $a_props)
	Set alert properties. More...
	clearHeader ()
	Clear header. More...
	setTitleIcon ($a_icon_path, $a_icon_desc="")
	set title icon More...
	setBodyClass ($a_class="")
	fillBodyClass ()
	setPageFormAction ($a_action)
	setDescription ($a_descr)
	sets title in standard template More...
	stopTitleFloating ()
	set stop floating (if no tabs are used) More...
	setHeaderActionMenu ($a_header)
	Set header action menu. More...
	getHeaderActionMenu ()
	Get header action menu. More...
	setContent ($a_html)
	sets content for standard template More...
	fillMainContent ()
	Fill main content. More...
	setRightContent ($a_html)
	sets content of right column More...
	setLeftContent ($a_html)
	sets content of left column More...
	setLeftNavContent ($a_content)
	Sets content of left navigation column. More...
	fillLeftNav ()
	Fill left navigation frame. 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...
	setUpperIcon ($a_link, $a_frame="")
	sets icon to upper level More...
	setLoginTargetPar ($a_val)
	Set target parameter for login (public sector). More...
	getLoginTargetPar ()
	Get target parameter for login. More...
	fillScreenReaderFocus ()
	Accessibility focus for screen readers. More...
	fillSideIcons ()
	Fill side icons (upper icon, tree icon, webfolder icon) More...
	setMountWebfolderIcon ($a_ref_id)
	shows icon for mounting a webfolder More...
	setTreeFlatIcon ($a_link, $a_mode)
	set tree/flat icon 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...
	resetJavascript ()
	Reset javascript files. More...
	resetCss ()
	Reset css files. More...
	addOnLoadCode ($a_code, $a_batch=2)
	Add on load code. More...
	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...
	addLightbox ($a_html, $a_id)
	Add lightbox html. More...
	fillLightbox ()
	Fill lightbox content. More...
	setPageActions ($a_page_actions_html)
	Show admin view button. More...
	setEditPageButton ($a_link, $a_txt, $a_frame)
	Show admin view button. More...
	addAdminPanelCommand ($a_cmd, $a_txt, $a_arrow=false)
	Add a command to the admin panel. More...
	addAdminPanelToolbar (ilToolbarGUI $toolb, $a_bottom_panel=true, $a_arrow=false)
	Add admin panel commands as toolbar. More...
	fillAdminPanel ()
	Put admin panel into template: More...
	setPermanentLink ($a_type, $a_id, $a_append="", $a_target="", $a_title="")
	fillPermanentLink ()
	Fill in permanent link. More...
	fillOnLoadCode ()
	Fill add on load code. More...
	getOnLoadCodeForAsynch ()
	Get js onload code for ajax calls. More...
	setBackgroundColor ($a_bg_color)
	setBanner ($a_img, $a_width=1370, $a_height=100, $a_export=false)
	Set banner. More...
	resetHeaderBlock ($a_reset_header_action=true)
	Set variable. More...
	enableDragDropFileUpload ($a_ref_id)
	Enables the file upload into this object by dropping a file. More...
	__construct ($file, $flag1, $flag2, $in_module=false, $vars="DEFAULT")
	constructor More...
	getTemplatePath ($a_tplname, $a_in_module=false, $a_plugin=false)
	builds a full template path with template and module name More...
	addBlockFile ($var, $block, $tplname, $in_module=false)
	show ($part="DEFAULT")
	public More...
	getMessageHTML ($a_txt, $a_type="info")
	Get HTML for a system message. More...
	setCurrentBlock ($part="DEFAULT")
	Überladene Funktion, die sich hier lokal noch den aktuellen Block merkt. 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...
	setMessage ($a_type, $a_txt, $a_keep=false)
	Set message. More...
	fillMessage ()
	blockExists ($a_blockname)
	check if block exists in actual template private More...
	addJavaScript ($a_js_file)
	Add a javascript file that should be included in the header. More...
	fillJavaScriptFiles ()
	addCss ($a_css_file, $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...
	get ($part="DEFAULT")
Public Member Functions inherited from HTML_Template_ITX
	__construct ($root='')
	Builds some complex regexps and calls the constructor of the parent class. More...
	init ()
	replaceBlock ($block, $template, $keep_content=false)
	Replaces an existing block with new content. More...
	replaceBlockfile ($block, $filename, $keep_content=false)
	Replaces an existing block with new content from a file. More...
	addBlock ($placeholder, $blockname, $template)
	Adds a block to the template changing a variable placeholder to a block placeholder. More...
	addBlockfile ($placeholder, $blockname, $filename)
	Adds a block taken from a file to the template changing a variable placeholder to a block placeholder. More...
	placeholderExists ($placeholder, $block='')
	Returns the name of the (first) block that contains the specified placeholder. More...
	performCallback ()
	Checks the list of function calls in the template and calls their callback function. More...
	getFunctioncalls ()
	Returns a list of all function calls in the current template. More...
	setFunctioncontent ($functionID, $replacement)
	Replaces a function call with the given replacement. More...
	setCallbackFunction ($tplfunction, $callbackfunction, $callbackobject='', $expandCallbackParameters=false)
	Sets a callback function. More...
	setCallbackFuntiontable ($functions)
	Sets the Callback function lookup table. More...
	removeBlockData ($block)
	Recursively removes all data assiciated with a block, including all inner blocks. More...
	getBlocklist ()
	Returns a list of blocknames in the template. More...
	blockExists ($blockname)
	Checks wheter a block exists. More...
	getBlockvariables ($block)
	Returns a list of variables of a block. More...
	BlockvariableExists ($block, $variable)
	Checks wheter a block variable exists. More...
	buildFunctionlist ()
	Builds a functionlist from the template. More...
	getValue ($code, $delimiter)
	Truncates the given code from the first occurence of $delimiter but ignores $delimiter enclosed by " or '. More...
	deleteFromBlockvariablelist ($block, $variables)
	Deletes one or many variables from the block variable list. More...
	updateBlockvariablelist ($block)
	Updates the variable list of a block. More...
	findPlaceholderBlocks ($variable)
	Returns an array of blocknames where the given variable placeholder is used. More...
	warning ($message, $file='', $line=0)
	Handles warnings, saves them to $warn and prints them or calls die() depending on the flags. More...
Public Member Functions inherited from HTML_Template_IT
	__construct ($root='', $options=null)
	Builds some complex regular expressions and optinally sets the file root directory. More...
	setOption ($option, $value)
	Sets the option for the template class. More...
	setOptions ($options)
	Sets the options for the template class. More...
	show ($block='__global__')
	Print a certain block with all replacements done. More...
	get ($block='__global__')
	Returns a block with all replacements done. More...
	parse ($block='__global__', $flag_recursion=false)
	Parses the given block. More...
	parseCurrentBlock ()
	Parses the current block. More...
	setVariable ($variable, $value='')
	Sets a variable value. More...
	setCurrentBlock ($block='__global__')
	Sets the name of the current block that is the block where variables are added. More...
	touchBlock ($block)
	Preserves an empty block even if removeEmptyBlocks is true. More...
	init ()
	Clears all datafields of the object and rebuild the internal blocklist. More...
	free ()
	Clears all datafields of the object. More...
	setTemplate ( $template, $removeUnknownVariables=true, $removeEmptyBlocks=true)
	Sets the template. More...
	loadTemplatefile ( $filename, $removeUnknownVariables=true, $removeEmptyBlocks=true)
	Reads a template file from the disk. More...
	setRoot ($root)
	Sets the file root. More...
	buildBlockvariablelist ()
	Build a list of all variables within of a block. More...
	getGlobalvariables ()
	Returns a list of all global variables. More...
	findBlocks ($string)
	Recusively builds a list of all blocks within the template. More...
	getFile ($filename)
	Reads a file from disk and returns its content. More...
	_addPregDelimiters ($str)
	Adds delimiters to a string, so it can be used as a pattern in preg_* functions. More...
	_preserveOpeningDelimiter ($str)
	Replaces an opening delimiter by a special string. More...
	errorMessage ($value, $blockname='')
	Return a textual error message for a IT error code. More...

Static Public Member Functions
static	buildLoginTarget ()
	Add current object (repository/workspace) as target for login url. More...

Data Fields
const	MESSAGE_TYPE_FAILURE = 'failure'
const	MESSAGE_TYPE_INFO = "info"
const	MESSAGE_TYPE_SUCCESS = "success"
const	MESSAGE_TYPE_QUESTION = "question"
	$contenttype
	$vars
	$activeBlock
	$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()
	$admin_panel_commands = array()
Data Fields inherited from HTML_Template_ITX
	$warn = array()
	$printWarning = false
	$haltOnWarning = false
	$checkblocknameRegExp = ''
	$functionPrefix = 'func_'
	$functionnameRegExp = '[_a-zA-Z]+[A-Za-z_0-9]*'
	$functionRegExp = ''
	$functions = array()
	$callback = array()
Data Fields inherited from HTML_Template_IT
	$err = array()
	$clearCache = false
	$openingDelimiter = '{'
	$closingDelimiter = '}'
	$blocknameRegExp = '[\.0-9A-Za-z_-]+'
	$variablenameRegExp = '[\.0-9A-Za-z_-]+'
	$variablesRegExp = ''
	$removeVariablesRegExp = ''
	RegExp used to strip unused variable placeholder. More...
	$removeUnknownVariables = true
	$removeEmptyBlocks = true
	$blockRegExp = ''
	$currentBlock = '__global__'
	$template = ''
	$blocklist = array()
	$blockdata = array()
	$blockvariables = array()
	$blockinner = array()
	$touchedBlocks = array()
	List of blocks to preverse even if they are "empty". More...
	$_hiddenBlocks = array()
	List of blocks which should not be shown even if not "empty". More...
	$variableCache = array()
	$clearCacheOnParse = false
	$fileRoot = ''
	$flagBlocktrouble = false
	$flagGlobalParsed = false
	$flagCacheTemplatefile = true
	$lastTemplatefile = ''
	EXPERIMENTAL! FIXME! More...
	$_options
	$_options['preserve_data'] Whether to substitute variables and remove empty placeholders in data passed through setVariable (see also bugs #20199, #21951). More...

Protected Member Functions
	fillJavascriptFile ($file, $vers)

Protected Attributes
	$tpl
	$message = array()
	$title_desc = ""
	$title_url = ""
	$upper_icon = ""
	$tree_flat_link = ""
	$mount_webfolder = ""
	$stop_floating = ""
	$page_form_action = ""
	$page_actions = array()
	$permanent_link = false
	$content_style_sheet = ""
	$title_alerts = array()
	$header_action
	$lightbox = array()
	$standard_template_loaded = false
	$translation_linked = false

Static Protected Attributes
static	$message_types
static	$il_cache = array()

Private Member Functions
	fillNewContentStyle ()
	Fill Content Style. More...
	variableExists ($a_variablename)
	fillHeader ()
	Fill header. More...
	fillStopFloating ()
	stop floating More...
	fillRightContent ()
	Fill right content. More...
	setCenterColumnClass ()
	fillLeftContent ()
	Fill left content. More...
	getMessageTextForType ($m)

Private Attributes
	$addFooter

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.ilTemplate.php.

Constructor & Destructor Documentation

__construct() [1/2]

ilTemplate::__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 92 of file class.ilTemplate.php.

References $DIC, $file, $ilErr, array, getTemplateIdentifier(), getTemplatePath(), loadTemplatefile(), setBodyClass(), and HTML_Template_IT\setOption().

      {
        global $DIC;

        //echo "<br>-".$file."-";

        $this->activeBlock = "__global__";
        $this->vars = array();
        $this->addFooter = true;
        
        $this->il_use_cache = $a_use_cache;
        $this->il_cur_key = $file . "/" . $in_module;

        $fname = $this->getTemplatePath($file, $in_module, $plugin);

        $this->tplName = basename($fname);
        $this->tplPath = dirname($fname);
        $this->tplIdentifier = $this->getTemplateIdentifier($file, $in_module);
        
        // set default content-type to text/html
        $this->contenttype = "text/html";
        if (!file_exists($fname)) {
            if (isset($DIC["ilErr"])) {
                $ilErr = $DIC["ilErr"];
                $ilErr->raiseError("template " . $fname . " was not found.", $ilErr->FATAL);
            }
            return false;
        }

        //$this->IntegratedTemplateExtension(dirname($fname));
        parent::__construct();
        //$this->loadTemplatefile(basename($fname), $flag1, $flag2);
        $this->loadTemplatefile($fname, $flag1, $flag2);
        //add tplPath to replacevars
        $this->vars["TPLPATH"] = $this->tplPath;
        
        // set Options
        if (method_exists($this, "setOption")) {
            $this->setOption('use_preg', false);
        }
        $this->setBodyClass("std");

        return true;
    }

Here is the call graph for this function:

__construct() [2/2]

ilTemplate::__construct	(		$file,
			$flag1,
			$flag2,
			$in_module = false,
			$vars = "DEFAULT"
	)

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 50 of file class.ilTemplate.php.

References $file, array, getTemplatePath(), loadTemplatefile(), and HTML_Template_IT\setOption().

    {
        $this->activeBlock = "__global__";
        $this->vars = array();

        $fname = $this->getTemplatePath($file, $in_module);

        $this->tplName = basename($fname);
        $this->tplPath = dirname($fname);
        // set default content-type to text/html
        $this->contenttype = "text/html";
        if (!file_exists($fname)) {
            die("template " . $fname . " was not found.");
            return false;
        }

        //$this->IntegratedTemplateExtension(dirname($fname));
        parent::__construct();
        //$this->loadTemplatefile(basename($fname), $flag1, $flag2);
        $this->loadTemplatefile($fname, $flag1, $flag2);
        //add tplPath to replacevars
        $this->vars["TPLPATH"] = $this->tplPath;
        
        // set Options
        if (method_exists($this, "setOption")) {
            $this->setOption('use_preg', false);
        }

        return true;
    }

Here is the call graph for this function:

Member Function Documentation

addAdminPanelCommand()

ilTemplate::addAdminPanelCommand	(		$a_cmd,
			$a_txt,
			$a_arrow = false
	)

Add a command to the admin panel.

Deprecated:

use addAdminPanelToolbar

Definition at line 2248 of file class.ilTemplate.php.

References array.

    {
        $this->admin_panel_commands[] =
            array("cmd" => $a_cmd, "txt" => $a_txt);
        if ($a_arrow) {
            $this->admin_panel_arrow = true;
        }
        $this->admin_panel_top_only = false;
    }

addAdminPanelToolbar()

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

Add admin panel commands as toolbar.

Parameters

ilToolbarGUI	$toolb
bool	$a_top_only

Definition at line 2263 of file class.ilTemplate.php.

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

addBlockFile() [1/2]

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

Definition at line 125 of file class.ilTemplate.php.

References DEBUG, and getTemplatePath().

    {
        if (DEBUG) {
            echo "<br/>Template '" . $this->tplPath . "/" . $tplname . "'";
        }

        $tplfile = $this->getTemplatePath($tplname, $in_module);
        if (file_exists($tplfile) == false) {
            echo "<br/>Template '" . $tplfile . "' doesn't exist! aborting...";
            return false;
        }

        return parent::addBlockFile($var, $block, $tplfile);
    }

Here is the call graph for this function:

addBlockFile() [2/2]

ilTemplate::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

Definition at line 1337 of file class.ilTemplate.php.

References $DIC, $id, HTML_Template_IT\$template, HTML_Template_ITX\addBlock(), array, DEBUG, HTML_Template_IT\getFile(), ilPluginAdmin\getPluginObject(), getTemplateIdentifier(), getTemplatePath(), IL_COMP_SERVICE, and ilUIHookPluginGUI\KEEP.

Referenced by getStandardTemplate().

    {
        global $DIC;

        if (DEBUG) {
            echo "<br/>Template '" . $this->tplPath . "/" . $tplname . "'";
        }

        $tplfile = $this->getTemplatePath($tplname, $in_module);
        if (file_exists($tplfile) == false) {
            echo "<br/>Template '" . $tplfile . "' doesn't exist! aborting...";
            return false;
        }

        $id = $this->getTemplateIdentifier($tplname, $in_module);
        $template = $this->getFile($tplfile);
        
        // include the template input hook
        $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_add",
                array("tpl_id" => $id, "tpl_obj" => $this, "html" => $template)
            );

            if ($resp["mode"] != ilUIHookPluginGUI::KEEP) {
                $template = $gui_class->modifyHTML($template, $resp);
            }
        }
        
        return $this->addBlock($var, $block, $template);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addCss() [1/2]

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

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

Definition at line 413 of file class.ilTemplate.php.

References array.

    {
        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);
        }
    }

addCss() [2/2]

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

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

Definition at line 2188 of file class.ilTemplate.php.

References array.

    {
        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);
        }
    }

addILIASFooter()

ilTemplate::addILIASFooter

(

)

add ILIAS footer

Definition at line 865 of file class.ilTemplate.php.

References $_GET, $_SERVER, $d, $debug, $DIC, $file, $GLOBALS, $ilBench, $ilCtrl, $ilDB, $ilSetting, $l, $lng, $php, $total, $url, ilObjLanguageAccess\_checkTranslate(), ilLink\_getStaticLink(), ilObjLanguageAccess\_getTranslationLink(), ilObjLanguageAccess\_isPageTranslation(), ilUtil\appendUrlParameterString(), array, getAddFooter(), ilSystemSupportContactsGUI\getFooterLink(), ilSystemSupportContactsGUI\getFooterText(), ilImprint\isActive(), ilUtil\secureUrl(), HTML_Template_IT\setVariable(), ilUtil\sortArray(), and ilValidatorAdapter\validate().

Referenced by get(), and show().

    {
        global $DIC;

        $ilSetting = $DIC->settings();

        $lng = $DIC->language();

        $ilCtrl = $DIC->ctrl();
        $ilDB = $DIC->database();

        if (!$this->getAddFooter()) {
            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()) {
            // fix #9992: remember linked translation instead of saving language usages here
            $this->translation_linked = true;
            $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);
                //echo "-".ilValidatorAdapter::validate($template2->get(), $_GET["do_dev_validate"])."-";
                $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();
                
                // debug hack
                $debug = $ilCtrl->getDebug();
                foreach ($debug as $d) {
                    $ftpl->setCurrentBlock("c_entry");
                    $ftpl->setVariable("C_ENTRY", $d);
                    $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:

addInlineCss()

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

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

Definition at line 2198 of file class.ilTemplate.php.

References array.

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

addJavaScript() [1/2]

ilTemplate::addJavaScript

(

$a_js_file

)

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

Definition at line 389 of file class.ilTemplate.php.

    {
        if (!in_array($a_js_file, $this->js_files)) {
            $this->js_files[] = $a_js_file;
        }
    }

addJavaScript() [2/2]

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

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

Definition at line 2130 of file class.ilTemplate.php.

Referenced by assQuestionGUI\populateJavascriptFilesRequiredForWorkForm(), and assMultipleChoiceGUI\populateJavascriptFilesRequiredForWorkForm().

    {
        // 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;
        }
    }

Here is the caller graph for this function:

addLightbox()

ilTemplate::addLightbox	(		$a_html,
			$a_id
	)

Add lightbox html.

Definition at line 2206 of file class.ilTemplate.php.

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

addOnLoadCode()

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

Add on load code.

Definition at line 2176 of file class.ilTemplate.php.

Referenced by ilWikiPageGUI\initEditingJS().

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

Here is the caller graph for this function:

blockExists() [1/2]

ilTemplate::blockExists

(

$a_blockname

)

check if block exists in actual template private

Parameters

string

blockname

Returns

boolean

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

    {
        // added second evaluation to the return statement because the first one only works for the content block (Helmut Schottmüller, 2007-09-14)
        return (isset($this->blockvariables["content"][$a_blockname]) ? true : false) | (isset($this->blockvariables[$a_blockname]) ? true : false);
    }

blockExists() [2/2]

ilTemplate::blockExists

(

$a_blockname

)

check if block exists in actual template private

Parameters

string

blockname

Returns

boolean

Definition at line 1108 of file class.ilTemplate.php.

Referenced by fillBodyClass(), fillCssFiles(), fillInlineCss(), fillJavaScriptFiles(), fillScreenReaderFocus(), fillTabs(), get(), getTabsHTML(), ilTinyMCE\handleImgContextMenuItem(), setCenterColumnClass(), setTabs(), and show().

    {
        // added second evaluation to the return statement because the first one only works for the content block (Helmut Schottmüller, 2007-09-14)
        return (isset($this->blockvariables["content"][$a_blockname]) ? true : false) | (isset($this->blockvariables[$a_blockname]) ? true : false);
    }

Here is the caller graph for this function:

buildLoginTarget()

static ilTemplate::buildLoginTarget ( )

static

Add current object (repository/workspace) as target for login url.

Returns

string

Definition at line 2439 of file class.ilTemplate.php.

References $_GET, $DIC, $ilUser, $type, ilObject\_lookupObjId(), ilObject\_lookupType(), and ilWorkspaceTree\lookupObjectId().

Referenced by ilMainMenuGUI\setTemplateVars().

    {
        global $DIC;

        $tree = $DIC->repositoryTree();
        $ilUser = $DIC->user();
                
        $target_str = "";
        
        // repository
        if ($_GET["ref_id"] != "") {
            if ($tree->isInTree($_GET["ref_id"]) && $_GET["ref_id"] != $tree->getRootId()) {
                $obj_id = ilObject::_lookupObjId($_GET["ref_id"]);
                $type = ilObject::_lookupType($obj_id);
                $target_str = $type . "_" . $_GET["ref_id"];
            }
        }
        // personal workspace
        elseif ($_GET["wsp_id"] != "" && $_GET["wsp_id"] > 0) {
            include_once "Services/PersonalWorkspace/classes/class.ilWorkspaceTree.php";
            $tree = new ilWorkspaceTree($ilUser->getId());
            $obj_id = $tree->lookupObjectId((int) $_GET["wsp_id"]);
            if ($obj_id) {
                $type = ilObject::_lookupType($obj_id);
                $target_str = $type . "_" . (int) $_GET["wsp_id"] . "_wsp";
            }
        }
        // portfolio
        elseif ($_GET["prt_id"] != "") {
            $target_str = "prtf_" . (int) $_GET["prt_id"];
        }
        
        return $target_str;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkTopic()

ilTemplate::checkTopic	(		$a_block,
			$a_topic
	)

checks for a topic in the template private

Parameters

string
string

Returns

boolean

Definition at line 1292 of file class.ilTemplate.php.

Referenced by includeNavigation(), and includeTree().

    {
        return array_key_exists($a_topic, $this->blockvariables[$a_block]);
    }

Here is the caller graph for this function:

clearHeader()

ilTemplate::clearHeader

(

)

Clear header.

Definition at line 1635 of file class.ilTemplate.php.

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

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

Here is the call graph for this function:

enableDragDropFileUpload()

ilTemplate::enableDragDropFileUpload

(

$a_ref_id

)

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

Definition at line 2504 of file class.ilTemplate.php.

Referenced by resetHeaderBlock().

    {
        $this->enable_fileupload = $a_ref_id;
    }

Here is the caller graph for this function:

fileExists()

ilTemplate::fileExists

(

$filename

)

check if a file exists public

Returns

boolean

Definition at line 1322 of file class.ilTemplate.php.

References $filename.

    {
        return file_exists($this->tplPath . "/" . $filename);
    }

fillAdminPanel()

ilTemplate::fillAdminPanel

(

)

Put admin panel into template:

• creation selector
• admin view on/off button

Definition at line 2275 of file class.ilTemplate.php.

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

Referenced by get(), and show().

    {
        global $DIC;

        $lng = $DIC->language();

        $adm_view_cmp = $adm_cmds = $adm_view = false;
        
        $toolb = new ilToolbarGUI();
        
        // admin panel commands
        if ((count($this->admin_panel_commands) > 0)) {
            foreach ($this->admin_panel_commands as $cmd) {
                $toolb->addFormButton($cmd["txt"], $cmd["cmd"]);
            }
            $adm_cmds = true;
        } elseif ($this->admin_panel_commands_toolbar instanceof  ilToolbarGUI) {
            $toolb = $this->admin_panel_commands_toolbar;
            $adm_cmds = true;
        }
        // Add arrow if desired
        if ($this->admin_panel_arrow) {
            $toolb->setLeadingImage(ilUtil::getImagePath("arrow_upright.svg"), $lng->txt("actions"));
        }

        if ($adm_cmds) {
            $this->fillPageFormAction();
            
            $this->setCurrentBlock("adm_view_components");
            $this->setVariable("ADM_PANEL1", $toolb->getHTML());
            $this->parseCurrentBlock();
            $adm_view_cmp = true;
        }
        
        // admin view button
        if ($this->page_actions != "") {
            $this->setVariable("PAGE_ACTIONS", $this->page_actions);
            $adm_view = true;
        }

        // creation selector
        // see: ilObjectAddNewItemGUI
        // placeholder "SELECT_OBJTYPE_REPOS" still needed!
        
        if ($adm_cmds and $this->admin_panel_bottom) {
            $this->setCurrentBlock("adm_view_components2");
            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()

ilTemplate::fillBodyClass

(

)

Definition at line 1743 of file class.ilTemplate.php.

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

Referenced by get(), and show().

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

ilTemplate::fillContentLanguage

(

)

Add current user language to meta tags.

public

Definition at line 605 of file class.ilTemplate.php.

References $DIC, $ilUser, $lng, array, and HTML_Template_IT\setVariable().

Referenced by get(), and show().

    {
        global $DIC;

        $lng = $DIC->language();
        $ilUser = $DIC->user();

        $contentLanguage = 'en';
        $rtl = array('ar','fa','ur','he');//, 'de'); //make a list of rtl languages
        /* rtl-review: add "de" for testing with ltr lang shown in rtl
         * and set unicode-bidi to bidi-override for mirror effect */
        $textdir = 'ltr';
        if (is_object($ilUser)) {
            if ($ilUser->getLanguage()) {
                $contentLanguage = $ilUser->getLanguage();
            } elseif (is_object($lng)) {
                $contentLanguage = $lng->getDefaultLanguage();
            }
            if ($ilUser->getId() == ANONYMOUS_USER_ID && is_object($lng)) {
                $contentLanguage = $lng->getLangKey();
            }
        }
        $this->setVariable('META_CONTENT_LANGUAGE', $contentLanguage);
        if (in_array($contentLanguage, $rtl)) {
            $textdir = 'rtl';
        }
        $this->setVariable('LANGUAGE_DIRECTION', $textdir);
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillContentStyle()

ilTemplate::fillContentStyle

(

)

Fill Content Style.

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

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

Referenced by get(), and show().

    {
        if ($this->content_style_sheet != "") {
            $this->setCurrentBlock("ContentStyle");
            $this->setVariable(
                "LOCATION_CONTENT_STYLESHEET",
                $this->content_style_sheet
            );
            $this->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillCssFiles() [1/2]

ilTemplate::fillCssFiles

(

$a_force = false

)

Fill in the css file tags.

Parameters

boolean

$a_force

Definition at line 425 of file class.ilTemplate.php.

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

    {
        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:

fillCssFiles() [2/2]

ilTemplate::fillCssFiles

(

$a_force = false

)

Fill in the css file tags.

Parameters

boolean

$a_force

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

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

Referenced by get(), and show().

    {
        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:

fillHeader()

ilTemplate::fillHeader ( )

private

Fill header.

Definition at line 1647 of file class.ilTemplate.php.

References $DIC, $header, $lng, array, getHeaderActionMenu(), getTitleColor(), HTML_Template_IT\parseCurrentBlock(), setCurrentBlock(), HTML_Template_IT\setVariable(), ilUtil\stripScriptHTML(), and touchBlock().

Referenced by get(), and show().

    {
        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 != "") {
            $this->title = ilUtil::stripScriptHTML($this->title);
            $this->setVariable("HEADER", $this->title);
            if ($this->title_url != "") {
                $this->setVariable("HEADER_URL", ' href="' . $this->title_url . '"');
            }
            if ($this->getTitleColor() != "") {
                $this->setVariable("HEADER_COLOR", " style=\"color: #" . $this->getTitleColor() . "\"");
            }
            
            if ($icon) {
                //$this->setVariable("HICONCL", "ilHeaderHasIcon");
            }
            $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();
            $this->touchBlock("head_action");
        }

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

ilTemplate::fillInlineCss

(

)

Fill in the inline css.

Parameters

boolean

$a_force

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

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

Referenced by get(), and show().

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

Here is the call graph for this function:

Here is the caller graph for this function:

fillJavascriptFile()

ilTemplate::fillJavascriptFile (   $file,   $vers  )

protected

Parameters

string	$file
string	$vers

Definition at line 148 of file class.ilTemplate.php.

References $file, ilUtil\appendUrlParameterString(), HTML_Template_IT\parseCurrentBlock(), setCurrentBlock(), and HTML_Template_IT\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() [1/2]

ilTemplate::fillJavaScriptFiles

(

)

Definition at line 396 of file class.ilTemplate.php.

References $file, blockExists(), HTML_Template_IT\parseCurrentBlock(), setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by get(), and show().

    {
        global $ilias,$ilTabs;
        if ($this->blockExists("js_file")) {
            foreach ($this->js_files as $file) {
                if (is_file($file) || substr($file, 0, 4) == "http") {
                    $this->setCurrentBlock("js_file");
                    $this->setVariable("JS_FILE", $file);
                    $this->parseCurrentBlock();
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillJavaScriptFiles() [2/2]

ilTemplate::fillJavaScriptFiles

(

$a_force = false

)

Definition at line 718 of file class.ilTemplate.php.

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

    {
        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:

fillLeftContent()

ilTemplate::fillLeftContent ( )

private

Fill left content.

Definition at line 1881 of file class.ilTemplate.php.

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

Referenced by get(), and show().

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

ilTemplate::fillLeftNav

(

)

Fill left navigation frame.

Definition at line 1905 of file class.ilTemplate.php.

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

Referenced by get(), and show().

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

ilTemplate::fillLightbox

(

)

Fill lightbox content.

Parameters

Definition at line 2217 of file class.ilTemplate.php.

References $html, and HTML_Template_IT\setVariable().

Referenced by get(), and show().

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

ilTemplate::fillMainContent

(

)

Fill main content.

Definition at line 1817 of file class.ilTemplate.php.

References HTML_Template_IT\setVariable().

Referenced by get(), and show().

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

ilTemplate::fillMainMenu

(

)

Definition at line 842 of file class.ilTemplate.php.

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

Referenced by get(), and show().

    {
        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() [1/2]

ilTemplate::fillMessage

(

)

Definition at line 331 of file class.ilTemplate.php.

References $lng, $m, $out, $txt, array, ilSession\clear(), ilSession\get(), and HTML_Template_IT\setVariable().

    {
        global $lng;
        
        $ms = array("info", "success", "failure", "question");
        $out = "";
        
        foreach ($ms as $m) {
            if ($m == "question") {
                $m = "mess_question";
            }

            $txt = (ilSession::get($m) != "")
                ? ilSession::get($m)
                : $this->message[$m];
                
            if ($m == "mess_question") {
                $m = "question";
            }

            if ($txt != "") {
                $mtpl = new ilTemplate("tpl.message.html", true, true, "Services/Utilities");
                $mtpl->setCurrentBlock($m . "_message");
                $mtpl->setVariable("TEXT", $txt);
                $mtpl->setVariable("MESSAGE_HEADING", $lng->txt($m . "_message"));
                $mtpl->parseCurrentBlock();
                $out.= $mtpl->get();
            }
        
            if ($m == "question") {
                $m = "mess_question";
            }

            if (ilSession::get($m)) {
                ilSession::clear($m);
            }
        }
        
        if ($out != "") {
            $this->setVariable("MESSAGE", $out);
        }
    }

Here is the call graph for this function:

fillMessage() [2/2]

ilTemplate::fillMessage

(

)

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

References $_SESSION, $DIC, $m, $out, $txt, array, getMessageHTML(), getMessageTextForType(), and HTML_Template_IT\setVariable().

Referenced by get(), and show().

    {
        global $DIC;

        $ms = array( self::MESSAGE_TYPE_INFO,
                     self::MESSAGE_TYPE_SUCCESS, self::MESSAGE_TYPE_FAILURE,
                     self::MESSAGE_TYPE_QUESTION
        );
        $out = "";
        
        foreach ($ms as $m) {
            if ($m == self::MESSAGE_TYPE_QUESTION) {
                $m = "mess_question";
            }
            $txt = $this->getMessageTextForType($m);

            if ($m == "mess_question") {
                $m = self::MESSAGE_TYPE_QUESTION;
            }

            if ($txt != "") {
                $out.= $this->getMessageHTML($txt, $m);
            }
        
            if ($m == self::MESSAGE_TYPE_QUESTION) {
                $m = "mess_question";
            }

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

ilTemplate::fillNewContentStyle ( )

private

Fill Content Style.

Definition at line 819 of file class.ilTemplate.php.

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

Referenced by get(), and show().

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

ilTemplate::fillOnLoadCode

(

)

Fill add on load code.

Definition at line 2363 of file class.ilTemplate.php.

References $code, $i, HTML_Template_IT\parseCurrentBlock(), setCurrentBlock(), and HTML_Template_IT\setVariable().

Referenced by get(), and show().

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

ilTemplate::fillPageFormAction

(

)

Definition at line 708 of file class.ilTemplate.php.

References HTML_Template_IT\parseCurrentBlock(), setCurrentBlock(), HTML_Template_IT\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()

ilTemplate::fillPermanentLink

(

)

Fill in permanent link.

Definition at line 2343 of file class.ilTemplate.php.

References HTML_Template_IT\setVariable().

Referenced by get(), and show().

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

ilTemplate::fillRightContent ( )

private

Fill right content.

Definition at line 1835 of file class.ilTemplate.php.

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

Referenced by get(), and show().

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

ilTemplate::fillScreenReaderFocus

(

)

Accessibility focus for screen readers.

Definition at line 2004 of file class.ilTemplate.php.

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

Referenced by get(), and show().

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

ilTemplate::fillSideIcons

(

)

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

Definition at line 2018 of file class.ilTemplate.php.

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

Referenced by get(), and show().

    {
        global $DIC;

        $ilSetting = $DIC->settings();

        $lng = $DIC->language();

        if ($this->upper_icon == "" && $this->tree_flat_link == ""
            && $this->mount_webfolder == "") {
            return;
        }
        
        // upper icon
        // deprecated
        if ($this->upper_icon != "") {
            /*if ($this->upper_icon_frame != "")
            {
                $this->setCurrentBlock("target_top");
                $this->setVariable("TARGET_TOP", $this->upper_icon_frame);
                $this->parseCurrentBlock();
            }

            $this->setCurrentBlock("alt_top");
            $this->setVariable("ALT_TOP", $lng->txt("up"));
            $this->parseCurrentBlock();

            $this->setCurrentBlock("top");
            $this->setVariable("LINK_TOP", $this->upper_icon);
            $this->parseCurrentBlock();*/
        }
        
        // 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();
        }
        
        // mount webfolder
        if ($this->mount_webfolder != "") {
            require_once('Services/WebDAV/classes/class.ilDAVServer.php');
            $davServer = ilDAVServer::getInstance();
            $a_ref_id = $this->mount_webfolder;
            $a_link =  $davServer->getMountURI($a_ref_id);
            $a_folder = $davServer->getFolderURI($a_ref_id);
            
            $this->setCurrentBlock("mount_webfolder");
            $this->setVariable("LINK_MOUNT_WEBFOLDER", $a_link);
            $this->setVariable("FOLDER_MOUNT_WEBFOLDER", $a_folder);
            $this->setVariable("IMG_MOUNT_WEBFOLDER", ilUtil::getImagePath("ic_mount_webfolder.png"));
            $this->setVariable("ALT_MOUNT_WEBFOLDER", $lng->txt("mount_webfolder"));
            $this->setVariable("TARGET_MOUNT_WEBFOLDER", '_blank');
            $this->parseCurrentBlock();
        }
        
        $this->setCurrentBlock("tree_icons");
        $this->parseCurrentBlock();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillStopFloating()

ilTemplate::fillStopFloating ( )

private

stop floating

Definition at line 1777 of file class.ilTemplate.php.

References touchBlock().

Referenced by get(), and show().

    {
        if ($this->stop_floating) {
            $this->touchBlock("stop_floating");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillTabs()

ilTemplate::fillTabs

(

)

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

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

Referenced by get(), and show().

    {
        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->thtml != "") {
                $this->setVariable("TABS", $this->thtml);
            }
            $this->setVariable("SUB_TABS", $this->sthtml);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillToolbar()

ilTemplate::fillToolbar

(

)

Definition at line 693 of file class.ilTemplate.php.

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

Referenced by get(), and show().

    {
        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:

fillVars()

ilTemplate::fillVars

(

)

all template vars defined in $vars will be replaced automatically without setting and parsing them with setVariable & parseCurrentBlock private

Returns

integer

Definition at line 1125 of file class.ilTemplate.php.

References $key, and HTML_Template_IT\setVariable().

Referenced by parseCurrentBlock(), and touchBlock().

    {
        $count = 0;
        reset($this->vars);

        foreach ($this->vars as $key => $val) {
            if (is_array($this->blockvariables[$this->activeBlock])) {
                if (array_key_exists($key, $this->blockvariables[$this->activeBlock])) {
                    $count++;

                    $this->setVariable($key, $val);
                }
            }
        }
        
        return $count;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillWindowTitle()

ilTemplate::fillWindowTitle

(

)

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

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

Referenced by get(), and show().

    {
        global $DIC;

        $ilSetting = $DIC->settings();
        
        if ($this->header_page_title != "") {
            $a_title = ilUtil::stripScriptHTML($this->header_page_title);
            $this->setVariable("PAGETITLE", "- " . $a_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() [1/2]

ilTemplate::get	(		$part = "DEFAULT",
			$add_error_mess = false,
			$handle_referer = false,
			$add_ilias_footer = false,
			$add_standard_elements = false,
			$a_main_menu = true,
			$a_tabs = true
	)

??? public

Parameters

string

Returns

string

Definition at line 237 of file class.ilTemplate.php.

References $DIC, $html, ilObjLanguageAccess\_saveUsages(), addILIASFooter(), array, blockExists(), fillAdminPanel(), fillBodyClass(), fillContentLanguage(), fillContentStyle(), fillCssFiles(), fillHeader(), fillInlineCss(), fillJavaScriptFiles(), fillLeftContent(), fillLeftNav(), fillLightbox(), fillMainContent(), fillMainMenu(), fillMessage(), fillNewContentStyle(), fillOnLoadCode(), fillPermanentLink(), fillRightContent(), fillScreenReaderFocus(), fillSideIcons(), fillStopFloating(), fillTabs(), fillToolbar(), fillWindowTitle(), getMainMenu(), ilPluginAdmin\getPluginObject(), getTabsHTML(), handleReferer(), IL_COMP_SERVICE, initHelp(), ilUIHookPluginGUI\KEEP, HTML_Template_IT\parseCurrentBlock(), setCenterColumnClass(), and setCurrentBlock().

Referenced by ilPDSelectedItemsBlockGUI\getViewBlockHtml().

      {
        global $DIC;

        if ($add_error_mess) {
            $this->fillMessage();
        }

        if ($add_ilias_footer) {
            $this->addILIASFooter();
        }

        // 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->fillContentStyle();
            $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->fillStopFloating();
            $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 = parent::get();
        } else {
            $html = parent::get($part);
        }

        // include the template output hook
        $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_get",
                array("tpl_id" => $this->tplIdentifier, "tpl_obj" => $this, "html" => $html)
            );

            if ($resp["mode"] != ilUIHookPluginGUI::KEEP) {
                $html = $gui_class->modifyHTML($html, $resp);
            }
        }

        // fix #9992: save language usages as late as possible
        if ($this->translation_linked) {
            ilObjLanguageAccess::_saveUsages();
        }

        return $html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

get() [2/2]

ilTemplate::get

(

$part = "DEFAULT"

)

Definition at line 445 of file class.ilTemplate.php.

    {
        if ($part == "DEFAULT") {
            return parent::get();
        } else {
            return parent::get($part);
        }
    }

getAddFooter()

ilTemplate::getAddFooter

(

)

Definition at line 215 of file class.ilTemplate.php.

References $addFooter.

Referenced by addILIASFooter().

    {
        return $this->addFooter;
    }

Here is the caller graph for this function:

getAsynch()

ilTemplate::getAsynch

(

)

Use this for final get before sending asynchronous output (ajax) per echo to output.

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

References getContentType(), and header.

    {
        header("Content-type: " . $this->getContentType() . "; charset=UTF-8");
        return $this->get();
    }

Here is the call graph for this function:

getContentType()

ilTemplate::getContentType

(

)

Get the content type for the template output.

Returns

string Content type public

Definition at line 443 of file class.ilTemplate.php.

References $contenttype.

Referenced by getAsynch(), and show().

    {
        return $this->contenttype;
    }

Here is the caller graph for this function:

getHeaderActionMenu()

ilTemplate::getHeaderActionMenu

(

)

Get header action menu.

Returns

int ref id

Definition at line 1799 of file class.ilTemplate.php.

References $header_action.

Referenced by fillHeader().

    {
        return $this->header_action;
    }

Here is the caller graph for this function:

getLoginTargetPar()

ilTemplate::getLoginTargetPar

(

)

Get target parameter for login.

Definition at line 1996 of file class.ilTemplate.php.

Referenced by getMainMenu().

    {
        return $this->login_target_par;
    }

Here is the caller graph for this function:

getMainMenu()

ilTemplate::getMainMenu

(

)

Definition at line 829 of file class.ilTemplate.php.

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

Referenced by get(), and show().

    {
        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:

getMessageHTML() [1/2]

ilTemplate::getMessageHTML	(		$a_txt,
			$a_type = "info"
	)

Get HTML for a system message.

Definition at line 237 of file class.ilTemplate.php.

References $a_type, and $lng.

    {
        global $lng;
        
        $mtpl = new ilTemplate("tpl.message.html", true, true, "Services/Utilities");
        $mtpl->setCurrentBlock($a_type . "_message");
        $mtpl->setVariable("TEXT", $a_txt);
        $mtpl->setVariable("MESSAGE_HEADING", $lng->txt($a_type . "_message"));
        $mtpl->parseCurrentBlock();
        
        return $mtpl->get();
    }

getMessageHTML() [2/2]

ilTemplate::getMessageHTML	(		$a_txt,
			$a_type = "info"
	)

Get HTML for a system message.

Definition at line 423 of file class.ilTemplate.php.

References $a_type, $DIC, and $lng.

Referenced by fillMessage(), and show().

    {
        global $DIC;

        $lng = $DIC->language();
        $mtpl = new ilTemplate("tpl.message.html", true, true, "Services/Utilities");
        $mtpl->setCurrentBlock($a_type . "_message");
        $mtpl->setVariable("TEXT", $a_txt);
        $mtpl->setVariable("MESSAGE_HEADING", $lng->txt($a_type . "_message"));
        $mtpl->parseCurrentBlock();
        
        return $mtpl->get();
    }

Here is the caller graph for this function:

getMessageTextForType()

ilTemplate::getMessageTextForType (   $m )

private

Parameters

$m

Returns

mixed|string

Definition at line 2515 of file class.ilTemplate.php.

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

ilTemplate::getOnLoadCodeForAsynch

(

)

Get js onload code for ajax calls.

Returns

string

Definition at line 2384 of file class.ilTemplate.php.

References $code, $i, and $js.

    {
        $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";
        }
    }

getStandardTemplate()

ilTemplate::getStandardTemplate

(

)

Definition at line 1560 of file class.ilTemplate.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();

        // always load Basic js
        //              $this->addJavaScript("./Services/JavaScript/js/Basic.js",
        //                      true, 1);

        $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:

getTabsHTML()

ilTemplate::getTabsHTML

(

)

Get tabs HTML.

Parameters

Definition at line 665 of file class.ilTemplate.php.

References $DIC, and blockExists().

Referenced by get(), and show().

    {
        global $DIC;

        $ilTabs = $DIC["ilTabs"];
        
        if ($this->blockExists("tabs_outer_start")) {
            $this->sthtml = $ilTabs->getSubTabHTML();
            $this->thtml = $ilTabs->getHTML((trim($sthtml) == ""));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplateIdentifier()

ilTemplate::getTemplateIdentifier	(		$a_tplname,
			$a_in_module = false
	)

get a unique template identifier

The identifier is common for default or customized skins but distincts templates of different services with the same name.

This is used by the UI plugin hook for template input/output

Parameters

string	$a_tplname	template name
string	$in_module	Component, e.g. "Modules/Forum" boolean $in_module or true, if component should be determined by ilCtrl

Returns

string template identifier, e.g. "tpl.confirm.html"

Definition at line 1511 of file class.ilTemplate.php.

References $_GET, $DIC, $ilCtrl, and ILIAS_MODULE.

Referenced by __construct(), and addBlockFile().

    {
        global $DIC;

        $ilCtrl = null;
        if (isset($DIC["ilCtrl"])) {
            $ilCtrl = $DIC->ctrl();
        }


        // if baseClass functionality is used (ilias.php):
        // get template directory from ilCtrl
        if (!empty($_GET["baseClass"]) && $a_in_module === true) {
            $a_in_module = $ilCtrl->getModuleDir();
        }

        if (strpos($a_tplname, "/") === false) {
            if ($a_in_module) {
                if ($a_in_module === true) {
                    $module_path = ILIAS_MODULE . "/";
                } else {
                    $module_path = $a_in_module . "/";
                }
            } else {
                $module_path = "";
            }
            
            return $module_path . basename($a_tplname);
        } else {
            return $a_tplname;
        }
    }

Here is the caller graph for this function:

getTemplatePath() [1/2]

ilTemplate::getTemplatePath	(		$a_tplname,
			$a_in_module = false,
			$a_plugin = false
	)

builds a full template path with template and module name

Parameters

string	$a_tplname	template name
boolean	$in_module	should be set to true, if template file is in module subdirectory

Returns

string full template path

Definition at line 89 of file class.ilTemplate.php.

References $_GET, $ilCtrl, and ILIAS_MODULE.

    {
        global $ilias, $ilCtrl;
        
        // if baseClass functionality is used (ilias.php):
        // get template directory from ilCtrl
        if (!empty($_GET["baseClass"]) && $a_in_module === true) {
            $a_in_module = $ilCtrl->getModuleDir();
        }

        if (strpos($a_tplname, "/") === false) {
            $module_path = "";
            
            //$fname = $ilias->tplPath;
            if ($a_in_module) {
                if ($a_in_module === true) {
                    $module_path = ILIAS_MODULE . "/";
                } else {
                    $module_path = $a_in_module . "/";
                }
            }

            if ($fname == "" || !file_exists($fname)) {
                if ($a_in_module == "setup") {
                    $fname = "./" . $module_path . "templates/" . basename($a_tplname);
                } else {
                    $fname = "./" . $module_path . "templates/default/" . basename($a_tplname);
                }
            }
        } else {
            $fname = $a_tplname;
        }
        
        return $fname;
    }

getTemplatePath() [2/2]

ilTemplate::getTemplatePath	(		$a_tplname,
			$a_in_module = false,
			$a_plugin = false
	)

builds a full template path with template and module name

Parameters

string	$a_tplname	template name
boolean	$in_module	should be set to true, if template file is in module subdirectory

Returns

string full template path

Definition at line 1444 of file class.ilTemplate.php.

References $_GET, $DIC, $ilCtrl, and ILIAS_MODULE.

Referenced by __construct(), and addBlockFile().

    {
        global $DIC;

        $ilCtrl = null;
        if (isset($DIC["ilCtrl"])) {
            $ilCtrl = $DIC->ctrl();
        }
        
        $fname = "";
        
        // if baseClass functionality is used (ilias.php):
        // get template directory from ilCtrl
        if (!empty($_GET["baseClass"]) && $a_in_module === true) {
            $a_in_module = $ilCtrl->getModuleDir();
        }

        if (strpos($a_tplname, "/") === false) {
            $module_path = "";
            
            if ($a_in_module) {
                if ($a_in_module === true) {
                    $module_path = ILIAS_MODULE . "/";
                } else {
                    $module_path = $a_in_module . "/";
                }
            }

            // use ilStyleDefinition instead of account to get the current skin
            include_once "Services/Style/System/classes/class.ilStyleDefinition.php";
            if (ilStyleDefinition::getCurrentSkin() != "default") {
                $fname = "./Customizing/global/skin/" .
                    ilStyleDefinition::getCurrentSkin() . "/" . $module_path . basename($a_tplname);
            }

            if ($fname == "" || !file_exists($fname)) {
                $fname = "./" . $module_path . "templates/default/" . basename($a_tplname);
            }
        } elseif (strpos($a_tplname, "src/UI")===0) {
            if (class_exists("ilStyleDefinition") // for testing
            && ilStyleDefinition::getCurrentSkin() != "default") {
                $fname = "./Customizing/global/skin/" . ilStyleDefinition::getCurrentSkin() . "/" . str_replace("src/UI/templates/default", "UI", $a_tplname);
            }
            if ($fname == "" || !file_exists($fname)) {
                $fname = $a_tplname;
            }
        } else {
            $fname = $a_tplname;
        }
        
        return $fname;
    }

Here is the caller graph for this function:

getTitleColor()

ilTemplate::getTitleColor

(

)

Get title color.

Returns

string color

Definition at line 1617 of file class.ilTemplate.php.

Referenced by fillHeader().

    {
        return $this->title_color;
    }

Here is the caller graph for this function:

handleReferer()

ilTemplate::handleReferer

(

)

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

Definition at line 1046 of file class.ilTemplate.php.

References $_GET, $_POST, $_SERVER, $_SESSION, $key, $path, and GuzzleHttp\Psr7\$protocol.

Referenced by get(), and show().

    {
        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"))) {
            $_SESSION["post_vars"] = $_POST;

            // 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:

hasMessage()

ilTemplate::hasMessage

(

$a_type

)

Definition at line 375 of file class.ilTemplate.php.

References $a_type.

    {
        return (isset($this->message[$a_type]) && strlen($this->message[$a_type]));
    }

includeNavigation()

ilTemplate::includeNavigation

(

)

check if there is a NAVIGATION-topic public

Returns

boolean

Definition at line 1302 of file class.ilTemplate.php.

References checkTopic().

    {
        return $this->checkTopic("__global__", "NAVIGATION");
    }

Here is the call graph for this function:

includeTree()

ilTemplate::includeTree

(

)

check if there is a TREE-topic public

Returns

boolean

Definition at line 1312 of file class.ilTemplate.php.

References checkTopic().

    {
        return $this->checkTopic("__global__", "TREE");
    }

Here is the call graph for this function:

init()

ilTemplate::init

(

)

Definition at line 160 of file class.ilTemplate.php.

References HTML_Template_IT\$blockdata, HTML_Template_IT\$blockinner, HTML_Template_IT\$blocklist, HTML_Template_IT\$blockvariables, HTML_Template_IT\$err, HTML_Template_IT\$flagBlocktrouble, HTML_Template_IT\buildBlockvariablelist(), HTML_Template_ITX\buildFunctionlist(), HTML_Template_IT\findBlocks(), and HTML_Template_IT\free().

    {
        $this->free();
        $this->buildFunctionlist();
        
        $cache_hit = false;
        if ($this->il_use_cache) {
            // cache hit
            if (isset(self::$il_cache[$this->il_cur_key]) && is_array(self::$il_cache[$this->il_cur_key])) {
                $cache_hit = true;
                //echo "cache hit";
                $this->err = self::$il_cache[$this->il_cur_key]["err"];
                $this->flagBlocktrouble = self::$il_cache[$this->il_cur_key]["flagBlocktrouble"];
                $this->blocklist = self::$il_cache[$this->il_cur_key]["blocklist"];
                $this->blockdata = self::$il_cache[$this->il_cur_key]["blockdata"];
                $this->blockinner = self::$il_cache[$this->il_cur_key]["blockinner"];
                $this->blockparents = self::$il_cache[$this->il_cur_key]["blockparents"];
                $this->blockvariables = self::$il_cache[$this->il_cur_key]["blockvariables"];
            }
        }
        
        if (!$cache_hit) {
            $this->findBlocks($this->template);
            $this->template = '';
            $this->buildBlockvariablelist();
            if ($this->il_use_cache) {
                self::$il_cache[$this->il_cur_key]["err"] = $this->err;
                self::$il_cache[$this->il_cur_key]["flagBlocktrouble"] = $this->flagBlocktrouble;
                self::$il_cache[$this->il_cur_key]["blocklist"] = $this->blocklist;
                self::$il_cache[$this->il_cur_key]["blockdata"] = $this->blockdata;
                self::$il_cache[$this->il_cur_key]["blockinner"] = $this->blockinner;
                self::$il_cache[$this->il_cur_key]["blockparents"] = $this->blockparents;
                self::$il_cache[$this->il_cur_key]["blockvariables"] = $this->blockvariables;
            }
        }
        
        // we don't need it any more
        $this->template = '';
    } // end func init

Here is the call graph for this function:

initHelp()

ilTemplate::initHelp

(

)

Init help.

Definition at line 855 of file class.ilTemplate.php.

References ilHelpGUI\initHelp().

Referenced by get(), and show().

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

Here is the call graph for this function:

Here is the caller graph for this function:

loadTemplatefile()

ilTemplate::loadTemplatefile	(		$filename,
			$removeUnknownVariables = true,
			$removeEmptyBlocks = true
	)

Reads a template file from the disk.

overwrites IT:loadTemplateFile to include the template input hook

Parameters

string	name of the template file
bool	how to handle unknown variables.
bool	how to handle empty blocks. public

Returns

boolean false on failure, otherwise true

See also

$template, setTemplate(), $removeUnknownVariables, $removeEmptyBlocks

Definition at line 1389 of file class.ilTemplate.php.

References $DIC, $filename, HTML_Template_IT\$removeEmptyBlocks, HTML_Template_IT\$removeUnknownVariables, HTML_Template_IT\$template, array, HTML_Template_IT\getFile(), ilPluginAdmin\getPluginObject(), IL_COMP_SERVICE, ilUIHookPluginGUI\KEEP, and HTML_Template_IT\setTemplate().

Referenced by __construct().

      {
        global $DIC;

        // copied from IT:loadTemplateFile
        $template = '';
        if (!$this->flagCacheTemplatefile ||
            $this->lastTemplatefile != $filename
        ) {
            $template = $this->getFile($filename);
        }
        $this->lastTemplatefile = $filename;
        // copied.
        
        // new code to include the template input hook:
        $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_load",
                array("tpl_id" => $this->tplIdentifier, "tpl_obj" => $this, "html" => $template)
            );

            if ($resp["mode"] != ilUIHookPluginGUI::KEEP) {
                $template = $gui_class->modifyHTML($template, $resp);
            }
        }
        // new.
        
        // copied from IT:loadTemplateFile
        return $template != '' ?
                $this->setTemplate(
                    $template,
                    $removeUnknownVariables,
                    $removeEmptyBlocks
                ) : false;
        // copied.
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseCurrentBlock() [1/2]

ilTemplate::parseCurrentBlock

(

$part = "DEFAULT"

)

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

Parameters

string

Returns

string

Definition at line 290 of file class.ilTemplate.php.

References $activeBlock.

    {
        // Hier erst noch ein replace aufrufen
        if ($part != "DEFAULT") {
            $tmp = $this->activeBlock;
            $this->activeBlock = $part;
        }

        if ($part != "DEFAULT") {
            $this->activeBlock = $tmp;
        }

        //$this->fillVars();

        $this->activeBlock = "__global__";

        if ($part == "DEFAULT") {
            return parent::parseCurrentBlock();
        } else {
            return parent::parseCurrentBlock($part);
        }
    }

parseCurrentBlock() [2/2]

ilTemplate::parseCurrentBlock

(

$part = "DEFAULT"

)

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

Parameters

string

Returns

string

Definition at line 1183 of file class.ilTemplate.php.

References $activeBlock, and fillVars().

Referenced by ilBTPopOverGUI\addButton(), ilContainerRenderer\addHeaderRow(), ilPDSelectedItemsBlockGUI\addSectionHeader(), ilContainerRenderer\addSeparatorRow(), ilContainerRenderer\addStandardRow(), ilPDSelectedItemsBlockGUI\getViewBlockHtml(), ilOrgUnitAuthorityInputGUI\insert(), ilTermsOfServiceSignedDocumentFormElementGUI\insert(), ilChatroomAuthInputGUI\insert(), ilEMailInputGUI\insert(), ilCaptchaInputGUI\insert(), ilClozeGapInputBuilderGUI\insert(), ilSCORMExplorer\insertObject(), ilTestQuestionNavigationGUI\parseButtonsBlock(), ilTestQuestionNavigationGUI\parseNavigation(), ilAssQuestionPreviewGUI\populateGenericQuestionFeedback(), ilAssQuestionPreviewGUI\populateSolutionOutput(), ilAssQuestionPreviewGUI\populateSpecificQuestionFeedback(), ilTestQuestionNavigationGUI\renderActionsIcon(), ilTestQuestionNavigationGUI\renderButtonInstance(), ilAssLacLegendGUI\renderCommonLegendPart(), ilContainerRenderer\renderDetails(), ilAssLacLegendGUI\renderExample(), ilTestQuestionNavigationGUI\renderIcon(), ilSurveyPageGUI\renderPageNode(), ilForumExportGUI\renderPostHtml(), ilAssLacLegendGUI\renderQuestSpecificLegendPart(), and ilContainerRenderer\renderSelectAllBlock().

    {
        // Hier erst noch ein replace aufrufen
        if ($part != "DEFAULT") {
            $tmp = $this->activeBlock;
            $this->activeBlock = $part;
        }

        if ($part != "DEFAULT") {
            $this->activeBlock = $tmp;
        }

        $this->fillVars();

        $this->activeBlock = "__global__";

        if ($part == "DEFAULT") {
            return parent::parseCurrentBlock();
        } else {
            return parent::parseCurrentBlock($part);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareForFormular()

ilTemplate::prepareForFormular

(

$vars

)

Wird angewendet, wenn die Daten in ein Formular replaced werden sollen, Dann wird erst noch ein htmlspecialchars drumherum gemacht.

public

Parameters

string

Definition at line 1247 of file class.ilTemplate.php.

References $i, and $vars.

    {
        if (!is_array($vars)) {
            return;
        }

        reset($vars);

        while (list($i) = each($vars)) {
            $vars[$i] = stripslashes($vars[$i]);
            $vars[$i] = htmlspecialchars($vars[$i]);
        }

        return($vars);
    }

replace()

ilTemplate::replace

(

)

??? public

Definition at line 1267 of file class.ilTemplate.php.

References $key, and HTML_Template_IT\setVariable().

Referenced by replaceDefault(), and replaceFromDatabase().

    {
        reset($this->vars);

        while (list($key, $val) = each($this->vars)) {
            $this->setVariable($key, $val);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

replaceDefault()

ilTemplate::replaceDefault

(

)

??? public

Definition at line 1280 of file class.ilTemplate.php.

References replace().

    {
        $this->replace($this->vars);
    }

Here is the call graph for this function:

replaceFromDatabase()

ilTemplate::replaceFromDatabase	(	&	$DB,
			$block,
			$conv,
			$select = "default"
	)

??? TODO: Adjust var names to ilias.

This method wasn't used so far and isn't translated yet public

Parameters

string
string
string
string

Definition at line 1216 of file class.ilTemplate.php.

References $key, $res, $result, array, HTML_Template_IT\parseCurrentBlock(), replace(), and setCurrentBlock().

    {
        $res = $DB->selectDbAll();

        while ($DB->getDbNextElement($res)) {
            $this->setCurrentBlock($block);
            $result = array();
            reset($conv);

            while (list($key, $val) = each($conv)) {
                $result[$val]=$DB->element->data[$key];
            }

            if (($select != "default")
                && ($DB->element->data[$select["id"]]==$select["value"]
                || (strtolower($select["text"]) == "checked"
                && strpos(",," . $select["value"] . ",,", "," . $DB->element->data[$select["id"]] . ",")!=false))) {
                $result[$select["field"]] = $select["text"];
            }

            $this->replace($result);
            $this->parseCurrentBlock($block);
        }
    }

Here is the call graph for this function:

resetCss()

ilTemplate::resetCss

(

)

Reset css files.

Parameters

Definition at line 2167 of file class.ilTemplate.php.

References array.

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

resetHeaderBlock()

ilTemplate::resetHeaderBlock

(

$a_reset_header_action = true

)

Set variable.

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

Definition at line 2487 of file class.ilTemplate.php.

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

ilTemplate::resetJavascript

(

)

Reset javascript files.

Definition at line 2154 of file class.ilTemplate.php.

References array.

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

setAddFooter()

ilTemplate::setAddFooter

(

$value

)

Definition at line 205 of file class.ilTemplate.php.

    {
        $this->addFooter = $value;
    }

setAlertProperties()

ilTemplate::setAlertProperties

(

array

$a_props

)

Set alert properties.

Parameters

array

$a_props

Returns

void

Definition at line 1627 of file class.ilTemplate.php.

Referenced by clearHeader(), and resetHeaderBlock().

    {
        $this->title_alerts = $a_props;
    }

Here is the caller graph for this function:

setBackgroundColor()

ilTemplate::setBackgroundColor

(

$a_bg_color

)

Definition at line 2401 of file class.ilTemplate.php.

References HTML_Template_IT\setVariable().

    {
        // :TODO: currently inactive, JF should discuss this
        return;
        
        if ($a_bg_color != "") {
            $this->setVariable("FRAME_BG_COLOR", " style=\"background-color: #" . $a_bg_color . "\"");
        }
    }

Here is the call graph for this function:

setBanner()

ilTemplate::setBanner	(		$a_img,
			$a_width = 1370,
			$a_height = 100,
			$a_export = false
	)

Set banner.

Parameters

string	$a_img	banner full path (background image)
int	$a_width	banner width
int	$a_height	banner height
bool	$a_export

Definition at line 2419 of file class.ilTemplate.php.

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

    {
        if ($a_img) {
            if (!$a_export) {
                $a_img = ILIAS_HTTP_PATH . "/" . $a_img;
            }
            
            $this->setCurrentBlock("banner_bl");
            $this->setVariable("BANNER_WIDTH", $a_width); // currently not needed
            $this->setVariable("BANNER_HEIGHT", $a_height);
            $this->setVariable("BANNER_URL", $a_img);
            $this->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

setBodyClass()

ilTemplate::setBodyClass

(

$a_class = ""

)

Definition at line 1738 of file class.ilTemplate.php.

Referenced by __construct().

    {
        $this->body_class = $a_class;
    }

Here is the caller graph for this function:

setCenterColumnClass()

ilTemplate::setCenterColumnClass ( )

private

Definition at line 1844 of file class.ilTemplate.php.

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

Referenced by get(), and show().

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

ilTemplate::setContent

(

$a_html

)

sets content for standard template

Definition at line 1807 of file class.ilTemplate.php.

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

setContentStyleSheet()

ilTemplate::setContentStyleSheet

(

$a_style

)

Set content style (used for page content editor)

Definition at line 796 of file class.ilTemplate.php.

    {
        $this->content_style_sheet = $a_style;
    }

setContentType()

ilTemplate::setContentType

(

$a_content_type = "text/html"

)

Set the content type for the template output.

Set the content type for the template output Usually this is text/html. For MathML output the content type should be set to text/xml

Parameters

string

$a_content_type

Content type public

Definition at line 458 of file class.ilTemplate.php.

    {
        $this->contenttype = $a_content_type;
    }

setCurrentBlock() [1/2]

ilTemplate::setCurrentBlock

(

$part = "DEFAULT"

)

Überladene Funktion, die sich hier lokal noch den aktuellen Block merkt.

public

Parameters

string

Returns

???

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

    {
        $this->activeBlock = $part;

        if ($part == "DEFAULT") {
            return parent::setCurrentBlock();
        } else {
            return parent::setCurrentBlock($part);
        }
    }

setCurrentBlock() [2/2]

ilTemplate::setCurrentBlock

(

$part = "DEFAULT"

)

Überladene Funktion, die sich hier lokal noch den aktuellen Block merkt.

public

Parameters

string

Returns

???

Definition at line 1149 of file class.ilTemplate.php.

Referenced by ilBTPopOverGUI\addButton(), ilContainerRenderer\addHeaderRow(), ilPDSelectedItemsBlockGUI\addSectionHeader(), ilContainerRenderer\addSeparatorRow(), ilContainerRenderer\addStandardRow(), fillAdminPanel(), fillBodyClass(), fillContentStyle(), fillCssFiles(), fillHeader(), fillInlineCss(), fillJavascriptFile(), fillJavaScriptFiles(), fillLeftContent(), fillLeftNav(), fillOnLoadCode(), fillPageFormAction(), fillRightContent(), fillSideIcons(), fillToolbar(), get(), ilPDSelectedItemsBlockGUI\getViewBlockHtml(), ilOrgUnitAuthorityInputGUI\insert(), ilTermsOfServiceSignedDocumentFormElementGUI\insert(), ilChatroomAuthInputGUI\insert(), ilEMailInputGUI\insert(), ilCaptchaInputGUI\insert(), ilClozeGapInputBuilderGUI\insert(), ilSCORMExplorer\insertObject(), ilTestQuestionNavigationGUI\parseButtonsBlock(), ilTestQuestionNavigationGUI\parseNavigation(), ilAssQuestionPreviewGUI\populateGenericQuestionFeedback(), ilAssQuestionPreviewGUI\populateSolutionOutput(), ilAssQuestionPreviewGUI\populateSpecificQuestionFeedback(), ilTestQuestionNavigationGUI\renderActionsIcon(), ilTestQuestionNavigationGUI\renderButtonInstance(), ilAssLacLegendGUI\renderCommonLegendPart(), ilContainerRenderer\renderDetails(), ilAssLacLegendGUI\renderExample(), ilTestQuestionNavigationGUI\renderIcon(), ilSurveyPageGUI\renderPageNode(), ilForumExportGUI\renderPostHtml(), ilAssLacLegendGUI\renderQuestSpecificLegendPart(), ilContainerRenderer\renderSelectAllBlock(), replaceFromDatabase(), setBanner(), setCenterColumnClass(), show(), and touchBlock().

    {
        $this->activeBlock = $part;

        if ($part == "DEFAULT") {
            return parent::setCurrentBlock();
        } else {
            return parent::setCurrentBlock($part);
        }
    }

Here is the caller graph for this function:

setDescription()

ilTemplate::setDescription

(

$a_descr

)

sets title in standard template

Definition at line 1760 of file class.ilTemplate.php.

Referenced by clearHeader(), and resetHeaderBlock().

    {
        $this->title_desc = $a_descr;
        //              $this->setVariable("H_DESCRIPTION", $a_descr);
    }

Here is the caller graph for this function:

setEditPageButton()

ilTemplate::setEditPageButton	(		$a_link,
			$a_txt,
			$a_frame
	)

Show admin view button.

Definition at line 2238 of file class.ilTemplate.php.

References array.

    {
        $this->edit_page_button =
            array("link" => $a_link, "txt" => $a_txt, "frame" => $a_frame);
    }

setHeaderActionMenu()

ilTemplate::setHeaderActionMenu

(

$a_header

)

Set header action menu.

Parameters

string

$a_gui

$a_header

Definition at line 1789 of file class.ilTemplate.php.

Referenced by resetHeaderBlock().

    {
        $this->header_action = $a_header;
    }

Here is the caller graph for this function:

setHeaderPageTitle()

ilTemplate::setHeaderPageTitle

(

$a_title

)

Definition at line 1544 of file class.ilTemplate.php.

References ilUtil\stripScriptHTML().

    {
        $a_title = ilUtil::stripScriptHTML($a_title);
        $this->header_page_title = $a_title;
    }

Here is the call graph for this function:

setLeftContent()

ilTemplate::setLeftContent

(

$a_html

)

sets content of left column

Definition at line 1873 of file class.ilTemplate.php.

    {
        $this->left_content = $a_html;
    }

setLeftNavContent()

ilTemplate::setLeftNavContent

(

$a_content

)

Sets content of left navigation column.

Definition at line 1897 of file class.ilTemplate.php.

References $a_content.

    {
        $this->left_nav_content = $a_content;
    }

setLocator()

ilTemplate::setLocator

(

)

Insert locator.

Definition at line 1918 of file class.ilTemplate.php.

References $DIC, $html, array, ilMainMenuGUI\MODE_TOPBAR_ONLY, ilMainMenuGUI\MODE_TOPBAR_REDUCED, and HTML_Template_IT\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()

ilTemplate::setLoginTargetPar

(

$a_val

)

Set target parameter for login (public sector).

This is used by the main menu

Definition at line 1988 of file class.ilTemplate.php.

    {
        $this->login_target_par = $a_val;
    }

setMessage() [1/2]

ilTemplate::setMessage	(		$a_type,
			$a_txt,
			$a_keep = false
	)

Set message.

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

Definition at line 316 of file class.ilTemplate.php.

References $a_type, array, and ilSession\set().

    {
        if (!in_array($a_type, array("info", "success", "failure", "question")) || $a_txt == "") {
            return;
        }
        if ($a_type == "question") {
            $a_type = "mess_question";
        }
        if (!$a_keep) {
            $this->message[$a_type] = $a_txt;
        } else {
            ilSession::set($a_type, $a_txt);
        }
    }

Here is the call graph for this function:

setMessage() [2/2]

ilTemplate::setMessage	(		$a_type,
			$a_txt,
			$a_keep = false
	)

Set message.

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

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

References $_SESSION, and $a_type.

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

setMountWebfolderIcon()

ilTemplate::setMountWebfolderIcon

(

$a_ref_id

)

shows icon for mounting a webfolder

Definition at line 2110 of file class.ilTemplate.php.

    {
        $this->mount_webfolder = $a_ref_id;
    }

setNewContentStyleSheetLocation()

ilTemplate::setNewContentStyleSheetLocation

(

$a_stylesheet

)

Definition at line 1555 of file class.ilTemplate.php.

References HTML_Template_IT\setVariable().

    {
        $this->setVariable("LOCATION_NEWCONTENT_STYLESHEET", $a_stylesheet);
    }

Here is the call graph for this function:

setPageActions()

ilTemplate::setPageActions

(

$a_page_actions_html

)

Show admin view button.

Definition at line 2230 of file class.ilTemplate.php.

    {
        $this->page_actions = $a_page_actions_html;
    }

setPageFormAction()

ilTemplate::setPageFormAction

(

$a_action

)

Definition at line 1752 of file class.ilTemplate.php.

    {
        $this->page_form_action = $a_action;
    }

setPermanentLink()

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

Definition at line 2330 of file class.ilTemplate.php.

References $a_type, and array.

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

setRightContent()

ilTemplate::setRightContent

(

$a_html

)

sets content of right column

Definition at line 1827 of file class.ilTemplate.php.

    {
        $this->right_content = $a_html;
    }

setStyleSheetLocation()

ilTemplate::setStyleSheetLocation

(

$a_stylesheet

)

Definition at line 1550 of file class.ilTemplate.php.

References HTML_Template_IT\setVariable().

    {
        $this->setVariable("LOCATION_STYLESHEET", $a_stylesheet);
    }

Here is the call graph for this function:

setSubTabs()

ilTemplate::setSubTabs

(

$a_tabs_html

)

sets subtabs in standard template

Definition at line 1970 of file class.ilTemplate.php.

References HTML_Template_IT\setVariable().

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

Here is the call graph for this function:

setTabs()

ilTemplate::setTabs

(

$a_tabs_html

)

sets tabs in standard template

Definition at line 1956 of file class.ilTemplate.php.

References blockExists(), HTML_Template_IT\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()

ilTemplate::setTitle

(

$a_title

)

sets title in standard template

Definition at line 1588 of file class.ilTemplate.php.

References ilUtil\stripScriptHTML().

Referenced by clearHeader(), and resetHeaderBlock().

    {
        $this->title = ilUtil::stripScriptHTML($a_title);
        $this->header_page_title = $a_title;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTitleColor()

ilTemplate::setTitleColor

(

$a_val

)

Set title color.

Parameters

string

$a_val

color

Definition at line 1607 of file class.ilTemplate.php.

    {
        $this->title_color = $a_val;
    }

setTitleIcon()

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

set title icon

Definition at line 1732 of file class.ilTemplate.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:

setTitleUrl()

ilTemplate::setTitleUrl

(

$a_url

)

sets title url in standard template

Definition at line 1597 of file class.ilTemplate.php.

    {
        $this->title_url = $a_url;
    }

setTreeFlatIcon()

ilTemplate::setTreeFlatIcon	(		$a_link,
			$a_mode
	)

set tree/flat icon

Parameters

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

Definition at line 2121 of file class.ilTemplate.php.

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

setUpperIcon()

ilTemplate::setUpperIcon	(		$a_link,
			$a_frame = ""
	)

sets icon to upper level

Definition at line 1978 of file class.ilTemplate.php.

    {
        $this->upper_icon = $a_link;
        $this->upper_icon_frame = $a_frame;
    }

show() [1/2]

ilTemplate::show

(

$part = "DEFAULT"

)

public

Parameters

string

Definition at line 144 of file class.ilTemplate.php.

References $_GET, $_POST, $_SERVER, $key, $m, $out, $path, GuzzleHttp\Psr7\$protocol, $txt, array, blockExists(), ilSession\clear(), fillCssFiles(), fillJavaScriptFiles(), ilSession\get(), getMessageHTML(), header, ilSession\set(), and HTML_Template_IT\setVariable().

    {
        header('Content-type: text/html; charset=UTF-8');

        $this->fillJavaScriptFiles();
        $this->fillCssFiles();
        
        // ERROR HANDLER SETS $_GET["message"] IN CASE OF $error_obj->MESSAGE
        $ms = array("info", "success", "failure", "question");
        $out = "";
        
        foreach ($ms as $m) {
            if ($m == "question") {
                $m = "mess_question";
            }

            $txt = (ilSession::get($m) != "")
                ? ilSession::get($m)
                : $this->message[$m];
                
            if ($m == "mess_question") {
                $m = "question";
            }

            if ($txt != "") {
                $out.= $this->getMessageHTML($txt, $m);
            }
        
            if ($m == "question") {
                $m = "mess_question";
            }

            if (ilSession::get($m)) {
                ilSession::clear($m);
            }
        }
        
        if ($this->blockExists("MESSAGE") && $out != "") {
            $this->setVariable("MESSAGE", $out);
        }

        if ($part == "DEFAULT") {
            parent::show();
        } else {
            parent::show($part);
        }

        if (((substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "error.php")
            && (substr(strrchr($_SERVER["PHP_SELF"], "/"), 1) != "adm_menu.php"))) {
            ilSession::set("post_vars", $_POST);

            // 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 (preg_match("/cmd=gateway/", $url_parts["query"])) {
                foreach ($_POST as $key => $val) {
                    if (is_array($val)) {
                        $val = key($val);
                    }

                    $str .= "&" . $key . "=" . $val;
                }

                ilSession::set(
                    "referer",
                    preg_replace("/cmd=gateway/", substr($str, 1), $_SERVER["REQUEST_URI"])
                );
                ilSession::set(
                    "referer_ref_id",
                    (int) $_GET['ref_id']
                );
            } else {
                ilSession::set("referer", $_SERVER["REQUEST_URI"]);
                ilSession::set(
                    "referer_ref_id",
                    (int) $_GET['ref_id']
                );
            }

            ilSession::clear("error_post_vars");
        }
    }

Here is the call graph for this function:

show() [2/2]

ilTemplate::show	(		$part = "DEFAULT",
			$a_fill_tabs = true,
			$a_skip_main_menu = false
	)

Parameters

string	$part
bool	$a_fill_tabs	fill template variable {TABS} with content of ilTabs
bool	$a_skip_main_menu

Definition at line 469 of file class.ilTemplate.php.

References $DIC, $html, $http, GuzzleHttp\Psr7\$stream, $tpl, ilObjLanguageAccess\_saveUsages(), addILIASFooter(), array, blockExists(), exit, fillAdminPanel(), fillBodyClass(), fillContentLanguage(), fillContentStyle(), fillCssFiles(), fillHeader(), fillInlineCss(), fillJavaScriptFiles(), fillLeftContent(), fillLeftNav(), fillLightbox(), fillMainContent(), fillMainMenu(), fillMessage(), fillNewContentStyle(), fillOnLoadCode(), fillPermanentLink(), fillRightContent(), fillScreenReaderFocus(), fillSideIcons(), fillStopFloating(), fillTabs(), fillToolbar(), fillWindowTitle(), getContentType(), getMainMenu(), ilPluginAdmin\getPluginObject(), getTabsHTML(), handleReferer(), header, IL_COMP_SERVICE, ilYuiUtil\initDom(), initHelp(), ilUIHookPluginGUI\KEEP, ILIAS\Filesystem\Stream\Streams\ofString(), HTML_Template_IT\parseCurrentBlock(), setCenterColumnClass(), setCurrentBlock(), and variableExists().

    {
        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: " . $this->getContentType() . "; charset=UTF-8");

                $this->fillMessage();

                // display ILIAS footer
                if ($part !== false) {
                    $this->addILIASFooter();
                }

                // 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();
                    }

                    if ($this->blockExists("content") && $this->variableExists('MAINMENU')) {
                        $tpl = $DIC["tpl"];

                        include_once 'Services/Authentication/classes/class.ilSessionReminderGUI.php';
                        $session_reminder_gui = new ilSessionReminderGUI(ilSessionReminder::createInstanceWithCurrentUserSession());
                        $tpl->setVariable('SESSION_REMINDER', $session_reminder_gui->getHtml());
                    }

                    // these fill blocks in tpl.main.html
                    $this->fillCssFiles();
                    $this->fillInlineCss();
                    //$this->fillJavaScriptFiles();
                    $this->fillContentStyle();

                    // 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->fillStopFloating();
                    $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 = parent::get();
                } else {
                    $html = parent::get($part);
                }

                // include the template output hook
                $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);
                    }
                }

                // fix #9992: save language usages as late as possible
                if ($this->translation_linked) {
                    ilObjLanguageAccess::_saveUsages();
                }

                print $html;

                $this->handleReferer();
                break;
        }
    }

Here is the call graph for this function:

stopTitleFloating()

ilTemplate::stopTitleFloating

(

)

set stop floating (if no tabs are used)

Definition at line 1769 of file class.ilTemplate.php.

    {
        $this->stop_floating = true;
    }

touchBlock() [1/2]

ilTemplate::touchBlock

(

$block

)

overwrites ITX::touchBlock.

public

Parameters

string

Returns

???

Definition at line 273 of file class.ilTemplate.php.

References HTML_Template_IT\parseCurrentBlock(), and setCurrentBlock().

    {
        $this->setCurrentBlock($block);
        //$count = $this->fillVars();
        $this->parseCurrentBlock();

        if ($count == 0) {
            parent::touchBlock($block);
        }
    }

Here is the call graph for this function:

touchBlock() [2/2]

ilTemplate::touchBlock

(

$block

)

overwrites ITX::touchBlock.

public

Parameters

string

Returns

???

Definition at line 1166 of file class.ilTemplate.php.

References fillVars(), HTML_Template_IT\parseCurrentBlock(), and setCurrentBlock().

Referenced by ilContainerRenderer\addHeaderRow(), ilPDSelectedItemsBlockGUI\addSectionHeader(), ilContainerRenderer\addStandardRow(), fillHeader(), fillLeftNav(), fillPageFormAction(), fillScreenReaderFocus(), fillSideIcons(), fillStopFloating(), fillTabs(), ilTinyMCE\handleImgContextMenuItem(), ilSurveyPageGUI\renderPageNode(), and setTabs().

    {
        $this->setCurrentBlock($block);
        $count = $this->fillVars();
        $this->parseCurrentBlock();

        if ($count == 0) {
            parent::touchBlock($block);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

variableExists()

ilTemplate::variableExists (   $a_variablename )

private

Definition at line 1114 of file class.ilTemplate.php.

Referenced by fillMainMenu(), getMainMenu(), and show().

    {
        return (isset($this->blockvariables["content"][$a_variablename]) ? true : false);
    }

Here is the caller graph for this function:

Field Documentation

$activeBlock

ilTemplate::$activeBlock

Definition at line 51 of file class.ilTemplate.php.

Referenced by parseCurrentBlock().

$addFooter

ilTemplate::$addFooter

private

Definition at line 60 of file class.ilTemplate.php.

Referenced by getAddFooter().

$admin_panel_commands

ilTemplate::$admin_panel_commands = array()

Definition at line 58 of file class.ilTemplate.php.

$content_style_sheet

ilTemplate::$content_style_sheet = ""

protected

Definition at line 74 of file class.ilTemplate.php.

$contenttype

ilTemplate::$contenttype

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

Referenced by getContentType().

$css_files

ilTemplate::$css_files = array()

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

$header_action

ilTemplate::$header_action

protected

Definition at line 77 of file class.ilTemplate.php.

Referenced by getHeaderActionMenu().

$il_cache

ilTemplate::$il_cache = array()

staticprotected

Definition at line 62 of file class.ilTemplate.php.

$inline_css

ilTemplate::$inline_css = array()

Definition at line 57 of file class.ilTemplate.php.

$js_files

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

Definition at line 53 of file class.ilTemplate.php.

$js_files_batch

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

Definition at line 55 of file class.ilTemplate.php.

$js_files_vp

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

Definition at line 54 of file class.ilTemplate.php.

$lightbox

ilTemplate::$lightbox = array()

protected

Definition at line 78 of file class.ilTemplate.php.

$message

ilTemplate::$message = array()

protected

Definition at line 63 of file class.ilTemplate.php.

$message_types

ilTemplate::$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 27 of file class.ilTemplate.php.

$mount_webfolder

ilTemplate::$mount_webfolder = ""

protected

Definition at line 69 of file class.ilTemplate.php.

Referenced by fillSideIcons().

$page_actions

ilTemplate::$page_actions = array()

protected

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

$page_form_action

ilTemplate::$page_form_action = ""

protected

Definition at line 71 of file class.ilTemplate.php.

$permanent_link

ilTemplate::$permanent_link = false

protected

Definition at line 73 of file class.ilTemplate.php.

$standard_template_loaded

ilTemplate::$standard_template_loaded = false

protected

Definition at line 79 of file class.ilTemplate.php.

$stop_floating

ilTemplate::$stop_floating = ""

protected

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

$title_alerts

ilTemplate::$title_alerts = array()

protected

Definition at line 76 of file class.ilTemplate.php.

$title_desc

ilTemplate::$title_desc = ""

protected

Definition at line 65 of file class.ilTemplate.php.

$title_url

ilTemplate::$title_url = ""

protected

Definition at line 66 of file class.ilTemplate.php.

$tpl

ilTemplate::$tpl

protected

Definition at line 18 of file class.ilTemplate.php.

Referenced by fillMainMenu(), and show().

$translation_linked

ilTemplate::$translation_linked = false

protected

Definition at line 81 of file class.ilTemplate.php.

$tree_flat_link

ilTemplate::$tree_flat_link = ""

protected

Definition at line 68 of file class.ilTemplate.php.

$upper_icon

ilTemplate::$upper_icon = ""

protected

Definition at line 67 of file class.ilTemplate.php.

$vars

ilTemplate::$vars

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

Referenced by ilIndependentTemplate\__construct(), LTI\ilTemplate\__construct(), and prepareForFormular().

MESSAGE_TYPE_FAILURE

const ilTemplate::MESSAGE_TYPE_FAILURE = 'failure'

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

MESSAGE_TYPE_INFO

const ilTemplate::MESSAGE_TYPE_INFO = "info"

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

MESSAGE_TYPE_QUESTION

const ilTemplate::MESSAGE_TYPE_QUESTION = "question"

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

MESSAGE_TYPE_SUCCESS

const ilTemplate::MESSAGE_TYPE_SUCCESS = "success"

Definition at line 22 of file class.ilTemplate.php.

---

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

• Services/UICore/classes/class.ilTemplate.php