HTML_Template_IT Class Reference

Integrated Template - IT Well there's not much to say about it. More...

Inheritance diagram for HTML_Template_IT:

Collaboration diagram for HTML_Template_IT:

Public Member Functions
	__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
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...

Protected Attributes
array string	$real_filename = ''
	Holds the real template file name. More...

Private Attributes
ILIAS Cache Container Container	$block_cache
ILIAS Cache Container Container	$variable_cache
ILIAS Cache Container Container	$template_cache

Detailed Description

Integrated Template - IT Well there's not much to say about it.

I needed a template class that supports a single template file with multiple (nested) blocks inside and a simple block API. The Isotemplate API is somewhat tricky for a beginner although it is the best one you can build. template::parse() [phplib template = Isotemplate] requests you to name a source and a target where the current block gets parsed into. Source and target can be block names or even handler names. This API gives you a maximum of fexibility but you always have to know what you do which is quite unusual for php skripter like me. I noticed that I do not any control on which block gets parsed into which one. If all blocks are within one file, the script knows how they are nested and in which way you have to parse them. IT knows that inner1 is a child of block2, there's no need to tell him about this.

global (hidden and automatically added)
block1	block2 inner1 inner2

To add content to block1 you simply type: $tpl->setCurrentBlock("block1"); and repeat this as often as needed: $tpl->setVariable(...); $tpl->parseCurrentBlock(); To add content to block2 you would type something like: $tpl->setCurrentBlock("inner1"); $tpl->setVariable(...); $tpl->parseCurrentBlock(); $tpl->setVariable(...); $tpl->parseCurrentBlock(); $tpl->parse("block1"); This will result in one repition of block1 which contains two repitions of inner1. inner2 will be removed if $removeEmptyBlock is set to true which is the default. Usage: $tpl = new HTML_Template_IT( [string filerootdir] ); // load a template or set it with setTemplate() $tpl->loadTemplatefile( string filename [, boolean removeUnknownVariables, boolean removeEmptyBlocks] ) // set "global" Variables meaning variables not beeing within a (inner) block $tpl->setVariable( string variablename, mixed value ); // like with the Isotemplates there's a second way to use setVariable() $tpl->setVariable( array ( string varname => mixed value ) ); // Let's use any block, even a deeply nested one $tpl->setCurrentBlock( string blockname ); // repeat this as often as you need it. $tpl->setVariable( array ( string varname => mixed value ) ); $tpl->parseCurrentBlock(); // get the parsed template or print it: $tpl->show() $tpl->get();

Author

Ulf Wendel uw@ne.nosp@m.tuse.nosp@m..de

Definition at line 118 of file IT.php.

Constructor & Destructor Documentation

__construct()

HTML_Template_IT::__construct	(	string	$root = '',
		?array	$options = null
	)

Builds some complex regular expressions and optinally sets the file root directory.

Make sure that you call this constructor if you derive your template class from this one.

Parameters

string	$root	File root directory, prefix for all filenames given to the object.
	string[]	$options array of options.

Exceptions

ilTemplateException

Definition at line 322 of file IT.php.

References $DIC, setOptions(), and setRoot().

    {
        global $DIC;
        $DIC = $DIC instanceof Container ? $DIC : new Container([]);
        $this->block_cache = $DIC->globalCache()->get(new BlockCache());
        $this->variable_cache = $DIC->globalCache()->get(new VariableCache());
        $this->template_cache = $DIC->globalCache()->get(new TemplateCache());

        if (!is_null($options)) {
            $this->setOptions($options);
        }
        $this->variablesRegExp = '@' . $this->openingDelimiter .
            '(' . $this->variablenameRegExp . ')' .
            $this->closingDelimiter . '@sm';
        $this->removeVariablesRegExp = '@' . $this->openingDelimiter .
            "\s*(" . $this->variablenameRegExp .
            ")\s*" . $this->closingDelimiter . '@sm';

        $this->blockRegExp = '@<!--\s+BEGIN\s+(' . $this->blocknameRegExp .
            ')\s+-->(.*)<!--\s+END\s+\1\s+-->@sm';

        $this->setRoot($root);
    }

Here is the call graph for this function:

Member Function Documentation

_addPregDelimiters()

HTML_Template_IT::_addPregDelimiters

(

string

$str

)

Adds delimiters to a string, so it can be used as a pattern in preg_* functions.

Definition at line 810 of file IT.php.

                                                   : string
    {
        return '@' . $str . '@';
    }

_preserveOpeningDelimiter()

HTML_Template_IT::_preserveOpeningDelimiter

(

string

$str

)

Replaces an opening delimiter by a special string.

Definition at line 818 of file IT.php.

                                                          : string
    {
        return (false === strpos($str, $this->openingDelimiter)) ?
            $str :
            str_replace(
                $this->openingDelimiter,
                $this->openingDelimiter .
                '%preserved%' . $this->closingDelimiter,
                $str
            );
    }

