Inheritance diagram for HTML_Template_IT:

Collaboration diagram for HTML_Template_IT:

Public Member Functions
	__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
	$err = array()

	$clearCache = false

	$openingDelimiter = '{'

	$closingDelimiter = '}'

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

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

	$variablesRegExp = ''

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

	$removeUnknownVariables = true

	$removeEmptyBlocks = true

	$blockRegExp = ''

	$currentBlock = '__global__'

	$template = ''

	$blocklist = array()

	$blockdata = array()

	$blockvariables = array()

	$blockparents = array()

	$blockinner = array()

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

	$_hiddenBlocks = array()
	List of blocks which should not be shown even if not "empty". More...

	$variableCache = array()

	$clearCacheOnParse = false

	$fileRoot = ''

	$flagBlocktrouble = false

	$flagGlobalParsed = false

	$flagCacheTemplatefile = true

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

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

Protected Member Functions
	init ()
	Clears all datafields of the object and rebuild the internal blocklist. More...

Detailed Description

Definition at line 124 of file IT.php.

Constructor & Destructor Documentation

◆ __construct()

HTML_Template_IT::__construct	(	$root = `''`,
		$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 File root directory, prefix for all filenames given to the object.

See also: setRoot()

Definition at line 372 of file IT.php.

References setOptions(), and setRoot().

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

Here is the call graph for this function:

Member Function Documentation

◆ _addPregDelimiters()

HTML_Template_IT::_addPregDelimiters ( $str )

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

Parameters

string

Returns: string

Definition at line 962 of file IT.php.

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

◆ _preserveOpeningDelimiter()

HTML_Template_IT::_preserveOpeningDelimiter ( $str )

Replaces an opening delimiter by a special string.

Parameters

string

Returns: string

Definition at line 973 of file IT.php.

     {
         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 824 of file IT.php.

References $name.

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

     {
         foreach ($this->blocklist as $name => $content) {
             preg_match_all($this->variablesRegExp, $content, $regs);
 
             if (count($regs[1]) != 0) {
                 foreach ($regs[1] as $k => $var) {
                     $this->blockvariables[$name][$var] = true;
                 }
             } else {
                 $this->blockvariables[$name] = array();
             }
         }
     } // end func buildBlockvariablelist

Here is the caller graph for this function:

◆ errorMessage()

HTML_Template_IT::errorMessage	(	$value,
		$blockname = `''`
	)

Return a textual error message for a IT error code.

Parameters

integer $value error code

Returns: string error message, or false if the error code was not recognized

Definition at line 993 of file IT.php.

References IT_BLOCK_DUPLICATE, IT_BLOCK_NOT_FOUND, IT_ERROR, IT_OK, IT_TPL_NOT_FOUND, and IT_UNKNOWN_OPTION.

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

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

Here is the caller graph for this function:

◆ findBlocks()

HTML_Template_IT::findBlocks ( $string )

Recusively builds a list of all blocks within the template.

Parameters

string string that gets scanned

See also: $blocklist

Definition at line 865 of file IT.php.

References $blocklist, $name, errorMessage(), and IT_BLOCK_DUPLICATE.

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

     {
         $blocklist = array();
         if (preg_match_all($this->blockRegExp, $string, $regs, PREG_SET_ORDER)) {
             foreach ($regs as $k => $match) {
                 $blockname = $match[1];
                 $blockcontent = $match[2];
 
                 if (isset($this->blocklist[$blockname])) {
                     throw (new ilTemplateException($this->errorMessage(
                         IT_BLOCK_DUPLICATE,
                         $blockname
                     )));
                 }
 
                 $this->blocklist[$blockname] = $blockcontent;
                 $this->blockdata[$blockname] = "";
 
                 $blocklist[] = $blockname;
 
                 $inner = $this->findBlocks($blockcontent);
                 foreach ($inner as $k => $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;
     } // end func findBlocks

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.

public

See also: init()

Definition at line 716 of file IT.php.

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

     {
         $this->err = array();
 
         $this->currentBlock = '__global__';
 
         $this->variableCache = array();
         $this->blocklist = array();
         $this->touchedBlocks = array();
 
         $this->flagBlocktrouble = false;
         $this->flagGlobalParsed = false;
     } // end func free

Here is the caller graph for this function:

◆ get()

HTML_Template_IT::get ( $block = '__global__' )

Returns a block with all replacements done.

Parameters

string name of the block

Returns: string

Exceptions

ilTemplateException public

See also: show()

Definition at line 449 of file IT.php.

References $ret, errorMessage(), IT_BLOCK_NOT_FOUND, and parse().

     {
         if ($block == '__global__' && !$this->flagGlobalParsed) {
             $this->parse('__global__');
         }
 
         if (!isset($this->blocklist[$block])) {
             throw (new ilTemplateException($this->errorMessage(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 '';
     } // end func get()

Here is the call graph for this function:

◆ getFile()

HTML_Template_IT::getFile ( $filename )

Reads a file from disk and returns its content.

Parameters

string Filename

Returns: string Filecontent

Definition at line 914 of file IT.php.

References $filename, ilGlobalCache\COMP_TEMPLATE, errorMessage(), ilGlobalCache\getInstance(), and IT_TPL_NOT_FOUND.

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

     {
         if ($filename[0] == '/' && substr($this->fileRoot, -1) == '/') {
             $filename = substr($filename, 1);
         }
 
         $filename = $this->fileRoot . $filename;
 
         require_once('./Services/GlobalCache/classes/class.ilGlobalCache.php');
         $this->real_filename = $filename;
         $ilGlobalCache = ilGlobalCache::getInstance(ilGlobalCache::COMP_TEMPLATE);
         if (!$content = $ilGlobalCache->get($filename)) {
             if (!($fh = @fopen($filename, 'r'))) {
                 throw (new ilTemplateException($this->errorMessage(IT_TPL_NOT_FOUND) .
                     ': "' . $filename . '"'));
             }
 
             $fsize = filesize($filename);
             if ($fsize < 1) {
                 fclose($fh);
                 return '';
             }
 
             $content = fread($fh, $fsize);
             $ilGlobalCache->set($filename, $content, 60);
             fclose($fh);
         }
 
 
         /* performance patch, 6.4.2017
         return preg_replace_callback(
             "#<!-- INCLUDE (.*) -->#im",
             function ($hit) {
                 return $this->getFile($hit[1]);
             },
             $content
         );*/
 
         return $content;
     } // end func getFile

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGlobalvariables()

HTML_Template_IT::getGlobalvariables ( )

Returns a list of all global variables.

Definition at line 842 of file IT.php.

     {
         $regs = array();
         $values = array();
 
         foreach ($this->blockvariables['__global__'] as $allowedvar => $v) {
             if (isset($this->variableCache[$allowedvar])) {
                 $regs[] = '@' . $this->openingDelimiter .
                             $allowedvar . $this->closingDelimiter . '@';
                 $values[] = $this->variableCache[$allowedvar];
                 unset($this->variableCache[$allowedvar]);
             }
         }
 
         return array($regs, $values);
     } // end func getGlobalvariables

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

public

See also: free()

Definition at line 679 of file IT.php.

References $blockdata, $blocklist, $blockvariables, buildBlockvariablelist(), ilGlobalCache\COMP_TPL_BLOCKS, ilGlobalCache\COMP_TPL_VARIABLES, findBlocks(), free(), ilGlobalCache\getInstance(), ilGlobalCache\log(), and ilGlobalCacheSettings\LOG_LEVEL_FORCED.

Referenced by setTemplate().

     {
         $this->free();
         require_once('./Services/GlobalCache/classes/class.ilGlobalCache.php');
         $blocks = ilGlobalCache::getInstance(ilGlobalCache::COMP_TPL_BLOCKS);
 
         if ($blockdata = $blocks->get($this->real_filename)) {
             $this->blockdata = $blockdata['blockdata'];
             $this->blocklist = $blockdata['blocklist'];
         } else {
             ilGlobalCache::log('have to build blocks...', ilGlobalCacheSettings::LOG_LEVEL_FORCED);
             $this->findBlocks($this->template);
             $blockdata['blockdata'] = $this->blockdata;
             $blockdata['blocklist'] = $this->blocklist;
             $blocks->set($this->real_filename, $blockdata, 60);
         }
 
         // we don't need it any more
         $this->template = '';
 
         $variables = ilGlobalCache::getInstance(ilGlobalCache::COMP_TPL_VARIABLES);
         if ($blockvariables = $variables->get($this->real_filename)) {
             $this->blockvariables = $blockvariables;
         } else {
             $this->buildBlockvariablelist();
             $variables->set($this->real_filename, $this->blockvariables, 60);
         }
     } // end func init

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadTemplatefile()

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

Reads a template file from the disk.

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 780 of file IT.php.

References $filename, $removeEmptyBlocks, $removeUnknownVariables, $template, getFile(), and setTemplate().

Referenced by ilIndependantTemplate\loadTemplatefile().

       {
         $template = '';
         if (!$this->flagCacheTemplatefile ||
             $this->lastTemplatefile != $filename
         ) {
             $template = $this->getFile($filename);
         }
         $this->lastTemplatefile = $filename;
 
         return $template != '' ?
                 $this->setTemplate(
                     $template,
                     $removeUnknownVariables,
                     $removeEmptyBlocks
                     ) : false;
     } // end func LoadTemplatefile

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse()

HTML_Template_IT::parse	(	$block = `'__global__'`,
		$flag_recursion = `false`
	)

Parses the given block.

Parameters

string name of the block to be parsed public

See also: parseCurrentBlock()

Exceptions

ilTemplateException

Definition at line 487 of file IT.php.

References $closingDelimiter, $name, errorMessage(), and IT_BLOCK_NOT_FOUND.

Referenced by get(), and parseCurrentBlock().

     {
         static $regs, $values;
 
         if (!isset($this->blocklist[$block])) {
             throw (new ilTemplateException($this->errorMessage(IT_BLOCK_NOT_FOUND) .
                 '"' . $block . "'"));
         }
 
         if ($block == '__global__') {
             $this->flagGlobalParsed = true;
         }
 
         if (!$flag_recursion) {
             $regs = array();
             $values = array();
         }
         $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 = array();
         } 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(
                     array(
                                     &$this, '_addPregDelimiters'),
                     $regs
                                 );
                 $funcReplace = 'preg_replace';
             } else {
                 $funcReplace = 'str_replace';
             }
 
             if ($this->_options['preserve_data']) {
                 $values = array_map(
                     array(&$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;
             } else {
                 if (isset($this->touchedBlocks[$block])) {
                     $this->blockdata[$block] .= $outer;
                     unset($this->touchedBlocks[$block]);
                 }
             }
         } else {
             if (empty($this->blockdata[$block])) {
                 $this->blockdata[$block] = $outer;
             } else {
                 $this->blockdata[$block] .= $outer;
             }
         }
 
         return $empty;
     } // end func parse

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.

See also: parse(), setCurrentBlock(), $currentBlock User interface

Definition at line 596 of file IT.php.

References parse().

Referenced by ilTemplate\fillCssFiles(), ilTemplate\fillJavaScriptFiles(), and ilTemplate\touchBlock().

     {
         return $this->parse($this->currentBlock);
     } // end func parseCurrentBlock

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurrentBlock()

HTML_Template_IT::setCurrentBlock ( $block = '__global__' )

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

Parameters

string name of the block

Returns: boolean false on failure, otherwise true

Exceptions

ilTemplateException public

Definition at line 636 of file IT.php.

References errorMessage(), and IT_BLOCK_NOT_FOUND.

     {
         if (!isset($this->blocklist[$block])) {
             throw (new ilTemplateException($this->errorMessage(IT_BLOCK_NOT_FOUND) .
                 '"' . $block . "'"));
         }
 
         $this->currentBlock = $block;
 
         return true;
     } // end func setCurrentBlock

Here is the call graph for this function:

◆ setOption()

HTML_Template_IT::setOption	(	$option,
		$value
	)

Sets the option for the template class.

public

Parameters

string	option name
mixed	option value

Returns: mixed IT_OK on success, error object on failure

Definition at line 399 of file IT.php.

References errorMessage(), IT_OK, and IT_UNKNOWN_OPTION.

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

     {
         if (array_key_exists($option, $this->_options)) {
             $this->_options[$option] = $value;
             return IT_OK;
         }
         throw (new ilTemplateException($this->errorMessage(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 ( $options )

Sets the options for the template class.

public

Parameters

string	options array of options default value: 'preserve_data' => false, 'use_preg' => true
mixed	option value

Returns: mixed IT_OK on success, error object on failure

See also: $options

Definition at line 420 of file IT.php.

References IT_OK, and setOption().

Referenced by __construct().

     {
         if (is_array($options)) {
             foreach ($options as $option => $value) {
                 $error = $this->setOption($option, $value);
             }
         }
 
         return IT_OK;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRoot()

HTML_Template_IT::setRoot ( $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.

Parameters

string

See also: HTML_Template_IT() User interface

Definition at line 812 of file IT.php.

Referenced by __construct().

     {
         if ($root != '' && substr($root, -1) != '/') {
             $root .= '/';
         }
 
         $this->fileRoot = $root;
     } // end func setRoot

Here is the caller graph for this function:

◆ setTemplate()

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

Sets the template.

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

Parameters

string	template content
boolean	remove unknown/unused variables?
boolean	remove empty blocks?

See also: LoadTemplatefile(), $template User interface

Returns: boolean

Definition at line 743 of file IT.php.

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

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

       {
         $this->removeUnknownVariables = $removeUnknownVariables;
         $this->removeEmptyBlocks = $removeEmptyBlocks;
 
         if ($template == '' && $this->flagCacheTemplatefile) {
             $this->variableCache = array();
             $this->blockdata = array();
             $this->touchedBlocks = array();
             $this->currentBlock = '__global__';
         } else {
             $this->template = '<!-- BEGIN __global__ -->' . $template .
                               '<!-- END __global__ -->';
             $this->init();
         }
 
         if ($this->flagBlocktrouble) {
             return false;
         }
 
         return true;
     } // end func setTemplate

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

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

Definition at line 615 of file IT.php.

     {
         if (is_array($variable)) {
             $this->variableCache = array_merge(
                 $this->variableCache,
                 $variable
                                     );
         } else {
             $this->variableCache[$variable] = $value;
         }
     } // end func setVariable

◆ show()

HTML_Template_IT::show ( $block = '__global__' )

Print a certain block with all replacements done.

get()

Definition at line 435 of file IT.php.

     {
         print $this->get($block);
     } // end func show

◆ touchBlock()

HTML_Template_IT::touchBlock ( $block )

Preserves an empty block even if removeEmptyBlocks is true.

Parameters

string name of the block

Returns: boolean false on false, otherwise true

Exceptions

ilTemplateException public

See also: $removeEmptyBlocks

Definition at line 657 of file IT.php.

References errorMessage(), and IT_BLOCK_NOT_FOUND.

     {
         if (!isset($this->blocklist[$block])) {
             throw (new ilTemplateException($this->errorMessage(IT_BLOCK_NOT_FOUND) .
                 '"' . $block . "'"));
         }
 
         $this->touchedBlocks[$block] = true;
 
         return true;
     } // end func touchBlock

Here is the call graph for this function:

Field Documentation

◆ $_hiddenBlocks

array HTML_Template_IT::$_hiddenBlocks = array()

List of blocks which should not be shown even if not "empty".

See also: hideBlock(), $removeEmptyBlocks

Definition at line 284 of file IT.php.

◆ $_options

HTML_Template_IT::$_options

Initial value:

= array(
        'preserve_data' => false,
        'use_preg' => true
    )

$_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 356 of file IT.php.

◆ $blockdata

HTML_Template_IT::$blockdata = array()

Definition at line 236 of file IT.php.

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

◆ $blockinner

HTML_Template_IT::$blockinner = array()

Definition at line 250 of file IT.php.

Referenced by ilTemplate\init().

◆ $blocklist

HTML_Template_IT::$blocklist = array()

Definition at line 229 of file IT.php.

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

◆ $blocknameRegExp

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

Definition at line 164 of file IT.php.

◆ $blockparents

HTML_Template_IT::$blockparents = array()

Definition at line 244 of file IT.php.

Referenced by ilTemplate\init().

◆ $blockRegExp

HTML_Template_IT::$blockRegExp = ''

Definition at line 209 of file IT.php.

◆ $blockvariables

HTML_Template_IT::$blockvariables = array()

Definition at line 242 of file IT.php.

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

◆ $clearCache

HTML_Template_IT::$clearCache = false

Definition at line 138 of file IT.php.

◆ $clearCacheOnParse

HTML_Template_IT::$clearCacheOnParse = false

Definition at line 307 of file IT.php.

◆ $closingDelimiter

HTML_Template_IT::$closingDelimiter = '}'

Definition at line 154 of file IT.php.

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

◆ $currentBlock

HTML_Template_IT::$currentBlock = '__global__'

Definition at line 215 of file IT.php.

◆ $err

HTML_Template_IT::$err = array()

Definition at line 132 of file IT.php.

Referenced by ilTemplate\init().

◆ $fileRoot

HTML_Template_IT::$fileRoot = ''

Definition at line 315 of file IT.php.

◆ $flagBlocktrouble

HTML_Template_IT::$flagBlocktrouble = false

Definition at line 321 of file IT.php.

Referenced by ilTemplate\init().

◆ $flagCacheTemplatefile

HTML_Template_IT::$flagCacheTemplatefile = true

Definition at line 341 of file IT.php.

◆ $flagGlobalParsed

HTML_Template_IT::$flagGlobalParsed = false

Definition at line 327 of file IT.php.

◆ $lastTemplatefile

HTML_Template_IT::$lastTemplatefile = ''

EXPERIMENTAL! FIXME!

Definition at line 346 of file IT.php.

◆ $openingDelimiter

HTML_Template_IT::$openingDelimiter = '{'

Definition at line 146 of file IT.php.

◆ $removeEmptyBlocks

HTML_Template_IT::$removeEmptyBlocks = true

Definition at line 202 of file IT.php.

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

◆ $removeUnknownVariables

HTML_Template_IT::$removeUnknownVariables = true

Definition at line 195 of file IT.php.

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

◆ $removeVariablesRegExp

HTML_Template_IT::$removeVariablesRegExp = ''

RegExp used to strip unused variable placeholder.

$variablesRegExp

Definition at line 188 of file IT.php.

◆ $template

HTML_Template_IT::$template = ''

Definition at line 221 of file IT.php.

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

◆ $touchedBlocks

array HTML_Template_IT::$touchedBlocks = array()

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.

See also: touchBlock(), $removeEmptyBlocks

Definition at line 277 of file IT.php.

◆ $variableCache

HTML_Template_IT::$variableCache = array()

Definition at line 296 of file IT.php.

◆ $variablenameRegExp

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

Definition at line 174 of file IT.php.

◆ $variablesRegExp

HTML_Template_IT::$variablesRegExp = ''

Definition at line 182 of file IT.php.

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

Services/UICore/lib/html-it/IT.php

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addPregDelimiters()

◆ _preserveOpeningDelimiter()

◆ buildBlockvariablelist()

◆ errorMessage()

◆ findBlocks()

◆ free()

◆ get()

◆ getFile()

◆ getGlobalvariables()

◆ init()

◆ loadTemplatefile()

◆ parse()

◆ parseCurrentBlock()

◆ setCurrentBlock()

◆ setOption()

◆ setOptions()

◆ setRoot()

◆ setTemplate()

◆ setVariable()

◆ show()

◆ touchBlock()

Field Documentation

◆ $_hiddenBlocks

◆ $_options

◆ $blockdata

◆ $blockinner

◆ $blocklist

◆ $blocknameRegExp

◆ $blockparents

◆ $blockRegExp

◆ $blockvariables

◆ $clearCache

◆ $clearCacheOnParse

◆ $closingDelimiter

◆ $currentBlock

◆ $err

◆ $fileRoot

◆ $flagBlocktrouble

◆ $flagCacheTemplatefile

◆ $flagGlobalParsed

◆ $lastTemplatefile

◆ $openingDelimiter

◆ $removeEmptyBlocks

◆ $removeUnknownVariables

◆ $removeVariablesRegExp

◆ $template

◆ $touchedBlocks

◆ $variableCache

◆ $variablenameRegExp

◆ $variablesRegExp