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

Data Fields
	$vars
	$activeBlock
	$js_files = array()
	$css_files = 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()
	$blockparents = 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
	init ()
	Clears all datafields of the object and rebuild the internal blocklist. More...
	getTemplatePath ($a_tplname, $a_in_module=false, $a_plugin=false)
	builds a full template path with template and module name More...
	init ()
	Clears all datafields of the object and rebuild the internal blocklist. More...
	init ()
	Clears all datafields of the object and rebuild the internal blocklist. More...

Protected Attributes
	$il_use_cache
	$il_cur_key
	$tplName
	$tplPath
	$tplIdentifier

Static Protected Attributes
static	$il_cache = array()

Private Member Functions
	fillVars ()
	all template vars defined in $vars will be replaced automatically without setting and parsing them with setVariable & parseCurrentBlock @access private More...
	getTemplateIdentifier ($a_tplname, $a_in_module=false)
	get a unique template identifier More...

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	(	string	$file,
		bool	$flag1,
		bool	$flag2,
		string	$in_module = "",
		string	$vars = "DEFAULT",
		bool	$plugin = false,
		bool	$a_use_cache = true
	)

constructor ilTemplate constructor.

Parameters

string	$file	template file
bool	$flag1	remove unknown variables
bool	$flag2	remove empty blocks
string	$in_module	module/service subdirectory
string	$vars	variables to replace
bool	$plugin	plugin template
bool	$a_use_cache	us cache

Exceptions

ilTemplateException

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

      {
        $this->activeBlock = "__global__";
        $this->vars = array();
        
        $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);
        
        if (!file_exists($fname)) {
            throw new \LogicException("Template '$fname' was not found.");
        }
 
        parent::__construct();
        $this->loadTemplatefile($fname, $flag1, $flag2);
        //add tplPath to replacevars
        $this->vars["TPLPATH"] = $this->tplPath;
 
        // Option for baseclass HTML_Template_IT
        $this->setOption('use_preg', false);
        
        return true;
    }

References XapiProxy\$plugin, $tplPath, ILIAS\GlobalScreen\Provider\__construct(), getTemplateIdentifier(), getTemplatePath(), loadTemplatefile(), and HTML_Template_IT\setOption().

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 @access public

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

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

References $tplPath, ILIAS\GlobalScreen\Provider\__construct(), getTemplatePath(), loadTemplatefile(), and HTML_Template_IT\setOption().

Here is the call graph for this function:

Member Function Documentation

addAdminPanelToolbar()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement addAdminPanelToolbar() method.
    }

addBlockFile() [1/2]

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

overwrites ITX::addBlockFile @access public

Parameters

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

Returns

boolean/string

Implements ilGlobalTemplateInterface.

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

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

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

Here is the call graph for this function:

addBlockFile() [2/2]

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

overwrites ITX::addBlockFile

@access public

Parameters

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

Returns

boolean/string

Implements ilGlobalTemplateInterface.

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

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

References DEBUG, and getTemplatePath().

Here is the call graph for this function:

addCss()

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

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

Implements ilGlobalTemplateInterface.

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

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

addInlineCss()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement addInlineCss() method.
    }

addJavaScript()

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

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

Implements ilGlobalTemplateInterface.

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

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

addLightbox()

ilTemplate::addLightbox	(		$a_html,
			$a_id
	)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement addLightbox() method.
    }

addOnLoadCode()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement addOnLoadCode() method.
    }

blockExists() [1/2]

ilTemplate::blockExists

(

$a_blockname

)

check if block exists in actual template @access private

Parameters

string

blockname

Returns

boolean

Implements ilGlobalTemplateInterface.

Definition at line 154 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);
    }

Referenced by fillCssFiles(), fillJavaScriptFiles(), ilTinyMCE\handleImgContextMenuItem(), and show().

Here is the caller graph for this function:

blockExists() [2/2]

ilTemplate::blockExists

(

$a_blockname

)

check if block exists in actual template @access private

Parameters

string

