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

$blockdata = array()

[line 237]

$blockinner = array()

[line 249]

$blocklist = array()

[line 230]

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

[line 165]

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

$blockRegExp =  ''

[line 210]

$blockvariables = array()

[line 243]

$clearCache =  false

[line 139]

$clearCacheOnParse =  false

[line 306]

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 155]

$currentBlock =  '__global__'

[line 216]

$err = array()

[line 133]

$fileRoot =  ''

[line 314]

The string gets prefixed to all filenames given.

$flagBlocktrouble =  false

[line 320]

$flagCacheTemplatefile =  true

[line 340]

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.

$flagGlobalParsed =  false

[line 326]

$lastTemplatefile =  ''

[line 345]

$openingDelimiter =  '{'

[line 147]

$removeEmptyBlocks =  true

[line 203]

$removeUnknownVariables =  true

[line 196]

$removeVariablesRegExp =  ''

[line 189]

$template =  ''

[line 222]

$touchedBlocks = array()

[line 276]

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.

$variableCache = array()

[line 295]

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

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

[line 175]

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

$variablesRegExp =  ''

[line 183]

HTML_Template_IT (Constructor)   [line 371]

buildBlockvariablelist   [line 809]

errorMessage   [line 965]

findBlocks   [line 850]

free   [line 707]

get   [line 455]

getFile   [line 902]

getGlobalvariables   [line 827]

init   [line 690]

loadTemplatefile   [line 768]

parse   [line 497]

parseCurrentBlock   [line 604]

setCurrentBlock   [line 643]

setOption   [line 398]

setOptions   [line 423]

setRoot   [line 797]

setTemplate   [line 733]

setVariable   [line 623]

show   [line 441]

touchBlock   [line 667]