Location: PHPKode > projects > SithTemplate > SithTemplate-1.1/docs/html/class_template_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: TemplateIO 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-static-methods">Static Public Member Functions</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a>  </div>
  <div class="headertitle">
<h1>TemplateIO Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="TemplateIO" -->
<p>Global I/O driver storage.  
<a href="#_details">More...</a></p>

<p><a href="class_template_i_o-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_i_o.html#ad9206870c5ac71fe07b4118279e59c24">get</a> ($driver)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns (creates if necessary) an I/O driver instance.  <a href="#ad9206870c5ac71fe07b4118279e59c24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_i_o.html#a5b2d380a38929dd3e1df52ec5218467f">register</a> ($driver, $className)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers new I/O driver.  <a href="#a5b2d380a38929dd3e1df52ec5218467f"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_i_o.html#adbbf7fa991801274975f8c0d3ef5f314">$ioDrivers</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">I/O driver registry.  <a href="#adbbf7fa991801274975f8c0d3ef5f314"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Global I/O driver storage. </p>

<p>Definition at line <a class="el" href="_i_o_8php_source.html#l00013">13</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="ad9206870c5ac71fe07b4118279e59c24"></a><!-- doxytag: member="TemplateIO::get" ref="ad9206870c5ac71fe07b4118279e59c24" args="($driver)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static TemplateIO::get </td>
          <td>(</td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>driver</em>&#160;)</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns (creates if necessary) an I/O driver instance. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$driver</td><td>I/O driver name </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd><code><a class="el" href="interface_i_template_i_o_driver.html" title="Interface required for all I/O drivers.">ITemplateIODriver</a></code> implementation </dd></dl>

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

<p>References <a class="el" href="_error_8php_source.html#l00069">TemplateError::E_INVALID_PLUGIN</a>, and <a class="el" href="_error_8php_source.html#l00063">TemplateError::E_UNKNOWN_PLUGIN</a>.</p>

<p>Referenced by <a class="el" href="_utils_8php_source.html#l00153">TemplateUtils::parseIODSN()</a>.</p>

</div>
</div>
<a class="anchor" id="a5b2d380a38929dd3e1df52ec5218467f"></a><!-- doxytag: member="TemplateIO::register" ref="a5b2d380a38929dd3e1df52ec5218467f" args="($driver, $className)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static TemplateIO::register </td>
          <td>(</td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>driver</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>className</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Registers new I/O driver. </p>
<p>New driver may override existing one.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$driver</td><td>I/O driver name </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$className</td><td>I/O driver class </td></tr>
  </table>
  </dd>
</dl>

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

<p>References <a class="el" href="_error_8php_source.html#l00074">TemplateError::E_INVALID_ARGUMENT</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="adbbf7fa991801274975f8c0d3ef5f314"></a><!-- doxytag: member="TemplateIO::$ioDrivers" ref="adbbf7fa991801274975f8c0d3ef5f314" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplateIO::$ioDrivers<code> [static, private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<b>Initial value:</b><div class="fragment"><pre class="fragment"> array(
  
  <span class="stringliteral">&#39;file&#39;</span>     =&gt; array(<span class="stringliteral">&#39;TemplateFileIO&#39;</span>,     null),
  <span class="stringliteral">&#39;string&#39;</span>   =&gt; array(<span class="stringliteral">&#39;TemplateStringIO&#39;</span>,   null),
 )
</pre></div>
<p>I/O driver registry. </p>

<p>Definition at line <a class="el" href="_i_o_8php_source.html#l00017">17</a> of file <a class="el" href="_i_o_8php_source.html">IO.php</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