Location: PHPKode > projects > SithTemplate > SithTemplate-1.1/docs/html/interface_i_template_plugin.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: ITemplatePlugin Interface 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>  </div>
  <div class="headertitle">
<h1>ITemplatePlugin Interface Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="ITemplatePlugin" -->
<p>Interface required for all plugins.  
<a href="#_details">More...</a></p>

<p><a href="interface_i_template_plugin-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="interface_i_template_plugin.html#aa306addac20bd9df26808738c4cb6a26">providedHandlers</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Plugin's entry point, must return array of provided handlers (see <a class="el" href="extending-st.html">Extending SithTemplate</a>).  <a href="#aa306addac20bd9df26808738c4cb6a26"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Interface required for all plugins. </p>
<p>Since 1.1 plugins are used during compilation phase exclusively, there are no more 'runtime/compile-time libraries'.</p>
<p>Both tags and filters now use code inlining (e.g. they embed code directly in template's code). </p>

<p>Definition at line <a class="el" href="_i_plugin_8php_source.html#l00019">19</a> of file <a class="el" href="_i_plugin_8php_source.html">IPlugin.php</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa306addac20bd9df26808738c4cb6a26"></a><!-- doxytag: member="ITemplatePlugin::providedHandlers" ref="aa306addac20bd9df26808738c4cb6a26" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ITemplatePlugin::providedHandlers </td>
          <td>(</td>
          <td class="paramname">&#160;)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Plugin's entry point, must return array of provided handlers (see <a class="el" href="extending-st.html">Extending SithTemplate</a>). </p>
<p>Handler array structure:</p>
<ul>
<li>
<code>tags</code> - array of tag handlers <ul>
<li>
<code>handler</code> (array/string, required) - whatever <code>call_user_func_array</code> can handle. If you want to use stand-alone function, you must also set <code>standalone</code> key to <code>true</code>, otherwise library will assume that you meant <code>array</code>($this,$handler).  </li>
<li>
<code>standalone</code> (boolean, optional) - set it, if you want to use non-member function as <code>handler</code>.  </li>
<li>
<code>type</code> (string, required) - tag type. Either <code>'block'</code> or <code>'inline'</code>.  </li>
<li>
<code>minArgs</code> (integer, optional) - minimum arguments this tag needs. Defaults to 0.  </li>
<li>
<code>parent</code> (string, optional) - enforcement of specific immediate parent. Used in e.g. <code>else/elseif</code>. Compiler will raise error if immediate parent of this tag isn't one specified here. Defaults to nothing. May contain wildcard <code>*</code> (e.g. <code>if*</code> matches <code>if</code>, <code>ifchanged</code>, <code>ifequals</code>, etc.).  </li>
</ul>
</li>
<li>
<code>filters</code> - array of filter handlers <ul>
<li>
<code>handler</code> (array/string, required) - see above. </li>
<li>
<code>standalone</code> (boolean, optional) - see above. </li>
<li>
<code>minArgs</code> (integer, optional) - see above. </li>
</ul>
</li>
<li>
<code>hooks</code> - array of hook handlers (for available hookpoints see <a class="el" href="extending-st.html#extending-st-hooks">Extending: hooks</a>) <ul>
<li>
<code>handler</code> (array/string, required) - see above. </li>
<li>
<code>standalone</code> (boolean, optional) - see above. </li>
</ul>
</li>
</ul>
<dl class="return"><dt><b>Returns:</b></dt><dd>Assoc. array of handlers </dd></dl>

<p>Implemented in <a class="el" href="class_template_std_lib_ex_plugin.html#a52cc2adc22b09c2c66ea60b61804cf37">TemplateStdLibExPlugin</a>.</p>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="_i_plugin_8php_source.html">IPlugin.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