Class: HTML_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.

<table border> <tr> <td colspan=2> __global__ <p> (hidden and automatically added) </td> </tr> <tr> <td>block1</td> <td> <table border> <tr> <td colspan=2>block2</td> </tr> <tr> <td>inner1</td> <td>inner2</td> </tr> </table> </td> </tr> </table>

To add content to block1 you simply type:

$tpl->setCurrentBlock("block1");

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

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

[line 180]

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

$clearCache =  false

[line 154]

$clearCacheOnParse =  false

[line 333]

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.

$closingDelimiter =  '}'

[line 170]

$err = array()

[line 146]

$openingDelimiter =  '{'

[line 162]

$removeEmptyBlocks =  true

[line 219]

$removeUnknownVariables =  true

[line 212]

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

[line 190]

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

HTML_Template_IT (Constructor)   [line 410]

checkPlaceholderExists   [line 734]

get   [line 509]

getGlobalvariables   [line 987]

loadTemplatefile   [line 920]

parse   [line 558]

parseCurrentBlock   [line 723]

setCurrentBlock   [line 786]

setOption   [line 440]

setOptions   [line 471]

setRoot   [line 951]

setTemplate   [line 883]

setVariable   [line 763]

show   [line 494]

touchBlock   [line 812]