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=ilGlobalTemplateInterface::DEFAULT_BLOCK, bool $plugin=false, bool $a_use_cache=true)
	constructor ilTemplate constructor. More...

	blockExists (string $a_blockname)
	Checks wheter a block exists. More...

	get (string $part=ilGlobalTemplateInterface::DEFAULT_BLOCK)
	Returns a block with all replacements done. More...

	getUnmodified (string $part=ilGlobalTemplateInterface::DEFAULT_BLOCK)

	setCurrentBlock (string $part=ilGlobalTemplateInterface::DEFAULT_BLOCK)

	touchBlock (string $block)

	parseCurrentBlock (string $part=ilGlobalTemplateInterface::DEFAULT_BLOCK)

	addBlockFile (string $var, string $block, string $tplname, ?string $in_module=null)

	loadTemplatefile (string $filename, bool $removeUnknownVariables=true, bool $removeEmptyBlocks=true)
	Reads a template file from the disk. More...

	getTemplateIdentifier (string $a_tplname, ?string $a_in_module=null)
	get a unique template identifier The identifier is common for default or customized skins but distincts templates of different services with the same name. More...

	variableExists (string $a_variablename)

Public Member Functions inherited from HTML_Template_ITX
	__construct (string $root='')
	Builds some complex regexps and calls the constructor of the parent class. More...

	replaceBlock (string $block, string $template, bool $keep_content=false)
	Replaces an existing block with new content. More...

	addBlock (string $placeholder, string $blockname, string $template)
	Adds a block to the template changing a variable placeholder to a block placeholder. More...

	addBlockfile (string $placeholder, string $blockname, string $filename)
	Adds a block taken from a file to the template changing a variable placeholder to a block placeholder. More...

	removeBlockData (string $block)
	Recursively removes all data assiciated with a block, including all inner blocks. More...

	blockExists (string $blockname)
	Checks wheter a block exists. More...

	buildFunctionlist ()
	Builds a functionlist from the template. More...

	getValue (string $code, $delimiter)
	Truncates the given code from the first occurence of $delimiter but ignores $delimiter enclosed by " or '. More...

	deleteFromBlockvariablelist (string $block, $variables)
	Deletes one or many variables from the block variable list. More...

	updateBlockvariablelist (string $block)
	Updates the variable list of a block. More...

	findPlaceholderBlocks (string $variable)
	Returns an array of blocknames where the given variable placeholder is used. More...

	warning (string $message, string $file='', int $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 (string $root='', ?array $options=null)
	Builds some complex regular expressions and optinally sets the file root directory. More...

	setOption (string $option, $value)
	Sets the option for the template class. More...

	setOptions (array $options)
	Sets the options for the template class. More...

	show (string $block=self::IT_DEFAULT_BLOCK)
	Print a certain block with all replacements done. More...

	get (string $block=self::IT_DEFAULT_BLOCK)
	Returns a block with all replacements done. More...

	parse (string $block=self::IT_DEFAULT_BLOCK, bool $flag_recursion=false)
	Parses the given block. More...

	parseCurrentBlock ()
	Parses the current block. More...

	setVariable ($variable, $value='')
	Sets a variable value. More...

	setCurrentBlock (string $block=self::IT_DEFAULT_BLOCK)
	Sets the name of the current block that is the block where variables are added. More...

	touchBlock (string $block)
	Preserves an empty block even if removeEmptyBlocks is true. More...

	free ()
	Clears all datafields of the object. More...

	setTemplate (string $template, bool $removeUnknownVariables=true, bool $removeEmptyBlocks=true)
	Sets the template. More...

	loadTemplatefile (string $filename, bool $removeUnknownVariables=true, bool $removeEmptyBlocks=true)
	Reads a template file from the disk. More...

	setRoot (string $root)
	Sets the file root. More...

	buildBlockvariablelist ()
	Build a list of all variables within of a block. More...

	findBlocks (string $string)
	Recusively builds a list of all blocks within the template. More...

	getFile (string $filename)
	Reads a file from disk and returns its content. More...

	_addPregDelimiters (string $str)
	Adds delimiters to a string, so it can be used as a pattern in preg_* functions. More...

	_preserveOpeningDelimiter (string $str)
	Replaces an opening delimiter by a special string. More...

	errorMessage (int $value, string $blockname='')
	Return a textual error message for a IT error code. More...

Data Fields
array	$vars = []
	variablen die immer in jedem block ersetzt werden sollen More...

string	$activeBlock = ''
	Aktueller Block Der wird gemerkt bei der berladenen Funktion setCurrentBlock, damit beim ParseBlock vorher ein replace auf alle Variablen gemacht werden kann, die mit dem BLockname anfangen. More...

Data Fields inherited from HTML_Template_ITX
array	$warn = []
	Array with all warnings. More...

bool	$printWarning = false
	Print warnings? More...

bool	$haltOnWarning = false
	Call die() on warning? More...

string	$checkblocknameRegExp = ''
	RegExp used to test for a valid blockname. More...

string	$functionPrefix = 'func_'
	Functionnameprefix used when searching function calls in the template. More...

string	$functionnameRegExp = '[_a-zA-Z]+[A-Za-z_0-9]*'
	Functionname RegExp. More...

string	$functionRegExp = ''
	RegExp used to grep function calls in the template. More...

array	$functions = []
	List of functions found in the template. More...

array	$callback = []
	List of callback functions specified by the user. More...

Data Fields inherited from HTML_Template_IT
const	IT_OK = 1

const	IT_ERROR = -1

const	IT_TPL_NOT_FOUND = -2

const	IT_BLOCK_NOT_FOUND = -3

const	IT_BLOCK_DUPLICATE = -4

const	IT_UNKNOWN_OPTION = -6

const	IT_DEFAULT_BLOCK = '__global__'

array	$err = []
	Contains the error objects. More...

bool	$clearCache = false
	Clear cache on get()? More...

string	$openingDelimiter = '{'
	First character of a variable placeholder ( _{_VARIABLE} ). More...

string	$closingDelimiter = '}'
	Last character of a variable placeholder ( {VARIABLE_}_ ). More...

string	$blocknameRegExp = '[\.0-9A-Za-z_-]+'
	RegExp matching a block in the template. More...

string	$variablenameRegExp = '[\.0-9A-Za-z_-]+'
	RegExp matching a variable placeholder in the template. More...

string	$variablesRegExp = ''
	RegExp used to find variable placeholder, filled by the constructor. More...

string	$removeVariablesRegExp = ''
	RegExp used to strip unused variable placeholder. More...

bool	$removeUnknownVariables = true
	Controls the handling of unknown variables, default is remove. More...

bool	$removeEmptyBlocks = true
	Controls the handling of empty blocks, default is remove. More...

string	$blockRegExp = ''
	RegExp used to find blocks an their content, filled by the constructor. More...

string	$currentBlock = self::IT_DEFAULT_BLOCK
	Name of the current block. More...

string	$template = ''
	Content of the template. More...

array	$blocklist = []
	Array of all blocks and their content. More...

array	$blockdata = []
	Array with the parsed content of a block. More...

array	$blockvariables = []
	Array of variables in a block. More...

array	$blockparents = []
	Array of block parents. More...

array	$blockinner = []
	Array of inner blocks of a block. More...

array	$touchedBlocks = []
	List of blocks to preverse even if they are "empty". More...

array	$variableCache = []
	Variable cache. More...

bool	$clearCacheOnParse = false
	Clear the variable cache on parse? If you're not an expert just leave the default false. More...

string	$fileRoot = ''
	Root directory for all file operations. More...

bool	$flagBlocktrouble = false
	Internal flag indicating that a blockname was used multiple times. More...

bool	$flagGlobalParsed = false
	Flag indicating that the global block was parsed. More...

bool	$flagCacheTemplatefile = true
	EXPERIMENTAL! FIXME! Flag indication that a template gets cached. More...

string	$lastTemplatefile = ''
	EXPERIMENTAL! FIXME! More...

array	$_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 LoadTemplatefile() and setTemplate() automatically call this function when a new template is given. More...

	getCurrentSkin ()

	getCurrentStyle ()

	fileExistsInSkin (string $path)

	getTemplatePath (string $a_tplname, string $a_in_module='')

	init ()
	Clears all datafields of the object and rebuild the internal blocklist LoadTemplatefile() and setTemplate() automatically call this function when a new template is given. More...

	init ()
	Clears all datafields of the object and rebuild the internal blocklist LoadTemplatefile() and setTemplate() automatically call this function when a new template is given. More...

Protected Attributes
bool	$il_use_cache

string	$il_cur_key

string	$tplName

string	$tplPath

string	$tplIdentifier

Protected Attributes inherited from HTML_Template_IT
string	$real_filename = ''
	Holds the real template file name. More...

Static Protected Attributes
static array	$il_cache = []

Private Member Functions
	fillVars ()
	all template vars defined in $vars will be replaced automatically without setting and parsing them with setVariable & parseCurrentBlock 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; Thibeau Fuhrer thibe.nosp@m.au@s.nosp@m.r.sol.nosp@m.utio.nosp@m.ns

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

Constructor & Destructor Documentation

◆ __construct()

ilTemplate::__construct	(	string	$file,
		bool	$flag1,
		bool	$flag2,
		string	$in_module = `""`,
		string	$vars = `ilGlobalTemplateInterface::DEFAULT_BLOCK`,
		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|ilSystemStyleException

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

      {
        $this->activeBlock = HTML_Template_IT::IT_DEFAULT_BLOCK;
        $this->il_use_cache = $a_use_cache;
        $this->il_cur_key = $file . "/" . $in_module;
 
        $fname = $this->getTemplatePath($file, $in_module);
        if (!file_exists($fname)) {
            throw new ilTemplateException("Template '$fname' was not found.\nfile: " . $file . "\nmodule: " . $in_module);
        }
 
        $this->tplName = basename($fname);
        $this->tplPath = dirname($fname);
        $this->vars["TPLPATH"] = $this->tplPath;
        $this->tplIdentifier = $this->getTemplateIdentifier($file, $in_module);
 
        parent::__construct();
 
        $this->loadTemplatefile($fname, $flag1, $flag2);
        $this->setOption('use_preg', false);
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addBlockFile()

ilTemplate::addBlockFile	(	string	$var,
		string	$block,
		string	$tplname,
		?string	$in_module = `null`
	)

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

                                                                                                        : bool
    {
        global $DIC;
 
        $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);
        $component_factory = $DIC["component.factory"];
        foreach ($component_factory->getActivePluginsInSlot("uihk") as $ui_plugin) {
            $gui_class = $ui_plugin->getUIClassInstance();
            $resp = $gui_class->getHTML(
                "",
                "template_add",
                [
                    "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, $id, XapiProxy\$resp, HTML_Template_IT\$template, HTML_Template_ITX\addBlock(), HTML_Template_IT\getFile(), getTemplateIdentifier(), getTemplatePath(), and ilUIHookPluginGUI\KEEP.

Here is the call graph for this function:

◆ blockExists()

ilTemplate::blockExists ( string $blockname )

Checks wheter a block exists.

Reimplemented from HTML_Template_ITX.

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

                                                    : bool
    {
        // 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]) ||
            isset($this->blockvariables[$a_blockname]);
    }

◆ fileExistsInSkin()

ilTemplate::fileExistsInSkin ( string $path )

protected

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

                                                     : bool
    {
        return file_exists($path);
    }

References $path.

◆ fillVars()

ilTemplate::fillVars ( )

private

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

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

                               : int
    {
        $count = 0;
        foreach ($this->vars as $key => $val) {
            if (is_array($this->blockvariables[$this->activeBlock]) &&
                array_key_exists($key, $this->blockvariables[$this->activeBlock])
            ) {
                $this->setVariable($key, $val);
                $count++;
            }
        }
 
        return $count;
    }

References HTML_Template_IT\setVariable().

Referenced by parseCurrentBlock(), and touchBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get()

ilTemplate::get ( string $block = ilGlobalTemplateInterface::DEFAULT_BLOCK )

Returns a block with all replacements done.

Exceptions

ilTemplateException

Reimplemented from HTML_Template_IT.

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

                                                                              : string
    {
        global $DIC;
 
        $html = $this->getUnmodified($part);
        $component_factory = $DIC["component.factory"];
        foreach ($component_factory->getActivePluginsInSlot("uihk") as $ui_plugin) {
            $gui_class = $ui_plugin->getUIClassInstance();
            $resp = $gui_class->getHTML(
                "",
                "template_get",
                [
                    "tpl_id" => $this->tplIdentifier,
                    "tpl_obj" => $this,
                    "html" => $html
                ]
            );
 
            if (ilUIHookPluginGUI::KEEP !== $resp["mode"]) {
                $html = $gui_class->modifyHTML($html, $resp);
            }
        }
 
        return $html;
    }

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

Referenced by ilObjForumGUI\createThreadObject(), ilCalendarViewGUI\getContentByPlugins(), ilCalendarBlockGUI\getLegacyContent(), ilCalendarSelectionBlockGUI\getLegacyContent(), ilRepositoryObjectSearchBlockGUI\getLegacyContent(), ilWikiFunctionsBlockGUI\getLegacyContent(), ilTestPlayerAbstractGUI\getQuestionFeedbackModalHtml(), ilNewsForContextBlockGUI\showFeedUrl(), ilPDNewsBlockGUI\showFeedUrl(), and ilNewsForContextBlockGUI\showNews().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentSkin()

ilTemplate::getCurrentSkin ( )

protected

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

                                       : ?string
    {
        // use ilStyleDefinition instead of account to get the current skin
        return ilStyleDefinition::getCurrentSkin();
    }

References ilStyleDefinition\getCurrentSkin().

Here is the call graph for this function:

◆ getCurrentStyle()

ilTemplate::getCurrentStyle ( )

protected

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

                                        : ?string
    {
        return ilStyleDefinition::getCurrentStyle();
    }

References ilStyleDefinition\getCurrentStyle().

Here is the call graph for this function:

◆ getTemplateIdentifier()

ilTemplate::getTemplateIdentifier	(	string	$a_tplname,
		?string	$a_in_module = `null`
	)

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

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

                                                                                         : string
    {
        if (strpos($a_tplname, "/") === false) {
            if (null !== $a_in_module) {
                $module_path = $a_in_module . "/";
            } else {
                $module_path = "";
            }
 
            return $module_path . basename($a_tplname);
        }
 
        return $a_tplname;
    }

Referenced by __construct(), and addBlockFile().

Here is the caller graph for this function:

◆ getTemplatePath()

ilTemplate::getTemplatePath	(	string	$a_tplname,
		string	$a_in_module = `''`
	)

protected

Exceptions

ilSystemStyleException

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

                                                                                   : string
    {
        $ilias_root = realpath(__DIR__ . '/../../../../') . '/';
 
        if (str_starts_with($a_in_module, $ilias_root)) {
            $a_in_module = str_replace($ilias_root, '', $a_in_module);
        }
 
        if (str_ends_with($a_in_module, '/')) {
            $a_in_module = rtrim($a_in_module, '/');
        }
 
        $tpl_sub_path = '/templates/default/';
        if (str_starts_with($a_tplname, 'components/ILIAS/UI/')) {
            $a_in_module = 'components/ILIAS/UI/src';
            $a_tplname = str_replace('components/ILIAS/UI/src/templates/default/', '', $a_tplname);
        }
 
        if (str_starts_with($a_tplname, $ilias_root)) {
            $a_tplname = str_replace($ilias_root, '', $a_tplname);
        }
        if (strpos($a_tplname, 'public/Customizing/global/plugins')) {
            $tpl_sub_path = '';
        }
 
        $base_path = $ilias_root;
        $default = $base_path . $a_in_module . $tpl_sub_path . $a_tplname;
 
        $skin = $this->getCurrentSkin();
        if ($skin === 'default') {
            return $default;
        }
 
        $style = $this->getCurrentStyle();
        $base_path .= 'public/Customizing/skin/' . $skin . '/' . $style;
 
        if ($a_in_module === 'components/ILIAS/UI/src') {
            $a_in_module = 'UI';
        }
 
        $from_skin = $base_path . '/' . $a_in_module . '/' . $a_tplname;
 
        return $this->fileExistsInSkin($from_skin) ? $from_skin : $default;
    }

Referenced by __construct(), and addBlockFile().

Here is the caller graph for this function:

◆ getUnmodified()

ilTemplate::getUnmodified ( string $part = ilGlobalTemplateInterface::DEFAULT_BLOCK )

Exceptions

ilTemplateException

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

                                                                                        : string
    {
        // I can't believe how garbage this is.
        if (ilGlobalTemplateInterface::DEFAULT_BLOCK === $part) {
            $part = self::IT_DEFAULT_BLOCK;
        }
 
        return parent::get($part);
    }

References ILIAS\UICore\GlobalTemplate\DEFAULT_BLOCK, ILIAS\GlobalScreen\get(), and HTML_Template_IT\IT_DEFAULT_BLOCK.

Referenced by get().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Exceptions

ilTemplateException

Reimplemented from HTML_Template_ITX.

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

                             : void
    {
        $this->free();
        $this->buildFunctionlist();
 
        $cache_hit = false;
        if ($this->il_use_cache &&
            isset(self::$il_cache[$this->il_cur_key]) &&
            is_array(self::$il_cache[$this->il_cur_key])
        ) {
            $cache_hit = true;
            $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->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 anymore
        $this->template = '';
    }

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:

◆ loadTemplatefile()

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

Reads a template file from the disk.

Exceptions

ilTemplateException

Reimplemented from HTML_Template_IT.

Reimplemented in ilIndependantTemplate.

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

     : bool {
        global $DIC;
 
        $template = '';
        if (!$this->flagCacheTemplatefile ||
            $this->lastTemplatefile !== $filename
        ) {
            $template = $this->getFile($filename);
        }
        $this->lastTemplatefile = $filename;
 
        $component_factory = $DIC["component.factory"];
        foreach ($component_factory->getActivePluginsInSlot("uihk") as $ui_plugin) {
            $gui_class = $ui_plugin->getUIClassInstance();
            $resp = $gui_class->getHTML(
                "",
                "template_load",
                [
                    "tpl_id" => $this->tplIdentifier,
                    "tpl_obj" => $this,
                    "html" => $template,
                ]
            );
 
            if ($resp["mode"] !== ilUIHookPluginGUI::KEEP) {
                $template = $gui_class->modifyHTML($template, $resp);
            }
        }
 
        return
            $template !== '' &&
            $this->setTemplate(
                $template,
                $removeUnknownVariables,
                $removeEmptyBlocks
            );
    }

References HTML_Template_IT\$template, and HTML_Template_IT\getFile().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseCurrentBlock()

ilTemplate::parseCurrentBlock ( string $part = ilGlobalTemplateInterface::DEFAULT_BLOCK )

Exceptions

ilTemplateException

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

                                                                                            : bool
    {
        $this->fillVars();
        $this->activeBlock = self::IT_DEFAULT_BLOCK;
 
        return parent::parseCurrentBlock();
    }

References fillVars(), and HTML_Template_IT\IT_DEFAULT_BLOCK.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentBlock()

ilTemplate::setCurrentBlock ( string $part = ilGlobalTemplateInterface::DEFAULT_BLOCK )

Exceptions

ilTemplateException

Reimplemented from HTML_Template_IT.

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

                                                                                          : bool
    {
        // I can't believe how garbage this is.
        if (ilGlobalTemplateInterface::DEFAULT_BLOCK === $part) {
            $part = self::IT_DEFAULT_BLOCK;
        }
 
        $this->activeBlock = $part;
        return parent::setCurrentBlock($part);
    }

References ILIAS\UICore\GlobalTemplate\DEFAULT_BLOCK, and HTML_Template_IT\IT_DEFAULT_BLOCK.

Here is the caller graph for this function:

◆ touchBlock()

ilTemplate::touchBlock ( string $block )

Exceptions

ilTemplateException

Reimplemented from HTML_Template_IT.

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

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

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

Referenced by ilPasteIntoMultipleItemsExplorer\formatObject(), ilWikiFunctionsBlockGUI\getLegacyContent(), ilExplorer\handleListEndTags(), ilExplorer\handleListStartTags(), ilNestedList\listEnd(), ilNestedList\listItemEnd(), ilNestedList\listItemStart(), and ilNestedList\listStart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ variableExists()

ilTemplate::variableExists ( string $a_variablename )

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

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

Field Documentation

◆ $activeBlock

string ilTemplate::$activeBlock = ''

Aktueller Block Der wird gemerkt bei der berladenen Funktion setCurrentBlock, damit beim ParseBlock vorher ein replace auf alle Variablen gemacht werden kann, die mit dem BLockname anfangen.

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

◆ $il_cache

array ilTemplate::$il_cache = []

staticprotected

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

◆ $il_cur_key

string ilTemplate::$il_cur_key

protected

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

Referenced by init().

◆ $il_use_cache

bool ilTemplate::$il_use_cache

protected

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

◆ $tplIdentifier

string ilTemplate::$tplIdentifier

protected

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

◆ $tplName

string ilTemplate::$tplName

protected

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

◆ $tplPath

string ilTemplate::$tplPath

protected

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

Referenced by __construct().

◆ $vars

array ilTemplate::$vars = []

variablen die immer in jedem block ersetzt werden sollen

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

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

components/ILIAS/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()

◆ fileExistsInSkin()

◆ fillVars()

◆ get()

◆ getCurrentSkin()

◆ getCurrentStyle()

◆ getTemplateIdentifier()

◆ getTemplatePath()

◆ getUnmodified()

◆ init()

◆ loadTemplatefile()

◆ parseCurrentBlock()

◆ setCurrentBlock()

◆ touchBlock()

◆ variableExists()

Field Documentation

◆ $activeBlock

◆ $il_cache

◆ $il_cur_key

◆ $il_use_cache

◆ $tplIdentifier

◆ $tplName

◆ $tplPath

◆ $vars