buildBlockvariablelist()

HTML_Template_IT::buildBlockvariablelist

(

)

Build a list of all variables within of a block.

Definition at line 713 of file IT.php.

Referenced by ilTemplate\init(), HTML_Template_ITX\init(), init(), and HTML_Template_ITX\replaceBlock().

                                            : void
    {
        foreach ($this->blocklist as $name => $content) {
            preg_match_all($this->variablesRegExp, $content, $regs);

            if (count($regs[1]) !== 0) {
                foreach ($regs[1] as $var) {
                    $this->blockvariables[$name][$var] = true;
                }
            } else {
                $this->blockvariables[$name] = [];
            }
        }
    }

Here is the caller graph for this function:

errorMessage()

HTML_Template_IT::errorMessage	(	int	$value,
		string	$blockname = ''
	)

Return a textual error message for a IT error code.

Definition at line 833 of file IT.php.

Referenced by findBlocks(), get(), getFile(), parse(), setCurrentBlock(), setOption(), and touchBlock().

                                                                    : string
    {
        static $errorMessages;
        if (!isset($errorMessages)) {
            $errorMessages = [
                self::IT_OK => '',
                self::IT_ERROR => 'unknown error',
                self::IT_TPL_NOT_FOUND => 'Cannot read the template file',
                self::IT_BLOCK_NOT_FOUND => 'Cannot find this block',
                self::IT_BLOCK_DUPLICATE => 'The name of a block must be' .
                    ' uniquewithin a template.' .
                    ' Found "' . $blockname . '" twice.' .
                    'Unpredictable results ' .
                    'may appear.',
                self::IT_UNKNOWN_OPTION => 'Unknown option'
            ];
        }

        return $errorMessages[$value] ?? $errorMessages[self::IT_ERROR];
    }

Here is the caller graph for this function:

findBlocks()

HTML_Template_IT::findBlocks

(

string

$string

)

Recusively builds a list of all blocks within the template.

Exceptions

ilTemplateException

Definition at line 732 of file IT.php.

References $blocklist, and errorMessage().

