Location: PHPKode > scripts > InTemplate > intemplate/developer_guide.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- Generated with PHPDoc, http://www.phpdoc.de -->
<html>
<head>
	<title>InTemplate - Developer Guide</title>

<style>
BODY {
	background-color : #EEEEEE;
	color : #000000;
	font-family : Arial, Tahoma, Helvetica, sans-serif;
	font-size : 10pt;
	margin-left : 1em;
	margin-right : 0;

}

A:LINK, A:VISITED {
	color : #000099;
	text-decoration : none;
}

A:HOVER {
	background-color : #FFFFFF;
	color : #00009F;
	text-decoration : none;
}

H1 {
	color : Black;
	font-family : Verdana, Tahoma, Arial, Helvetica, sans-serif;
	font-size : 16pt;
	padding-bottom : 5px;
	padding-top : 5px;
	padding-left : 5px;
}

H2 {
	color : Black;
	font-family : Verdana, Tahoma, Arial, Helvetica, sans-serif;
	font-size : 14pt;
	margin-top : 2em;
}

H3 {
	color : Navy;
	font-family : Verdana, Tahoma, Arial, Helvetica, sans-serif;
	font-size : 12pt;
	margin-top :1em;
}

H4 {
	color : Navy;
	font-family : Verdana, Tahoma, Arial, Helvetica, sans-serif;
	font-size : 11pt;
	background-color : #E6E6FA;
	padding-bottom : 2px;
	padding-top : 2px;
	padding-left : 2px;
	margin-top : 1em;
}

H5 {
	color : Navy;
	font-family : Verdana, Tahoma, Arial, Helvetica, sans-serif;
	font-size : 10pt;
	font-weight : 900;
	margin-bottom : -1em;
}

H6 {
	color : #000000;
	font-family : Arial, Helvetica, sans-serif;
	font-size : 10pt;
	font-weight : 800;	
	margin-bottom : -1em;
}

BLOCKQUOTE {
	margin-left : 0;
}

CAPTION {
	font-family : Verdana, Tahoma, Arial, Helvetica, sans-serif;
	font-weight : 800;
}

TH {
	background-color : #FFFFFF;
}

TD {
	font-size : 10pt;
}

CODE {
	font-size: 8pt;
}
</style>
</head>