blockname

Returns

boolean

Implements ilGlobalTemplateInterface.

Definition at line 389 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);
    }

clearHeader()

ilTemplate::clearHeader

(

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement clearHeader() method.
    }

enableDragDropFileUpload()

ilTemplate::enableDragDropFileUpload

(

$a_ref_id

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement enableDragDropFileUpload() method.
    }

fillCssFiles()

ilTemplate::fillCssFiles

(

$a_force = false

)

Fill in the css file tags.

Parameters

boolean

$a_force

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

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

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

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

fillJavaScriptFiles()

ilTemplate::fillJavaScriptFiles

(

$force = true

)

Implements ilGlobalTemplateInterface.

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

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

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

Referenced by show().

Here is the call graph for this function:

Here is the caller graph for this function:

fillMessage()

ilTemplate::fillMessage

(

)

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

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

References $lng, $out, $txt, ilSession\clear(), ilSession\get(), and ilGlobalTemplateInterface\setVariable().

Here is the call graph for this function:

fillVars()

ilTemplate::fillVars ( )

private

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

Returns

integer

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

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

References ilGlobalTemplateInterface\setVariable().

Referenced by parseCurrentBlock(), and touchBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

get() [1/2]

ilTemplate::get

(

$part = "DEFAULT"

)

Parameters

string

Returns

string

Implements ilGlobalTemplateInterface.

Reimplemented in ilIndependantTemplate.

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

    {
        global $DIC;
 
        $html = $this->getUnmodified($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);
            }
        }
 
        return $html;
    }

References $DIC, XapiProxy\$resp, ilPluginAdmin\getPluginObject(), getUnmodified(), IL_COMP_SERVICE, and ilUIHookPluginGUI\KEEP.

Here is the call graph for this function:

get() [2/2]

ilTemplate::get

(

$part = "DEFAULT"

)

Parameters

string

Returns

string

Implements ilGlobalTemplateInterface.

Reimplemented in ilIndependantTemplate.

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

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

References ILIAS\GlobalScreen\get().

Here is the call graph for this function:

getMessageHTML()

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

Get HTML for a system message.

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

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

References $a_type, and $lng.

Referenced by show().

Here is the caller graph for this function:

getOnLoadCodeForAsynch()

ilTemplate::getOnLoadCodeForAsynch

(

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement getOnLoadCodeForAsynch() method.
    }

getSpecial()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement getSpecial() method.
    }

getTemplateIdentifier()

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

private

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

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

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

Referenced by __construct(), and addBlockFile().

Here is the caller graph for this function:

getTemplatePath() [1/2]

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

