PEAR Handbuch
Zurück		Nach vorne

HTML_Template_IT

HTML_Template_IT -- Light-weight template system

Placeholder

The format of placeholder is
{[0-9A-Za-z_-]+}
This means, the name of the placeholder can consist of upper- and lowercase letters, underscores and hypens. The name must be placed between curly brackets without any spaces. Valid names are i.e.:

{Placeholder}

{place2_holder}

{PLACEHOLDER1}

{Place-Holder}

Non-valid names are i.e.

{ Placeholder 3 } (spaces)

{place*holder} (char isn't permitted)

Blocks

The format of a block is
 ... block content ... 
The rules for the block name are the same like for placeholders. In contrast to placeholders the spaces in the block markup are required.

The nesting of blocks is permitted, but be careful while parsing. You have to set and parse the deepest inner block first and then set and parse from inner to outer.

Usage Example

Beispiel 1. The template

<html>
 <table border>
<!-- BEGIN row -->
  <tr>
<!-- BEGIN cell -->
   <td>
    {DATA}
   </td>
<!-- END cell -->
  </tr>
<!-- END row -->
 </table>
</html>

Beispiel 2. The script

<?php
  require_once "HTML/IT.php";

  $data = array
  (
    "0" => array("Stig", "Bakken"),
    "1" => array("Martin", "Jansen"),
    "2" => array("Alexander", "Merz")
  );

  $tpl = new HTML_Template_IT("./templates");

  $tpl->loadTemplatefile("main.tpl.htm", true, true);

  foreach($data as $name) {
    foreach($name as $cell) {
        // Assign data to the inner block
        $tpl->setCurrentBlock("cell") ;
        $tpl->setVariable("DATA", $cell) ;
        $tpl->parseCurrentBlock("cell") ;
    }
    // Assign data and the inner block to the
    // outer block
    $tpl->setCurrentBlock("row") ;
    $tpl->parseCurrentBlock("row") ;
  }
  // print the output
  $tpl->show();

?>

Beispiel 3. The output

<html>
 <table border>
  <tr>
   <td>
    Stig
   </td>
   <td>
    Bakken
   </td>
  </tr>
  <tr>
   <td>
    Martin
   </td>
   <td>
    Jansen
   </td>
  </tr>
  <tr>
   <td>
    Alexander
   </td>
   <td>
    Merz
   </td>
  </tr>
 </table>
</html>

HTML_Template_IT::HTML_Template_IT

void HTML_Template_IT::HTML_Template_IT ([string $root])

Builds some complex regular expressions and optinally sets the file root directory. Make sure that you call this constructor if you derive your templateclass from this one.

$root - root directory, prefix for all filenames given to the object.

HTML_Template_IT::get

string HTML_Template_IT::get ([string $block])

Returns a block with all replacements done.

$block - block to return, when not set the complete template will returned.

HTML_Template_IT::parse

void HTML_Template_IT::parse ([string $block [, boolean $flag_recursion]])

Parses the given block.

$block - block to parse, when not set the complete template will be parsed.
$flag_recursion - can be ignored

HTML_Template_IT::parseCurrentBlock

void HTML_Template_IT::parseCurrentBlock ()

Parses the current block

HTML_Template_IT::setVariable

void HTML_Template_IT::setVariable (mixed $placeholder [, string $variable])

Sets a variable value. The function can be used eighter like setVariable( "varname", "value") or with one array $variables["varname"] = "value" given setVariable($variables).

$placeholder - Name of the placeholder to substitute or a array with the placeholder as key and the data to assign as value.
$variable - when $placeholder isn't a array, the value to assign to the placeholder.

HTML_Template_IT::setCurrentBlock

boolean HTML_Template_IT::setCurrentBlock ([string $block])

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

$block - block to set, when not given the complete template is set (shows on the placeholders outside of all block).

Returns

Boolean - false on failure, otherwise true

HTML_Template_IT::touchBlock

boolean HTML_Template_IT::touchBlock (string $block)

Preserves an empty block even if removeEmptyBlocks is true

$block - block to preserve

Returns

Boolean - false on false, otherwise true

HTML_Template_IT::init

void HTML_Template_IT::init ()

Clears all datafields of the object and rebuilds 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.

HTML_Template_IT::free

void HTML_Template_IT::free ()

Clears all datafields of the object. Don't use this function unless you know what you're doing.

HTML_Template_IT::setTemplate

void HTML_Template_IT::setTemplate (string $template)

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

$template - content

HTML_Template_IT::loadTemplatefile

boolean HTML_Template_IT::loadTemplatefile (string $filename [, boolean $removeUnknownVariables [, boolean $removeEmptyBlocks]])

Reads a template file from the disk.

$filename - name of the template file
$removeUnknownVariables - when true not assigned placeholders will be deleted
$removeEmptyBlocks - when true unused blocks will be removed

Returns

Boolean - false on false, otherwise true

HTML_Template_IT::setRoot

void HTML_Template_IT::setRoot (string $root [, boolean $removeUnknownVariables [, boolean $removeEmptyBlocks]])

Sets the file root. The file root gets prefixed to all filenames passed to the object.

$root - root directory for the templates
$removeUnknownVariables - when true not assigned placeholders will be deleted
$removeEmptyBlocks - when true unused blocks will be removed

HTML_Template_IT::show

void HTML_Template_IT::show ([string $block])

Print a certain block with all replacements done.

$block - when not set the whole content will be printed.

Zurück	Zum Anfang	Nach vorne
HTML Templates	Nach oben	HTML_Template_ITX