Location: PHPKode > projects > SithTemplate > SithTemplate-1.1/docs/html/class_template_string_i_o.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>SithTemplate: TemplateStringIO Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.2 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<h1>TemplateStringIO Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="TemplateStringIO" --><!-- doxytag: inherits="TemplateFileIO" -->
<p>String I/O implementation.  
<a href="#_details">More...</a></p>

<p><a href="class_template_string_i_o-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_string_i_o.html#a24c000d1d1c51f66aafb5675317548b6">upToDate</a> (array &amp;$settings, &amp;$template, $mode)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_string_i_o.html#a41da9f90eb44c9624cb3ff2066b8f2d6">includeCode</a> (array &amp;$settings, &amp;$template)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_string_i_o.html#ad9c9f9b3a1333243ce45f26de8a5fa94">className</a> (array &amp;$settings, &amp;$template)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_string_i_o.html#a4a43ba4a23c5087c68e3a45fbd0c061e">pfn</a> (array &amp;$settings, &amp;$template)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>String I/O implementation. </p>

<p>Definition at line <a class="el" href="_i_o_8php_source.html#l00172">172</a> of file <a class="el" href="_i_o_8php_source.html">IO.php</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4a43ba4a23c5087c68e3a45fbd0c061e"></a><!-- doxytag: member="TemplateStringIO::pfn" ref="a4a43ba4a23c5087c68e3a45fbd0c061e" args="(array &amp;$settings, &amp;$template)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplateStringIO::pfn </td>
          <td>(</td>
          <td class="paramtype">array &amp;$&#160;</td>
          <td class="paramname"> <em>settings</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&amp;$&#160;</td>
          <td class="paramname"> <em>template</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Reimplemented from <a class="el" href="class_template_file_i_o.html#aa1dac7190bee50dd281b5fd4c312850c">TemplateFileIO</a>.</p>

<p>Definition at line <a class="el" href="_i_o_8php_source.html#l00173">173</a> of file <a class="el" href="_i_o_8php_source.html">IO.php</a>.</p>

<p>Referenced by <a class="el" href="_i_o_8php_source.html#l00193">includeCode()</a>, and <a class="el" href="_i_o_8php_source.html#l00185">upToDate()</a>.</p>

</div>
</div>
<a class="anchor" id="a24c000d1d1c51f66aafb5675317548b6"></a><!-- doxytag: member="TemplateStringIO::upToDate" ref="a24c000d1d1c51f66aafb5675317548b6" args="(array &amp;$settings, &amp;$template, $mode)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplateStringIO::upToDate </td>
          <td>(</td>
          <td class="paramtype">array &amp;$&#160;</td>
          <td class="paramname"> <em>settings</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&amp;$&#160;</td>
          <td class="paramname"> <em>template</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>mode</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Should check whether given template is up-to-date. </p>
<p>If driver uses <code>recompilationMode</code> setting, then it should use supplied <code>$mode</code> argument instead, to allow per-template mode override. Although parameters are supplied via reference, they should not be modified in any way.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$settings</td><td>Settings array, see <a class="el" href="class_template_environ.html#a1a6916c9094781e70523b3ed7ba20b68">TemplateEnviron::$settings</a> </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$template</td><td>Template name </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$mode</td><td>Recompilation mode </td></tr>
  </table>
  </dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">true</td><td>Template is up-to-date - no (re)compilation is needed </td></tr>
    <tr><td class="paramname">false</td><td>Template must be (re)compiled </td></tr>
  </table>
  </dd>
</dl>
 
<p>Reimplemented from <a class="el" href="class_template_file_i_o.html#aa4bc432153892d73c14e19ff2fb55400">TemplateFileIO</a>.</p>

<p>Definition at line <a class="el" href="_i_o_8php_source.html#l00185">185</a> of file <a class="el" href="_i_o_8php_source.html">IO.php</a>.</p>

<p>References <a class="el" href="_i_o_8php_source.html#l00173">pfn()</a>, and <a class="el" href="_environment_8php_source.html#l00202">TemplateEnviron::RECOMPILE_ALWAYS</a>.</p>

</div>
</div>
<a class="anchor" id="a41da9f90eb44c9624cb3ff2066b8f2d6"></a><!-- doxytag: member="TemplateStringIO::includeCode" ref="a41da9f90eb44c9624cb3ff2066b8f2d6" args="(array &amp;$settings, &amp;$template)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplateStringIO::includeCode </td>
          <td>(</td>
          <td class="paramtype">array &amp;$&#160;</td>
          <td class="paramname"> <em>settings</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&amp;$&#160;</td>
          <td class="paramname"> <em>template</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Should include template's code into global namespace. </p>
<p>It must ensure that no code redefinition will happen. Although parameters are supplied via reference, they should not be modified in any way.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$settings</td><td>Settings array, see <a class="el" href="class_template_environ.html#a1a6916c9094781e70523b3ed7ba20b68">TemplateEnviron::$settings</a> </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$template</td><td>Template name </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Included class name </dd></dl>
 
<p>Reimplemented from <a class="el" href="class_template_file_i_o.html#aa8a87a009b5abb1b77ede6e514ec1b51">TemplateFileIO</a>.</p>

<p>Definition at line <a class="el" href="_i_o_8php_source.html#l00193">193</a> of file <a class="el" href="_i_o_8php_source.html">IO.php</a>.</p>

<p>References <a class="el" href="_i_o_8php_source.html#l00210">className()</a>, <a class="el" href="_error_8php_source.html#l00032">TemplateError::E_IO_LOAD_FAILURE</a>, and <a class="el" href="_i_o_8php_source.html#l00173">pfn()</a>.</p>

</div>
</div>
<a class="anchor" id="ad9c9f9b3a1333243ce45f26de8a5fa94"></a><!-- doxytag: member="TemplateStringIO::className" ref="ad9c9f9b3a1333243ce45f26de8a5fa94" args="(array &amp;$settings, &amp;$template)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplateStringIO::className </td>
          <td>(</td>
          <td class="paramtype">array &amp;$&#160;</td>
          <td class="paramname"> <em>settings</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&amp;$&#160;</td>
          <td class="paramname"> <em>template</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Should return template's classname. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$settings</td><td>Settings array, see <a class="el" href="class_template_environ.html#a1a6916c9094781e70523b3ed7ba20b68">TemplateEnviron::$settings</a> </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$template</td><td>Template name </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Class name </dd></dl>
 
<p>Reimplemented from <a class="el" href="class_template_file_i_o.html#aed074d5ef58838473230d4b46a954e32">TemplateFileIO</a>.</p>

<p>Definition at line <a class="el" href="_i_o_8php_source.html#l00210">210</a> of file <a class="el" href="_i_o_8php_source.html">IO.php</a>.</p>

<p>Referenced by <a class="el" href="_i_o_8php_source.html#l00193">includeCode()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_i_o_8php_source.html">IO.php</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Fri Jan 14 2011 20:08:37 for SithTemplate by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>
Return current item: SithTemplate