protected

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

    {
        global $DIC;
 
        $ilCtrl = null;
        if (isset($DIC["ilCtrl"])) {
            $ilCtrl = $DIC->ctrl();
        }
        
        $fname = "";
        
        if (strpos($a_tplname, "/") === false) {
            $module_path = "";
            
            if ($a_in_module != "") {
                $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") {
                $style = ilStyleDefinition::getCurrentStyle();
 
                $fname = "./Customizing/global/skin/" .
                        ilStyleDefinition::getCurrentSkin() . "/" . $style . "/" . $module_path
                        . basename($a_tplname);
 
                if ($fname == "" || !file_exists($fname)) {
                    $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;
    }

References $DIC, $ilCtrl, ilStyleDefinition\getCurrentSkin(), and ilStyleDefinition\getCurrentStyle().

Referenced by __construct(), and addBlockFile().

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

References $_GET, $ilCtrl, and ILIAS_MODULE.

getUnmodified()

ilTemplate::getUnmodified

(

$part = "DEFAULT"

)

Parameters

string

Returns

string

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

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

References $DIC, and ILIAS\GlobalScreen\get().

Referenced by get().

Here is the call graph for this function:

Here is the caller graph for this function:

hideFooter()

ilTemplate::hideFooter

(

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement hideFooter() method.
    }

init()

ilTemplate::init ( )

protected

Clears all datafields of the object and rebuild the internal blocklist.

LoadTemplatefile() and setTemplate() automatically call this function when a new template is given. Don't use this function unless you know what you're doing.

@access public

See also

free()

Reimplemented from HTML_Template_ITX.

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

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

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

Here is the call graph for this function:

loadStandardTemplate()

ilTemplate::loadStandardTemplate

(

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement loadStandardTemplate() method.
    }

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

Returns

boolean false on failure, otherwise true

See also

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

Reimplemented from HTML_Template_IT.

Reimplemented in ilIndependantTemplate.

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

      {
        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.
    }

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

Referenced by __construct().

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

Parameters

string

Returns

string

Implements ilGlobalTemplateInterface.

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

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

References $activeBlock, and fillVars().

Referenced by ilCalendarBlockGUI\addConsultationHourButtons(), ilContainerRenderer\addHeaderRow(), ilContainerRenderer\addSeparatorRow(), ilContainerRenderer\addStandardRow(), ilCalendarBlockGUI\addSubscriptionButton(), ilChatroomAuthInputGUI\insert(), ilOrgUnitAuthorityInputGUI\insert(), ilCaptchaInputGUI\insert(), ilEMailInputGUI\insert(), ilClozeGapInputBuilderGUI\insert(), ilContainerRenderer\renderDetails(), ilContainerRenderer\renderHelperGeneric(), ilSurveyPageGUI\renderPageNode(), and ilContainerRenderer\renderSelectAllBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

parseCurrentBlock() [2/2]

ilTemplate::parseCurrentBlock

(

$part = "DEFAULT"

)

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

Parameters

string

Returns

string

Implements ilGlobalTemplateInterface.

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

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

References $activeBlock.

printToStdout()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement printToStdout() method.
    }

printToString()

ilTemplate::printToString

(

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

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

resetHeaderBlock()

ilTemplate::resetHeaderBlock

(

$a_reset_header_action = true

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement resetHeaderBlock() method.
    }

resetJavascript()

ilTemplate::resetJavascript

(

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement resetJavascript() method.
    }

setAlertProperties()

ilTemplate::setAlertProperties

(

array

$a_props

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setAlertProperties() method.
    }

setBodyClass()

ilTemplate::setBodyClass

(

$a_class = ""

)

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setBodyClass() method.
    }

setContent()

ilTemplate::setContent

(

$a_html

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setContent() method.
    }

setCurrentBlock() [1/2]

ilTemplate::setCurrentBlock

(

$part = "DEFAULT"

)

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

@access public

Parameters

string

Returns

???

Implements ilGlobalTemplateInterface.

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

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

Referenced by ilCalendarBlockGUI\addConsultationHourButtons(), ilContainerRenderer\addHeaderRow(), ilContainerRenderer\addSeparatorRow(), ilContainerRenderer\addStandardRow(), ilCalendarBlockGUI\addSubscriptionButton(), fillCssFiles(), fillJavaScriptFiles(), ilChatroomAuthInputGUI\insert(), ilOrgUnitAuthorityInputGUI\insert(), ilCaptchaInputGUI\insert(), ilEMailInputGUI\insert(), ilClozeGapInputBuilderGUI\insert(), ilContainerRenderer\renderDetails(), ilContainerRenderer\renderHelperGeneric(), ilSurveyPageGUI\renderPageNode(), ilContainerRenderer\renderSelectAllBlock(), and touchBlock().

Here is the caller graph for this function:

setCurrentBlock() [2/2]

ilTemplate::setCurrentBlock

(

$part = "DEFAULT"

)

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

@access public

Parameters

string

Returns

???

Implements ilGlobalTemplateInterface.

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

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

setDescription()

ilTemplate::setDescription

(

$a_descr

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setDescription() method.
    }

setHeaderActionMenu()

ilTemplate::setHeaderActionMenu

(

$a_header

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setHeaderActionMenu() method.
    }

setHeaderPageTitle()

ilTemplate::setHeaderPageTitle

(

$a_title

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setHeaderPageTitle() method.
    }

setLeftContent()

ilTemplate::setLeftContent

(

$a_html

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setLeftContent() method.
    }

setLeftNavContent()

ilTemplate::setLeftNavContent

(

$a_content

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setLeftNavContent() method.
    }

setLocator()

ilTemplate::setLocator

(

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setLocator() method.
    }

setLoginTargetPar()

ilTemplate::setLoginTargetPar

(

$a_val

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setLoginTargetPar() method.
    }

setOnScreenMessage()

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

Set message.

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

Implements ilGlobalTemplateInterface.

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

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

References $a_type, and ilSession\set().

Here is the call graph for this function:

setPageFormAction()

ilTemplate::setPageFormAction

(

$a_action

)

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setPageFormAction() method.
    }

setPermanentLink()

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

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setPermanentLink() method.
    }