<body>
<table width="100%" border="0">
  <tr> 
    <td align="left" valign="top"> 
      <h1 align="center">InTemplate - Developer Guide</h1>
    </td>
  </tr>
  <tr> 
    <td align="left" valign="top"> 
      <h2>About InTemplate</h2>
      <p>This class is a modified version of CDI's <a href="http://www.thewebmasters.net/php/">FastTemplates</a>. 
      </p>
      <p>FastTemplates was originally written by some nice guys fromCDI &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;, 
        you can download the source here : <a href="http://www.thewebmasters.net/php/">http://www.thewebmasters.net/php/</a></p>
      <p>Since it was written back then when we were still using PHP3, there are 
        many 'old' function that should be replaced to gain a faster yet reliable 
        templating system. Which I (and you) despradly need. Also, there are many 
        features that i think should be included in a 'so called' templating system.</p>
      <p>So, that brings me to InTemplate. See User Guide for detail use of this 
        class. </p>
      <p>Anyway, the name InTemplate goes to <a href="http://www.inartsmultimedia.com/">InArtS 
        Multimedia</a>, the place where i get real money. :-)</p>
      <p> 
      <table>
        <tr> 
          <td align="left" valign="top">Authors</td>
          <td align="left" valign="top">CDI &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;, 
            Eris Ristemena &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</td>
        </tr>
        <tr> 
          <td align="left" valign="top">Version</td>
          <td align="left" valign="top">0.1</td>
        </tr>
      </table>
    </td>
  </tr>
  <tr> 
    <td height="10" align="left" valign="top">&nbsp;</td>
  </tr>
  <tr> 
    <td height="20" align="left" valign="top"> 
      <hr>
    </td>
  </tr>
  <tr> 
    <td align="left" valign="top"> 
      <table width="100%" border="0">
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <h2>Public Method Summary</h2>
          </td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_InTemplate()"><b>InTemplate([ 
            string $pathToTemplates ])</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Set the directory which all templates reside</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">boolean</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_Define()"><b>Define(array 
            $fileList)</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Maps a template filename to a (usually shorter) name.</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">boolean</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_DefineDynamic()"><b>DefineDynamic(string 
            $Macro, string $parentName)</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>A dynamic block lives inside another template file.</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_Assign()"><b>Assign(array 
            $parseVars, [ string $trailer ])</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Assigns values for var.</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_Parse()"><b>Parse(string 
            $ReturnVar, array $FileTags, [ string $lowerVar ])</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>The meat of the whole class. The magic happens here.</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_InPrint()"><b>InPrint(string 
            $template)</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Print the templates which has been modified.</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_Fetch()"><b>Fetch([ 
            string $template ])</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Returns the raw data from a parsed handle.</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">boolean</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_ClearDynamic()"><b>ClearDynamic([ 
            string $Macro ])</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Strips a DYNAMIC BLOCK from a template.</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_ClearParse()"><b>ClearParse([ 
            string $returnVar ])</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Removes a given reference from the list of refs that is built using: 
            $tpl-&gt;Assign(KEY = val);</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_ClearAll()"><b>ClearAll()</b></a> 
          </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Clear all</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_ClearTemplate()"><b>ClearTemplate(string 
            $fileHandle)</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Clear templates</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_ClearDefine()"><b>ClearDefine([ 
            string $fileTag ])</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Clears the internal list that stores data passed to $tpl-&gt;define();</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_ClearAssign()"><b>ClearAssign()</b></a> 
          </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Clears all variables set by assign()</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_ShowUnknowns()"><b>ShowUnknowns(string 
            $line)</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Prints the warnings for unresolved variable references in template 
            files.</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_Strict()"><b>Strict()</b></a> 
          </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Strict template checking, if true sends warnings to STDOUT when</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_NoStrict()"><b>NoStrict()</b></a> 
          </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Silently discards (removes) undefined variable references</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">boolean</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_GetAssigned()"><b>GetAssigned([ 
            string $tpl_name ])</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Return the value of an assigned variable.</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_AssignInclude()"><b>AssignInclude(string 
            $Macro, string $include)</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Handle any included file using include()</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
      </table>
    </td>
  </tr>
  <tr> 
    <td align="left" valign="top"> 
      <table width="100%" border="0">
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <h2>Private Method Summary</h2>
          </td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_SetRoot()"><b>SetRoot(string 
            $root)</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>All templates will be loaded from this &quot;root&quot; directory.</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">boolean</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_IsSafe()"><b>IsSafe(string 
            $fileName)</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>A quick check of the template file before reading it.</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">string</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_GetTemplate()"><b>GetTemplate(string 
            $template)</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Grabs a template from the root dir and</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">string</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_ParseTemplate()"><b>ParseTemplate(string 
            $template, array $parseVars)</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>This routine does the actual to VALUE conversion within the template.</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_ParseDynamic()"><b>ParseDynamic(string 
            $MacroName, string $Macro, [ string $alt ])</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Parse a dynamic block</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_Clear()"><b>Clear([ 
            string $returnVar ])</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>General clearance</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_ClearHref()"><b>ClearHref(string 
            $href)</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Clears all href</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_Error()"><b>Error(string 
            $errorMsg, [ integer $die ])</b></a> </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Prints any error message.</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">void</td>
          <td align="left" valign="top" width="100%" bgcolor="#E6E6FA"> <a href="#function_utime()"><b>utime()</b></a> 
          </td>
        </tr>
        <tr> 
          <td>&nbsp;</td>
          <td>Calculates current microtime</td>
        </tr>
        <tr> 
          <td colspan=2>&nbsp;</td>
        </tr>
      </table>
    </td>
  </tr>
  <tr> 
    <td align="left" valign="top"> 
      <table width="100%" border="0">
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <h2>Private Field Summary</h2>
          </td>
        </tr>
        <tr> 
          <td align="right" valign="top">array</td>
          <td align="left" valign="top" width="100%"><a href="#variable_$mFileList"> 
            <h4>$mFileList</h4>
            </a>Holds the array of filehandles mFileList[HANDLE] == &quot;fileName&quot;</td>
        </tr>
        <tr> 
          <td align="right" valign="top">array</td>
          <td align="left" valign="top" width="100%"><a href="#variable_$mDynamic"> 
            <h4>$mDynamic</h4>
            </a>Holds the array of dynamic blocks,</td>
        </tr>
        <tr> 
          <td align="right" valign="top">array</td>
          <td align="left" valign="top" width="100%"><a href="#variable_$mParseVars"> 
            <h4>$mParseVars</h4>
            </a>Holds the array of Variable handles.</td>
        </tr>
        <tr> 
          <td align="right" valign="top">array</td>
          <td align="left" valign="top" width="100%"><a href="#variable_$mLoaded"> 
            <h4>$mLoaded</h4>
            </a>We only want to load a template once - when it's used.</td>
        </tr>
        <tr> 
          <td align="right" valign="top">array</td>
          <td align="left" valign="top" width="100%"><a href="#variable_$mHandle"> 
            <h4>$mHandle</h4>
            </a>Holds the handle names assigned by a call to parse()</td>
        </tr>
        <tr> 
          <td align="right" valign="top">array</td>
          <td align="left" valign="top" width="100%"><a href="#variable_$mSeling"> 
            <h4>$mSeling</h4>
            </a>Holds the handle names for selang-seling</td>
        </tr>
        <tr> 
          <td align="right" valign="top">string</td>
          <td align="left" valign="top" width="100%"><a href="#variable_$mRoot"> 
            <h4>$mRoot</h4>
            </a>Holds path-to-templates</td>
        </tr>
        <tr> 
          <td align="right" valign="top">boolean</td>
          <td align="left" valign="top" width="100%"><a href="#variable_$mWin32"> 
            <h4>$mWin32</h4>
            </a>Set to true if this is a WIN32 server</td>
        </tr>
        <tr> 
          <td align="right" valign="top">string</td>
          <td align="left" valign="top" width="100%"><a href="#variable_$mError"> 
            <h4>$mError</h4>
            </a>Holds the last error message</td>
        </tr>
        <tr> 
          <td align="right" valign="top">string</td>
          <td align="left" valign="top" width="100%"><a href="#variable_$mLast"> 
            <h4>$mLast</h4>
            </a>Holds the HANDLE to the last template parsed by parse()</td>
        </tr>
        <tr> 
          <td align="right" valign="top">boolean</td>
          <td align="left" valign="top" width="100%"><a href="#variable_$mStrict"> 
            <h4>$mStrict</h4>
            </a>Strict template checking.</td>
        </tr>
        <tr> 
          <td align="right" valign="top">boolean</td>
          <td align="left" valign="top" width="100%"><a href="#variable_$append"> 
            <h4>$append</h4>
            </a></td>
        </tr>
      </table>
    </td>
  </tr>
  <tr> 
    <td align="left" valign="top"> 
      <table width="100%" border="0">
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <h2>Public Method Details</h2>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_InTemplate()"> 
            <h4>InTemplate</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void InTemplate( 
            [ string $pathToTemplates ] )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Set the directory which all templates 
            reside <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$pathToTemplates</td>
                <td align="left" valign="top"><code>= >>&quot;&quot;<<</code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">path to templates</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_Define()"> 
            <h4>Define</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public boolean Define( 
            array $fileList )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Maps a template filename to a (usually 
            shorter) name. <br>
            This new name is the name that you will use to refer to the templates.Let's 
            just call it 'file tag'. 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">array</td>
                <td align="left" valign="top">$fileList</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">array of template files</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>boolean 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_DefineDynamic()"> 
            <h4>DefineDynamic</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public boolean DefineDynamic( 
            string $Macro, string $parentName )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> A dynamic block lives inside another 
            template file. <br>
            It will be stripped from the template when parsedand replaced with 
            the {$Tag}. 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$Macro</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">macro's name for dynamic 
                  block</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$parentName</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">parent var name</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>boolean 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_Assign()"> 
            <h4>Assign</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void Assign( array 
            $parseVars, [ string $trailer ] )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Assigns values for var. <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">array</td>
                <td align="left" valign="top">$parseVars</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">array(var,value) or 
                  just a var (with value in trailer)</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$trailer</td>
                <td align="left" valign="top"><code>= >>&quot;&quot;<<</code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">the value used only 
                  if $parseVars is not an array</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_Parse()"> 
            <h4>Parse</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void Parse( string 
            $ReturnVar, array $FileTags, [ string $lowerVar ] )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> The meat of the whole class. The magic 
            happens here. <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$ReturnVar</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">the return variable</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">array</td>
                <td align="left" valign="top">$FileTags</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">file tags</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$lowerVar</td>
                <td align="left" valign="top"><code>= >>&quot;&quot;<<</code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">lower var, for cascading 
                  block</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">See Also</td>
          <td align="left" valign="top"><a href="#function_Define()">Define()</a>, 
            <a href="#function_DefineDynamic()">DefineDynamic()</a>, <a href="#function_ParseTemplate()">ParseTemplate()</a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_InPrint()"> 
            <h4>InPrint</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void InPrint( string 
            $template )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Print the templates which has been modified. 
            <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$template</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">Warning: documentation 
                  is missing.</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_Fetch()"> 
            <h4>Fetch</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void Fetch( [ string 
            $template ] )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Returns the raw data from a parsed handle. 
            <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$template</td>
                <td align="left" valign="top"><code>= >>&quot;&quot;<<</code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">name of the templates</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_ClearDynamic()"> 
            <h4>ClearDynamic</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public boolean ClearDynamic( 
            [ string $Macro ] )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Strips a DYNAMIC BLOCK from a template. 
            <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$Macro</td>
                <td align="left" valign="top"><code>= >>&quot;&quot;<<</code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top"></td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>boolean 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_ClearParse()"> 
            <h4>ClearParse</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void ClearParse( 
            [ string $returnVar ] )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Removes a given reference from the list 
            of refs that is built using: $tpl-&gt;Assign(KEY = val); <br>
            If called with no arguments, it removes all references from the array. 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$returnVar</td>
                <td align="left" valign="top"><code>= >>&quot;&quot;<<</code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">clear any parsed variable 
                  from Assign()</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">See Also</td>
          <td align="left" valign="top"><a href="#function_Assign()">Assign()</a>, 
            <a href="#function_Clear()">Clear()</a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_ClearAll()"> 
            <h4>ClearAll</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void ClearAll( 
            )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Clear all <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_ClearTemplate()"> 
            <h4>ClearTemplate</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void ClearTemplate( 
            string $fileHandle )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Clear templates <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$fileHandle</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">Warning: documentation 
                  is missing.</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_ClearDefine()"> 
            <h4>ClearDefine</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void ClearDefine( 
            [ string $fileTag ] )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Clears the internal list that stores 
            data passed to $tpl-&gt;define(); <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$fileTag</td>
                <td align="left" valign="top"><code>= >>&quot;&quot;<<</code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">file tag</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_ClearAssign()"> 
            <h4>ClearAssign</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void ClearAssign( 
            )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Clears all variables set by assign() 
            <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_ShowUnknowns()"> 
            <h4>ShowUnknowns</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void ShowUnknowns( 
            string $line )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Prints the warnings for unresolved variable 
            references in template files. <br>
            Used if mStrict is set true 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$line</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">line pass from GetTemplates()</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_Strict()"> 
            <h4>Strict</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void Strict( )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Strict template checking, if true sends 
            warnings to STDOUT when <br>
            parsing a template with undefined variable referencesUsed for tracking 
            down bugs-n-such. Use no_strict() to disable. 
            <p> 
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_NoStrict()"> 
            <h4>NoStrict</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void NoStrict( 
            )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Silently discards (removes) undefined 
            variable references <br>
            found in templates 
            <p> 
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_GetAssigned()"> 
            <h4>GetAssigned</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public boolean GetAssigned( 
            [ string $tpl_name ] )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Return the value of an assigned variable. 
            <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$tpl_name</td>
                <td align="left" valign="top"><code>= >>&quot;&quot;<<</code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">template name</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>boolean 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_AssignInclude()"> 
            <h4>AssignInclude</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>public void AssignInclude( 
            string $Macro, string $include )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Handle any included file using include() 
            <br>
            I'm sure there are some other better ways to do this 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$Macro</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">current macro</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$include</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">the path to included 
                  file</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
      </table>
  </tr>
  <tr> 
    <td align="left" valign="top"> 
      <table width="100%" border="0">
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <h2>Private Method Details</h2>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_SetRoot()"> 
            <h4>SetRoot</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private void SetRoot( 
            string $root )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> All templates will be loaded from this 
            &quot;root&quot; directory. <br>
            Can be changed in mid-process by re-calling with a newvalue. 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$root</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">root directory</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_IsSafe()"> 
            <h4>IsSafe</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private boolean IsSafe( 
            string $fileName )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> A quick check of the template file before 
            reading it. <br>
            This should check if the file is safe to read,it means the file really 
            exists and the permissionallowed us to read it. [UNFINISHED] 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$fileName</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">file name for checking</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>boolean 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_GetTemplate()"> 
            <h4>GetTemplate</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private string GetTemplate( 
            string $template )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Grabs a template from the root dir and 
            <br>
            reads it into a (potentially REALLY) big string 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$template</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">name of template's file</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>string $contents 
            <p> contents of the template 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_ParseTemplate()"> 
            <h4>ParseTemplate</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private string ParseTemplate( 
            string $template, array $parseVars )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> This routine does the actual to VALUE 
            conversion within the template. <br>
            I made a 'crucial' change here, i used str_replace instead of ereg_replace.That's 
            why this class should go faster than the old FastTemplates. 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$template</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">the template befor parsing</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">array</td>
                <td align="left" valign="top">$parseVars</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">array(var,value)</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>string $template 
            <p> the template after parsing 
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">See Also</td>
          <td align="left" valign="top"><a href="#function_Parse()">Parse()</a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_ParseDynamic()"> 
            <h4>ParseDynamic</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private void ParseDynamic( 
            string $MacroName, string $Macro, [ string $alt ] )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Parse a dynamic block <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$MacroName</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">name of the new var 
                  for the replacement of dynamic block</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$Macro</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">name of the parent's 
                  tag</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$alt</td>
                <td align="left" valign="top"><code>= >>&quot;&quot;<<</code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">set if alternation mode 
                  used</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">See Also</td>
          <td align="left" valign="top"><a href="#function_DefineDynamic()">DefineDynamic()</a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_Clear()"> 
            <h4>Clear</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private void Clear( [ 
            string $returnVar ] )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> General clearance <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$returnVar</td>
                <td align="left" valign="top"><code>= >>&quot;&quot;<<</code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">macro, filetag or var</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">See Also</td>
          <td align="left" valign="top"><a href="#function_ClearParse()">ClearParse()</a>, 
            <a href="#function_ClearDefine()">ClearDefine()</a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_ClearHref()"> 
            <h4>ClearHref</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private void ClearHref( 
            string $href )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Clears all href <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$href</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">href<br />
                  @class public</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_Error()"> 
            <h4>Error</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private void Error( string 
            $errorMsg, [ integer $die ] )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Prints any error message. <br>
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top">Parameter</td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">string</td>
                <td align="left" valign="top">$errorMsg</td>
                <td align="left" valign="top"><code></code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">Error messages</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td></td>
          <td align="left" valign="top"> 
            <table>
              <tr> 
                <td align="left" valign="top">integer</td>
                <td align="left" valign="top">$die</td>
                <td align="left" valign="top"><code>= >>0<<</code></td>
              </tr>
              <tr> 
                <td></td>
                <td colspan="2" align="left" valign="top">whether exit or not 
                  after prints</td>
              </tr>
            </table>
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="function_utime()"> 
            <h4>utime</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private void utime( )</b> 
            <p> 
          </td>
        </tr>
        <tr> 
          <td width="10" align="left" valign="top">&nbsp;</td>
          <td align="left" valign="top"> Calculates current microtime <br>
            I throw this into all my classes for benchmarking purposesIt's not 
            used by anything in this class and can be removedif you don't need 
            it. 
            <p> 
          </td>
        </tr>
        <tr> 
          <td align="left" valign="top">Returns</td>
          <td>void 
            <p> 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
      </table>
  </tr>
  <tr> 
    <td align="left" valign="top"> 
      <table width="100%" border="0">
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <h2>Private Field Details</h2>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="variable_$mFileList"> 
            <h4>$mFileList</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private array $mFileList</b> 
            <p> >><code>array()</code><< 
            <p> Holds the array of filehandles mFileList[HANDLE] == &quot;fileName&quot; 
              <br>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="variable_$mDynamic"> 
            <h4>$mDynamic</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private array $mDynamic</b> 
            <p> >><code>array()</code><< 
            <p> Holds the array of dynamic blocks, <br>
              and the fileHandles they live in. 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="variable_$mParseVars"> 
            <h4>$mParseVars</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private array $mParseVars</b> 
            <p> >><code>array()</code><< 
            <p> Holds the array of Variable handles. <br>
              mParseVars[HANDLE] == &quot;value&quot; 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="variable_$mLoaded"> 
            <h4>$mLoaded</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private array $mLoaded</b> 
            <p> >><code>array()</code><< 
            <p> We only want to load a template once - when it's used. <br>
              mLoaded[FILEHANDLE] == 1 if loaded undefined if not loaded yet. 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="variable_$mHandle"> 
            <h4>$mHandle</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private array $mHandle</b> 
            <p> >><code>array()</code><< 
            <p> Holds the handle names assigned by a call to parse() <br>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="variable_$mSeling"> 
            <h4>$mSeling</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private array $mSeling</b> 
            <p> >><code>array()</code><< 
            <p> Holds the handle names for selang-seling <br>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="variable_$mRoot"> 
            <h4>$mRoot</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private string $mRoot</b> 
            <p> >><code>&quot;&quot;</code><< 
            <p> Holds path-to-templates <br>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="variable_$mWin32"> 
            <h4>$mWin32</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private boolean $mWin32</b> 
            <p> >><code>false</code><< 
            <p> Set to true if this is a WIN32 server <br>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="variable_$mError"> 
            <h4>$mError</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private string $mError</b> 
            <p> >><code>&quot;&quot;</code><< 
            <p> Holds the last error message <br>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="variable_$mLast"> 
            <h4>$mLast</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private string $mLast</b> 
            <p> >><code>&quot;&quot;</code><< 
            <p> Holds the HANDLE to the last template parsed by parse() <br>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="variable_$mStrict"> 
            <h4>$mStrict</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private boolean $mStrict</b> 
            <p> >><code>true</code><< 
            <p> Strict template checking. <br>
              Unresolved vars in templates will generate a warning when found. 
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"><a name="variable_$append"> 
            <h4>$append</h4>
            </a></td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> <b>private boolean $append</b> 
            <p> >><code>true</code><< 
            <p> <br>
          </td>
        </tr>
        <tr> 
          <td colspan="2" align="left" valign="top"> 
            <hr>
          </td>
        </tr>
      </table>
  </tr>
  <tr> 
    <td align="left" valign="top">Generated by. PHPDoc 1.0beta</td>
  </tr>
</table>

</body>
</html>
Return current item: InTemplate