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

	variableExists ($a_variablename)

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

Data Fields
	$vars

	$activeBlock

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

	getTemplatePath ($a_tplname, $a_in_module=false, $a_plugin=false)
	builds a full template path with template and module name More...

Protected Member Functions inherited from HTML_Template_ITX
	init ()

Protected Member Functions inherited from HTML_Template_IT
	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 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()

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.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addBlockFile()

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

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

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

◆ blockExists()

ilTemplate::blockExists ( $a_blockname )

check if block exists in actual template private

Parameters

string blockname

Returns: boolean

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

Referenced by ilTinyMCE\handleImgContextMenuItem().

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

◆ fillVars()

ilTemplate::fillVars ( )

private

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

Returns: integer

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

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

◆ get()

ilTemplate::get ( $part = "DEFAULT" )

Parameters

string

Returns: string

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

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

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

Here is the call graph for this function:

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

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

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.

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

Referenced by __construct(), and addBlockFile().

     {
         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") {
                 $style = ilStyleDefinition::getCurrentStyle();
                 $skin = ilStyleDefinition::getCurrentSkin();
                 $base_path = "./Customizing/global/skin/";
                 $ui_path = "/" . str_replace("src/UI/templates/default", "UI", $a_tplname);
                 $fname = $base_path . ilStyleDefinition::getCurrentSkin() . "/" . $style . "/" . $ui_path;
 
                 if (!file_exists($fname)) {
                     $fname = $base_path . $skin . "/" . $ui_path;
                 }
             }
 
             if ($fname == "" || !file_exists($fname)) {
                 $fname = $a_tplname;
             }
         } else {
             $fname = $a_tplname;
         }
         return $fname;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUnmodified()

ilTemplate::getUnmodified ( $part = "DEFAULT" )

Parameters

string

Returns: string

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

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

Referenced by get().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

ilTemplate::init ( )

protected

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

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

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

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

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

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

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

References $activeBlock, and fillVars().

Referenced by ilMDEditorGUI\__fillSubelements(), ilContainerRenderer\addHeaderRow(), ilExerciseGSToolProvider\addSection(), ilContainerRenderer\addSeparatorRow(), ilContainerRenderer\addStandardRow(), ilCalendarBlockGUI\addSubscriptionButton(), ilOrgUnitAuthorityInputGUI\insert(), ilChatroomAuthInputGUI\insert(), ilEMailInputGUI\insert(), ilCaptchaInputGUI\insert(), ilClozeGapInputBuilderGUI\insert(), ilSCORMExplorer\insertObject(), ilTestQuestionNavigationGUI\parseButtonsBlock(), ilTestQuestionNavigationGUI\parseNavigation(), ilAssQuestionPreviewGUI\populateGenericQuestionFeedback(), ilAssQuestionPreviewGUI\populateInstantResponseHeader(), ilAssQuestionPreviewGUI\populateInstantResponseMessage(), ilAssQuestionPreviewGUI\populateNotesPanel(), ilAssQuestionPreviewGUI\populateReachedPointsOutput(), ilAssQuestionPreviewGUI\populateSolutionOutput(), ilAssQuestionPreviewGUI\populateSpecificQuestionFeedback(), ilTestQuestionNavigationGUI\renderActionsIcon(), ilTestQuestionNavigationGUI\renderButtonInstance(), ilAssLacLegendGUI\renderCommonLegendPart(), ilContainerRenderer\renderDetails(), ilObjForumGUI\renderDraftContent(), ilAssLacLegendGUI\renderExample(), ilContainerRenderer\renderHelperGeneric(), ilTestQuestionNavigationGUI\renderIcon(), ilSurveyPageGUI\renderPageNode(), ilObjForumGUI\renderPostContent(), 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:

◆ setCurrentBlock()

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

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

public

Parameters

string

Returns: ???

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

Referenced by ilMDEditorGUI\__fillSubelements(), ilContainerRenderer\addHeaderRow(), ilExerciseGSToolProvider\addSection(), ilContainerRenderer\addSeparatorRow(), ilContainerRenderer\addStandardRow(), ilCalendarBlockGUI\addSubscriptionButton(), ilOrgUnitAuthorityInputGUI\insert(), ilChatroomAuthInputGUI\insert(), ilEMailInputGUI\insert(), ilCaptchaInputGUI\insert(), ilClozeGapInputBuilderGUI\insert(), ilSCORMExplorer\insertObject(), ilTestQuestionNavigationGUI\parseButtonsBlock(), ilTestQuestionNavigationGUI\parseNavigation(), ilAssQuestionPreviewGUI\populateGenericQuestionFeedback(), ilAssQuestionPreviewGUI\populateInstantResponseHeader(), ilAssQuestionPreviewGUI\populateInstantResponseMessage(), ilAssQuestionPreviewGUI\populateNotesPanel(), ilAssQuestionPreviewGUI\populateReachedPointsOutput(), ilAssQuestionPreviewGUI\populateSolutionOutput(), ilAssQuestionPreviewGUI\populateSpecificQuestionFeedback(), ilTestQuestionNavigationGUI\renderActionsIcon(), ilTestQuestionNavigationGUI\renderButtonInstance(), ilAssLacLegendGUI\renderCommonLegendPart(), ilContainerRenderer\renderDetails(), ilObjForumGUI\renderDraftContent(), ilAssLacLegendGUI\renderExample(), ilContainerRenderer\renderHelperGeneric(), ilTestQuestionNavigationGUI\renderIcon(), ilSurveyPageGUI\renderPageNode(), ilObjForumGUI\renderPostContent(), ilAssLacLegendGUI\renderQuestSpecificLegendPart(), ilContainerRenderer\renderSelectAllBlock(), ilObjForumGUI\renderSplitButton(), and touchBlock().

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

Here is the caller graph for this function:

◆ touchBlock()

ilTemplate::touchBlock ( $block )

overwrites ITX::touchBlock.

public

Parameters

string

Returns: ???

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

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

Referenced by ilContainerRenderer\addHeaderRow(), ilContainerRenderer\addStandardRow(), ilTinyMCE\handleImgContextMenuItem(), and ilSurveyPageGUI\renderPageNode().

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

Definition at line 515 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().

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

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

Services/UICore/classes/class.ilTemplate.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addBlockFile()

◆ blockExists()

◆ fillVars()

◆ get()

◆ getTemplateIdentifier()

◆ getTemplatePath()

◆ getUnmodified()

◆ init()

◆ loadTemplatefile()

◆ parseCurrentBlock()

◆ setCurrentBlock()

◆ touchBlock()

◆ variableExists()

Field Documentation

◆ $activeBlock

◆ $il_cache

◆ $il_cur_key

◆ $il_use_cache

◆ $tplIdentifier

◆ $tplName

◆ $tplPath

◆ $vars