setRightContent()

ilTemplate::setRightContent

(

$a_html

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setRightContent() method.
    }

setSubTabs()

ilTemplate::setSubTabs

(

$a_tabs_html

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setSubTabs() method.
    }

setTabs()

ilTemplate::setTabs

(

$a_tabs_html

)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setTabs() method.
    }

setTitle()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setTitle() method.
    }

setTitleIcon()

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

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setTitleIcon() method.
    }

setTreeFlatIcon()

ilTemplate::setTreeFlatIcon	(		$a_link,
			$a_mode
	)

@inheritDoc

Implements ilGlobalTemplateInterface.

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

    {
        // TODO: Implement setTreeFlatIcon() method.
    }

show()

ilTemplate::show

(

$part = "DEFAULT"

)

@access public

Parameters

string

Reimplemented from HTML_Template_IT.

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

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

References $_GET, $_POST, $_SERVER, $out, $txt, blockExists(), ilSession\clear(), fillCssFiles(), fillJavaScriptFiles(), ilSession\get(), getMessageHTML(), ilSession\set(), ilGlobalTemplateInterface\setVariable(), and show().

Here is the call graph for this function:

touchBlock() [1/2]

ilTemplate::touchBlock

(

$block

)

overwrites ITX::touchBlock.

@access public

Parameters

string

Returns

???

Implements ilGlobalTemplateInterface.

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

    {
        $this->setCurrentBlock($block);
        $count = $this->fillVars();
        $this->parseCurrentBlock();
 
        if ($count == 0) {
            parent::touchBlock($block);
        }
    }

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

Referenced by ilCalendarBlockGUI\addConsultationHourButtons(), ilContainerRenderer\addHeaderRow(), ilContainerRenderer\addStandardRow(), and ilSurveyPageGUI\renderPageNode().

Here is the call graph for this function:

Here is the caller graph for this function:

touchBlock() [2/2]

ilTemplate::touchBlock

(

$block

)

overwrites ITX::touchBlock.

@access public

Parameters

string

Returns

???

Implements ilGlobalTemplateInterface.

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

    {
        $this->setCurrentBlock($block);
        //$count = $this->fillVars();
        $this->parseCurrentBlock();
 
        if ($count == 0) {
            parent::touchBlock($block);
        }
    }

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

Here is the call graph for this function:

variableExists()

ilTemplate::variableExists

(

$a_variablename

)

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

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

Field Documentation

$activeBlock

ilTemplate::$activeBlock

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

Referenced by parseCurrentBlock().

$css_files

ilTemplate::$css_files = array()

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

$il_cache

ilTemplate::$il_cache = array()

staticprotected

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

$il_cur_key

ilTemplate::$il_cur_key

protected

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

Referenced by init().

$il_use_cache

ilTemplate::$il_use_cache

protected

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

$js_files

ilTemplate::$js_files = array()

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

$tplIdentifier

ilTemplate::$tplIdentifier

protected

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

$tplName

ilTemplate::$tplName

protected

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

$tplPath

ilTemplate::$tplPath

protected

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

Referenced by __construct().

$vars

ilTemplate::$vars

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

---

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

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