Referenced by HTML_Template_ITX\addBlock(), ilTemplate\init(), HTML_Template_ITX\init(), init(), and HTML_Template_ITX\replaceBlock().

                                              : array
    {
        $blocklist = [];
        if (preg_match_all($this->blockRegExp, $string, $regs, PREG_SET_ORDER)) {
            foreach ($regs as $match) {
                $blockname = $match[1];
                $blockcontent = $match[2];

                if (isset($this->blocklist[$blockname])) {
                    throw new ilTemplateException($this->errorMessage(self::IT_BLOCK_DUPLICATE, $blockname));
                }

                $this->blocklist[$blockname] = $blockcontent;
                $this->blockdata[$blockname] = "";

                $blocklist[] = $blockname;

                $inner = $this->findBlocks($blockcontent);
                foreach ($inner as $name) {
                    $pattern = sprintf(
                        '@<!--\s+BEGIN\s+%s\s+-->(.*)<!--\s+END\s+%s\s+-->@sm',
                        $name,
                        $name
                    );

                    $this->blocklist[$blockname] = preg_replace(
                        $pattern,
                        $this->openingDelimiter .
                        '__' . $name . '__' .
                        $this->closingDelimiter,
                        $this->blocklist[$blockname]
                    );
                    $this->blockinner[$blockname][] = $name;
                    $this->blockparents[$name] = $blockname;
                }
            }
        }

        return $blocklist;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

free()

HTML_Template_IT::free

(

)

Clears all datafields of the object.

Don't use this function unless you know what you're doing.

Definition at line 623 of file IT.php.

Referenced by ilTemplate\init(), HTML_Template_ITX\init(), and init().

                          : void
    {
        $this->err = [];

        $this->currentBlock = self::IT_DEFAULT_BLOCK;

        $this->variableCache = [];
        $this->blocklist = [];
        $this->touchedBlocks = [];

        $this->flagBlocktrouble = false;
        $this->flagGlobalParsed = false;
    }

Here is the caller graph for this function:

get()

HTML_Template_IT::get

(

string

$block = self::IT_DEFAULT_BLOCK

)

Returns a block with all replacements done.

Exceptions

ilTemplateException

Definition at line 388 of file IT.php.

References errorMessage(), and parse().

                                                             : string
    {
        if ($block === self::IT_DEFAULT_BLOCK && !$this->flagGlobalParsed) {
            $this->parse();
        }

        if (!isset($this->blocklist[$block])) {
            throw new ilTemplateException($this->errorMessage(self::IT_BLOCK_NOT_FOUND) . '"' . $block . "'");
        }

        if (isset($this->blockdata[$block])) {
            $ret = $this->blockdata[$block];
            if ($this->clearCache) {
                unset($this->blockdata[$block]);
            }
            if ($this->_options['preserve_data']) {
                $ret = str_replace(
                    $this->openingDelimiter .
                    '%preserved%' . $this->closingDelimiter,
                    $this->openingDelimiter,
                    $ret
                );
            }
            return $ret;
        }

        return '';
    }

Here is the call graph for this function:

getFile()

HTML_Template_IT::getFile

(

string

$filename

)

Reads a file from disk and returns its content.

Exceptions

ilTemplateException

Definition at line 777 of file IT.php.

References $filename, errorMessage(), and null.

Referenced by ilTemplate\addBlockFile(), HTML_Template_ITX\addBlockfile(), ilTemplate\loadTemplatefile(), and loadTemplatefile().

                                             : string
    {
        if ($filename[0] === '/' && substr($this->fileRoot, -1) === '/') {
            $filename = substr($filename, 1);
        }

        $filename = $this->fileRoot . $filename;

        $this->real_filename = $filename;

        if (($content = $this->template_cache->get($filename, new StringTransformation())) === null) {
            if (!($fh = @fopen($filename, 'rb'))) {
                throw new ilTemplateException($this->errorMessage(self::IT_TPL_NOT_FOUND) . ': "' . $filename . '"');
            }

            $fsize = filesize($filename);
            if ($fsize < 1) {
                fclose($fh);
                return '';
            }

            $content = fread($fh, $fsize);
            $this->template_cache->set($filename, $content);
            fclose($fh);
        }

        return $content;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

init()

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

Definition at line 594 of file IT.php.

References $blockdata, $blocklist, $blockvariables, buildBlockvariablelist(), findBlocks(), free(), and null.

Referenced by setTemplate().

                             : void
    {
        $this->free();

        if (($blockdata = $this->block_cache->get($this->real_filename, new ListTransformation(new StringTransformation()))) !== null) {
            $this->blockdata = $blockdata['blockdata'];
            $this->blocklist = $blockdata['blocklist'];
        } else {
            $this->findBlocks($this->template);
            $blockdata['blockdata'] = $this->blockdata;
            $blockdata['blocklist'] = $this->blocklist;
            $this->block_cache->set($this->real_filename, $blockdata);
        }

        // we don't need it any more
        $this->template = '';

        if (($blockvariables = $this->variable_cache->get($this->real_filename))!==null) {
            $this->blockvariables = $blockvariables;
        } else {
            $this->buildBlockvariablelist();
            $this->variable_cache->set($this->real_filename, $this->blockvariables);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadTemplatefile()

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

Reads a template file from the disk.

Exceptions

ilTemplateException

Definition at line 675 of file IT.php.

References $filename, getFile(), and setTemplate().

Referenced by ilIndependantTemplate\loadTemplatefile().

     : bool {
        $template = '';
        if (!$this->flagCacheTemplatefile ||
            $this->lastTemplatefile !== $filename
        ) {
            $template = $this->getFile($filename);
        }
        $this->lastTemplatefile = $filename;

        return $template !== '' && $this->setTemplate(
            $template,
            $removeUnknownVariables,
            $removeEmptyBlocks
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parse()

HTML_Template_IT::parse	(	string	$block = self::IT_DEFAULT_BLOCK,
		bool	$flag_recursion = false
	)

Parses the given block.

Parameters

string

name of the block to be parsed public

Exceptions

ilTemplateException

See also

parseCurrentBlock()

Definition at line 424 of file IT.php.

References $closingDelimiter, and errorMessage().

Referenced by get(), and parseCurrentBlock().

                                                                                             : bool
    {
        static $regs, $values;

        if (!isset($this->blocklist[$block])) {
            throw new ilTemplateException($this->errorMessage(self::IT_BLOCK_NOT_FOUND) . '"' . $block . "'");
        }

        if (self::IT_DEFAULT_BLOCK === $block) {
            $this->flagGlobalParsed = true;
        }

        if (!$flag_recursion) {
            $regs = [];
            $values = [];
        }
        $outer = $this->blocklist[$block];
        $empty = true;

        if ($this->clearCacheOnParse) {
            foreach ($this->variableCache as $name => $value) {
                $regs[] = $this->openingDelimiter .
                    $name . $this->closingDelimiter;
                $values[] = $value;
                $empty = false;
            }
            $this->variableCache = [];
        } else {
            foreach ($this->blockvariables[$block] as $allowedvar => $v) {
                if (isset($this->variableCache[$allowedvar])) {
                    $regs[] = $this->openingDelimiter .
                        $allowedvar . $this->closingDelimiter;
                    $values[] = $this->variableCache[$allowedvar];
                    unset($this->variableCache[$allowedvar]);
                    $empty = false;
                }
            }
        }

        if (isset($this->blockinner[$block])) {
            foreach ($this->blockinner[$block] as $k => $innerblock) {
                $this->parse($innerblock, true);
                if ($this->blockdata[$innerblock] !== '') {
                    $empty = false;
                }

                $placeholder = $this->openingDelimiter . "__" .
                    $innerblock . "__" . $this->closingDelimiter;
                $outer = str_replace(
                    $placeholder,
                    $this->blockdata[$innerblock],
                    $outer
                );
                $this->blockdata[$innerblock] = "";
            }
        }

        if (!$flag_recursion && 0 !== count($values)) {
            if ($this->_options['use_preg']) {
                $regs = array_map(
                    [
                        &$this,
                        '_addPregDelimiters'
                    ],
                    $regs
                );
                $funcReplace = 'preg_replace';
            } else {
                $funcReplace = 'str_replace';
            }

            if ($this->_options['preserve_data']) {
                $values = array_map(
                    [&$this, '_preserveOpeningDelimiter'],
                    $values
                );
            }

            $outer = $funcReplace($regs, $values, $outer);

            if ($this->removeUnknownVariables) {
                $outer = preg_replace($this->removeVariablesRegExp, "", $outer);
            }
        }

        if ($empty) {
            if (!$this->removeEmptyBlocks) {
                $this->blockdata[$block] .= $outer;
            } elseif (isset($this->touchedBlocks[$block])) {
                $this->blockdata[$block] .= $outer;
                unset($this->touchedBlocks[$block]);
            }
        } elseif (empty($this->blockdata[$block])) {
            $this->blockdata[$block] = $outer;
        } else {
            $this->blockdata[$block] .= $outer;
        }

        return $empty;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseCurrentBlock()

HTML_Template_IT::parseCurrentBlock

(

)

Parses the current block.

Exceptions

ilTemplateException

Definition at line 529 of file IT.php.

References parse().

Referenced by ilTemplate\touchBlock().

                                       : bool
    {
        return $this->parse($this->currentBlock);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCurrentBlock()

HTML_Template_IT::setCurrentBlock

(

string

$block = self::IT_DEFAULT_BLOCK

)

Sets the name of the current block that is the block where variables are added.

Exceptions

ilTemplateException

Definition at line 561 of file IT.php.

References errorMessage().

                                                                         : bool
    {
        if (!isset($this->blocklist[$block])) {
            throw new ilTemplateException($this->errorMessage(self::IT_BLOCK_NOT_FOUND) . '"' . $block . "'");
        }

        $this->currentBlock = $block;

        return true;
    }

Here is the call graph for this function:

setOption()

HTML_Template_IT::setOption	(	string	$option,
			$value
	)

Sets the option for the template class.

Parameters

mixed

$value

Exceptions

ilTemplateException

Definition at line 351 of file IT.php.

References errorMessage().

Referenced by ilTemplate\__construct(), and setOptions().

                                                     : int
    {
        if (array_key_exists($option, $this->_options)) {
            $this->_options[$option] = $value;
            return self::IT_OK;
        }

        throw new ilTemplateException($this->errorMessage(self::IT_UNKNOWN_OPTION) . ": '$option'");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setOptions()

HTML_Template_IT::setOptions

(

array

$options

)

Sets the options for the template class.

Parameters

string[]

$options

Exceptions

ilTemplateException

Definition at line 366 of file IT.php.

References setOption().

Referenced by __construct().

                                              : int
    {
        foreach ($options as $option => $value) {
            $this->setOption($option, $value);
        }

        return self::IT_OK;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setRoot()

HTML_Template_IT::setRoot

(

string

$root

)

Sets the file root.

The file root gets prefixed to all filenames passed to the object. Make sure that you override this function when using the class on windows.

Definition at line 701 of file IT.php.

Referenced by __construct().

                                         : void
    {
        if ($root !== '' && substr($root, -1) !== '/') {
            $root .= '/';
        }

        $this->fileRoot = $root;
    }

Here is the caller graph for this function:

setTemplate()

HTML_Template_IT::setTemplate	(	string	$template,
		bool	$removeUnknownVariables = true,
		bool	$removeEmptyBlocks = true
	)

Sets the template.

You can eighter load a template file from disk with LoadTemplatefile() or set the template manually using this function.

Exceptions

ilTemplateException

Definition at line 643 of file IT.php.

References $removeEmptyBlocks, $removeUnknownVariables, and init().

Referenced by ilTemplate\loadTemplatefile(), and loadTemplatefile().

     : bool {
        $this->removeUnknownVariables = $removeUnknownVariables;
        $this->removeEmptyBlocks = $removeEmptyBlocks;

        if ($template === '' && $this->flagCacheTemplatefile) {
            $this->variableCache = [];
            $this->blockdata = [];
            $this->touchedBlocks = [];
            $this->currentBlock = self::IT_DEFAULT_BLOCK;
        } else {
            $this->template =
                '<!-- BEGIN ' . self::IT_DEFAULT_BLOCK . ' -->' .
                $template .
                '<!-- END ' . self::IT_DEFAULT_BLOCK . ' -->';
            $this->init();
        }

        if ($this->flagBlocktrouble) {
            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setVariable()

HTML_Template_IT::setVariable	(		$variable,
			$value = ''
	)

Sets a variable value.

The function can be used eighter like setVariable( "varname", "value") or with one array $variables["varname"] = "value" given setVariable($variables) quite like phplib templates set_var().

Parameters

string | array	$variable	string with the variable name or an array variables["varname"] = "value"
mixed	$value	value of the variable or empty if $variable is an array.

Definition at line 544 of file IT.php.

Referenced by ilContainerRenderer\addHeaderRow(), ilContainerGUI\addHeaderRow(), ilContainerGUI\addMessageRow(), ilMiniCalendarGUI\addMiniMonth(), ilCalendarBlockGUI\addMiniMonth(), ILIAS\Test\Questions\Presentation\Printer\addQuestionResultForTestUsersToTemplate(), ILIAS\Test\Questions\Presentation\Printer\addResultUserInfoToTemplate(), ilExerciseGSToolProvider\addSection(), ilContainerRenderer\addStandardRow(), ilCalendarBlockGUI\addSubscriptionButton(), ILIAS\Survey\Mode\AbstractUIModifier\buildExportButtonAndModal(), ilTimingsCronReminder\buildMailSalutation(), ilRecurrenceInputGUI\buildMonthlyByDaySelection(), ilRecurrenceInputGUI\buildMonthlyByMonthDaySelection(), ilRecurrenceInputGUI\buildUntilSelection(), ilRecurrenceInputGUI\buildWeekDaySelection(), ilRecurrenceInputGUI\buildYearlyByDaySelection(), ilRecurrenceInputGUI\buildYearlyByMonthDaySelection(), ilKprimChoiceCorrectionsInputGUI\checkInput(), ilTimingsCronReminder\fillObjectListForMailBody(), ilStudyProgrammeProgressListGUI\fillTemplate(), ilStudyProgrammeExpandableProgressListGUI\fillTemplate(), ilTemplate\fillVars(), ilSCORMExplorer\formatHeader(), ilContainerSelectionExplorer\formatHeader(), ilSearchRootSelector\formatHeader(), ilECSNodeMappingLocalExplorer\formatHeader(), ilECSNodeMappingCmsExplorer\formatHeader(), ilPasteIntoMultipleItemsExplorer\formatHeader(), ilRepositoryExplorer\formatHeader(), ilECSNodeMappingLocalExplorer\formatObject(), ilPasteIntoMultipleItemsExplorer\formatObject(), ilExplorer\formatObject(), ilCalendarViewGUI\getContentByPlugins(), ilAbstractLearningHistoryProvider\getEmphasizedTitle(), ilRepositoryObjectSearchBlockGUI\getLegacyContent(), ilWikiFunctionsBlockGUI\getLegacyContent(), ilCalendarSelectionBlockGUI\getLegacyContent(), ilSCORMExplorer\getOutputIcons(), ilMailFormAttachmentPropertyGUI\insert(), ilAssLongmenuCorrectionsInputGUI\insert(), ilAssClozeTestCombinationVariantsInputGUI\insert(), ilAssSingleChoiceCorrectionsInputGUI\insert(), ilAssErrorTextCorrectionsInputGUI\insert(), ilOrgUnitAuthorityInputGUI\insert(), ilAssAnswerCorrectionsInputGUI\insert(), ilCustomInputGUI\insert(), ilHiddenInputGUI\insert(), ilAssMultipleChoiceCorrectionsInputGUI\insert(), ilAssMatchingPairCorrectionsInputGUI\insert(), ilImagemapCorrectionsInputGUI\insert(), ilEssayKeywordWizardInputGUI\insert(), ilFontSizeInputGUI\insert(), ilBackgroundImageInputGUI\insert(), ilNumericStyleValueInputGUI\insert(), ilManualPlaceholderInputGUI\insert(), ilRadioGroupInputGUI\insert(), ilFormSectionHeaderGUI\insert(), ilTextWizardInputGUI\insert(), ilWidthHeightInputGUI\insert(), ilSelectBuilderInputGUI\insert(), ilEMailInputGUI\insert(), ilImageFileInputGUI\insert(), ilUserLoginInputGUI\insert(), ilLocationInputGUI\insert(), ilNestedListInputGUI\insert(), ilCheckboxGroupInputGUI\insert(), ilAdvSelectInputGUI\insert(), ilBackgroundPositionInputGUI\insert(), ilTRBLBorderStyleInputGUI\insert(), ilKprimChoiceWizardInputGUI\insert(), ilNonEditableValueGUI\insert(), ilCheckboxInputGUI\insert(), ilMatrixRowWizardInputGUI\insert(), ilTRBLBorderWidthInputGUI\insert(), ilTRBLNumericStyleValueInputGUI\insert(), ilChatroomAuthInputGUI\insert(), ilDurationInputGUI\insert(), ilTagInputGUI\insert(), ilFileWizardInputGUI\insert(), ilTRBLColorPickerInputGUI\insert(), ilMatchingPairWizardInputGUI\insert(), ilColorPickerInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilCSSRectInputGUI\insert(), ilMultiSelectInputGUI\insert(), ilCombinationInputGUI\insert(), ilSelectInputGUI\insert(), ilScheduleInputGUI\insert(), ilRepositorySelectorInputGUI\insert(), ilExplorerSelectInputGUI\insert(), ilErrorTextWizardInputGUI\insert(), ilDateTimeInputGUI\insert(), ilNumberInputGUI\insert(), ilAnswerWizardInputGUI\insert(), ilRecurrenceInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilCategoryWizardInputGUI\insert(), ilImagemapFileInputGUI\insert(), ilPasswordInputGUI\insert(), ilTextAreaInputGUI\insert(), ilDclGenericMultiInputGUI\insert(), ilOrgUnitGenericMultiInputGUI\insert(), ilFileInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), ilTextInputGUI\insert(), ilDateDurationInputGUI\insert(), ilLinkInputGUI\insert(), ilPCParagraphGUI\insertCharacteristicTable(), ilPCParagraphGUI\insertHelp(), ilSCORMExplorer\insertObject(), ilNestedList\listItemStart(), ilExplorerBaseGUI\listItemStart(), ilNestedList\listStart(), ilSurveyExecutionGUI\outNavigationButtons(), SurveyMetricQuestion\outPreconditionSelectValue(), ilFileInputGUI\outputSuffixes(), SurveyQuestionGUI\outQuestionText(), assMatchingQuestionGUI\populateAssignedTerms(), ilAssQuestionPreviewGUI\populateCommentsPanel(), assMatchingQuestionGUI\populateDefinition(), ilTestServiceGUI\populateExamId(), ilAssQuestionPreviewGUI\populateGenericQuestionFeedback(), ilAssQuestionPreviewGUI\populateInstantResponseHeader(), ilAssQuestionPreviewGUI\populateInstantResponseMessage(), ilTestServiceGUI\populatePassFinishDate(), ilAssQuestionPreviewGUI\populateQuestionOutput(), ilAssQuestionPreviewGUI\populateReachedPointsOutput(), ilAssQuestionPreviewGUI\populateSolutionOutput(), ilAssQuestionPreviewGUI\populateSpecificQuestionFeedback(), ilPollAnswersRenderer\render(), ILIAS\Exercise\Assignment\PanelBuilderUI\renderActionButton(), ilTestQuestionNavigationGUI\renderActionsIcon(), ilPollContentRenderer\renderAlertForAnonymousUser(), ilPollContentRenderer\renderAnchor(), ilPollContentRenderer\renderAnonimityInfo(), ilPollAnswersRenderer\renderAnswer(), ilPollContentRenderer\renderAvailability(), ilPollResultsRenderer\renderBarChart(), ilTestQuestionNavigationGUI\renderButtonInstance(), ilExplorerBaseGUI\renderChilds(), ilPollContentRenderer\renderComments(), ilAssLacLegendGUI\renderCommonLegendPart(), ilNewsTimelineGUI\renderDeleteModal(), ilPollContentRenderer\renderDescription(), ilContainerRenderer\renderDetails(), ilObjForumGUI\renderDraftContent(), ilNewsTimelineGUI\renderEditModal(), ilAssLacLegendGUI\renderExample(), ilContainerRenderer\renderHelperGeneric(), ilCalendarSelectionBlockGUI\renderItem(), ILIAS\Chatroom\BuildChat\renderLanguageVariables(), ILIAS\Exercise\Assignment\PanelBuilderUI\renderLinkList(), ilPollContentRenderer\renderMiscVoteInfo(), ilNestedList\renderNode(), ilExplorerBaseGUI\renderNode(), ilPollContentRenderer\renderNoQuestionMessage(), ilPollContentRenderer\renderNotAbleToVoteMessage(), ilPollContentRenderer\renderNotWithinVotingPeriodMessage(), ilObjForumGUI\renderPostContent(), ilObjForumGUI\renderPostingForm(), ilPollContentRenderer\renderQuestion(), ilAssLacLegendGUI\renderQuestSpecificExamples(), ilAssLacLegendGUI\renderQuestSpecificLegendPart(), ilChatroomViewGUI\renderRightUsersBlock(), ilContainerRenderer\renderSelectAllBlock(), ilChatroomViewGUI\renderSendMessageBox(), ilObjForumGUI\renderSplitButton(), ilPollResultsRenderer\renderStackedChart(), ilPollContentRenderer\renderTotalParticipantsInfo(), ilClozeGapInputBuilderGUI\setValueByArray(), ilPDNewsBlockGUI\showFeedUrl(), ilNewsForContextBlockGUI\showFeedUrl(), ilInfoScreenGUI\showLearningProgress(), and ilNewsForContextBlockGUI\showNews().

                                                       : void
    {
        if (is_array($variable)) {
            $this->variableCache = array_merge(
                $this->variableCache,
                $variable
            );
        } else {
            $this->variableCache[$variable] = $value;
        }
    }

Here is the caller graph for this function:

show()

HTML_Template_IT::show

(

string

$block = self::IT_DEFAULT_BLOCK

)

Print a certain block with all replacements done.

Exceptions

ilTemplateException

Definition at line 379 of file IT.php.

                                                              : void
    {
        print $this->get($block);
    }

touchBlock()

HTML_Template_IT::touchBlock

(

string

$block

)

Preserves an empty block even if removeEmptyBlocks is true.

Exceptions

ilTemplateException

Definition at line 576 of file IT.php.

References errorMessage().

                                             : bool
    {
        if (!isset($this->blocklist[$block])) {
            throw new ilTemplateException($this->errorMessage(self::IT_BLOCK_NOT_FOUND) . '"' . $block . "'");
        }

        $this->touchedBlocks[$block] = true;

        return true;
    }

Here is the call graph for this function:

Field Documentation

$_options

array HTML_Template_IT::$_options

Initial value:

= [
        'preserve_data' => false

$_options['preserve_data'] Whether to substitute variables and remove empty placeholders in data passed through setVariable (see also bugs #20199, #21951).

$_options['use_preg'] Whether to use preg_replace instead of str_replace in parse() (this is a backwards compatibility feature, see also bugs #21951, #20392)

Definition at line 303 of file IT.php.

$block_cache

ILIAS Cache Container Container HTML_Template_IT::$block_cache

private

Definition at line 127 of file IT.php.

$blockdata

array HTML_Template_IT::$blockdata = []

Array with the parsed content of a block.

Definition at line 209 of file IT.php.

Referenced by ilTemplate\init(), init(), and HTML_Template_ITX\replaceBlock().

$blockinner

array HTML_Template_IT::$blockinner = []

Array of inner blocks of a block.

Definition at line 224 of file IT.php.

Referenced by ilTemplate\init().

$blocklist

array HTML_Template_IT::$blocklist = []

Array of all blocks and their content.

Definition at line 204 of file IT.php.

Referenced by findBlocks(), ilTemplate\init(), and init().

$blocknameRegExp

string HTML_Template_IT::$blocknameRegExp = '[\.0-9A-Za-z_-]+'

RegExp matching a block in the template.

Per default "sm" is used as the regexp modifier, "i" is missing. That means a case sensitive search is done.

Definition at line 156 of file IT.php.

$blockparents

array HTML_Template_IT::$blockparents = []

Array of block parents.

Definition at line 219 of file IT.php.

Referenced by ilTemplate\init().

$blockRegExp

string HTML_Template_IT::$blockRegExp = ''

RegExp used to find blocks an their content, filled by the constructor.

Definition at line 189 of file IT.php.

$blockvariables

array HTML_Template_IT::$blockvariables = []

Array of variables in a block.

Definition at line 214 of file IT.php.

Referenced by ilTemplate\init(), and init().

$clearCache

bool HTML_Template_IT::$clearCache = false

Clear cache on get()?

Definition at line 139 of file IT.php.

$clearCacheOnParse

bool HTML_Template_IT::$clearCacheOnParse = false

Clear the variable cache on parse? If you're not an expert just leave the default false.

True reduces memory consumption somewhat if you tend to add lots of values for unknown placeholder.

Definition at line 261 of file IT.php.

$closingDelimiter

string HTML_Template_IT::$closingDelimiter = '}'

Last character of a variable placeholder ( {VARIABLE_}_ ).

Definition at line 149 of file IT.php.

Referenced by HTML_Template_ITX\buildFunctionlist(), and parse().

$currentBlock

string HTML_Template_IT::$currentBlock = self::IT_DEFAULT_BLOCK

Name of the current block.

Definition at line 194 of file IT.php.

$err

array HTML_Template_IT::$err = []

Contains the error objects.

Definition at line 134 of file IT.php.

Referenced by ilTemplate\init().

$fileRoot

string HTML_Template_IT::$fileRoot = ''

Root directory for all file operations.

The string gets prefixed to all filenames given.

Definition at line 267 of file IT.php.

$flagBlocktrouble

bool HTML_Template_IT::$flagBlocktrouble = false

Internal flag indicating that a blockname was used multiple times.

Definition at line 272 of file IT.php.

Referenced by ilTemplate\init().

$flagCacheTemplatefile

bool HTML_Template_IT::$flagCacheTemplatefile = true

EXPERIMENTAL! FIXME! Flag indication that a template gets cached.

Complex templates require some times to be preparsed before the replacement can take place. Often I use one template file over and over again but I don't know before that I will use the same template file again. Now IT could notice this and skip the preparse.

Definition at line 288 of file IT.php.

$flagGlobalParsed

bool HTML_Template_IT::$flagGlobalParsed = false

Flag indicating that the global block was parsed.

Definition at line 277 of file IT.php.

$lastTemplatefile

string HTML_Template_IT::$lastTemplatefile = ''

EXPERIMENTAL! FIXME!

Definition at line 293 of file IT.php.

$openingDelimiter

string HTML_Template_IT::$openingDelimiter = '{'

First character of a variable placeholder ( _{_VARIABLE} ).

Definition at line 144 of file IT.php.

$real_filename

array string HTML_Template_IT::$real_filename = ''

protected

Holds the real template file name.

Definition at line 311 of file IT.php.

$removeEmptyBlocks

bool HTML_Template_IT::$removeEmptyBlocks = true

Controls the handling of empty blocks, default is remove.

Definition at line 184 of file IT.php.

Referenced by ilTemplate\loadTemplatefile(), and setTemplate().

$removeUnknownVariables

bool HTML_Template_IT::$removeUnknownVariables = true

Controls the handling of unknown variables, default is remove.

Definition at line 179 of file IT.php.

Referenced by ilTemplate\loadTemplatefile(), and setTemplate().

$removeVariablesRegExp

string HTML_Template_IT::$removeVariablesRegExp = ''

RegExp used to strip unused variable placeholder.

Definition at line 174 of file IT.php.

$template

string HTML_Template_IT::$template = ''

Content of the template.

Definition at line 199 of file IT.php.

Referenced by ilTemplate\addBlockFile(), HTML_Template_ITX\buildFunctionlist(), and ilTemplate\loadTemplatefile().

$template_cache

ILIAS Cache Container Container HTML_Template_IT::$template_cache

private

Definition at line 129 of file IT.php.

$touchedBlocks

array HTML_Template_IT::$touchedBlocks = []

List of blocks to preverse even if they are "empty".

This is something special. Sometimes you have blocks that should be preserved although they are empty (no placeholder replaced). Think of a shopping basket. If it's empty you have to drop a message to the user. If it's filled you have to show the contents of the shopping baseket. Now where do you place the message that the basket is empty? It's no good idea to place it in you applications as customers tend to like unecessary minor text changes. Having another template file for an empty basket means that it's very likely that one fine day the filled and empty basket templates have different layout. I decided to introduce blocks that to not contain any placeholder but only text such as the message "Your shopping basked is empty". Now if there is no replacement done in such a block the block will be recognized as "empty" and by default ($removeEmptyBlocks = true) be stripped off. To avoid thisyou can now call touchBlock() to avoid this. The array $touchedBlocks stores a list of touched block which must not be removed even if they are empty.

Definition at line 245 of file IT.php.

$variable_cache

ILIAS Cache Container Container HTML_Template_IT::$variable_cache

private

Definition at line 128 of file IT.php.

$variableCache

array HTML_Template_IT::$variableCache = []

Variable cache.

Variables get cached before any replacement is done. Advantage: empty blocks can be removed automatically. Disadvantage: might take some more memory

Definition at line 253 of file IT.php.

$variablenameRegExp

string HTML_Template_IT::$variablenameRegExp = '[\.0-9A-Za-z_-]+'

RegExp matching a variable placeholder in the template.

Per default "sm" is used as the regexp modifier, "i" is missing. That means a case sensitive search is done.

Definition at line 163 of file IT.php.

$variablesRegExp

string HTML_Template_IT::$variablesRegExp = ''

RegExp used to find variable placeholder, filled by the constructor.

Looks somewhat like @(delimiter varname delimiter).

Definition at line 169 of file IT.php.

IT_BLOCK_DUPLICATE

const HTML_Template_IT::IT_BLOCK_DUPLICATE = -4

Definition at line 124 of file IT.php.

IT_BLOCK_NOT_FOUND

const HTML_Template_IT::IT_BLOCK_NOT_FOUND = -3

Definition at line 123 of file IT.php.

IT_DEFAULT_BLOCK

const HTML_Template_IT::IT_DEFAULT_BLOCK = '__global__'

Definition at line 126 of file IT.php.

Referenced by ilTemplate\__construct().

IT_ERROR

const HTML_Template_IT::IT_ERROR = -1

Definition at line 121 of file IT.php.

IT_OK

const HTML_Template_IT::IT_OK = 1

Definition at line 120 of file IT.php.

IT_TPL_NOT_FOUND

const HTML_Template_IT::IT_TPL_NOT_FOUND = -2

Definition at line 122 of file IT.php.

IT_UNKNOWN_OPTION

const HTML_Template_IT::IT_UNKNOWN_OPTION = -6

Definition at line 125 of file IT.php.

---

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

• components/ILIAS/UICore/lib/html-it/IT.php