Location: PHPKode > projects > SithTemplate > SithTemplate-1.1/docs/html/class_template_plugins.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: TemplatePlugins 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="#pub-attribs">Public Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a>  </div>
  <div class="headertitle">
<h1>TemplatePlugins Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="TemplatePlugins" -->
<p>Handles discovery, registration and utilization of plugins.  
<a href="#_details">More...</a></p>

<p><a href="class_template_plugins-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_plugins.html#a35839e04a5701ee2b7efdc5ce9c06501">__construct</a> (array $builtins)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a35839e04a5701ee2b7efdc5ce9c06501"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_plugins.html#acad3fb00a013432da30dc682905384b0">load</a> (<a class="el" href="class_template_compiler_ex.html">TemplateCompilerEx</a> $compiler, $node, $plugin, $pluginFile=null, $noThrow=false)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Load single plugin.  <a href="#acad3fb00a013432da30dc682905384b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_plugins.html#a0bea8d628f5b57b8bf8c930980ab8896">loadMultiple</a> (<a class="el" href="class_template_compiler_ex.html">TemplateCompilerEx</a> $compiler, $node, $plugins)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Load multiple plugins.  <a href="#a0bea8d628f5b57b8bf8c930980ab8896"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_plugins.html#a9fdc46282fea5afe6850469897e9a0dd">known</a> ($type, $name)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Check whether given element is registered.  <a href="#a9fdc46282fea5afe6850469897e9a0dd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_plugins.html#ac2bccff1c1d49f63a0f66efc118220a7">get</a> ($type, $name)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns handler(s) information for given element.  <a href="#ac2bccff1c1d49f63a0f66efc118220a7"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_plugins.html#af9aa580edb4c30ae32a330fe74b6fff4">$searchPaths</a> = array()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Plugins' search paths.  <a href="#af9aa580edb4c30ae32a330fe74b6fff4"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private 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_plugins.html#a1a64cc16940f3fa5ff0a711a803bbe25">findPlugin</a> ($plugin)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks for plugin file on all search paths.  <a href="#a1a64cc16940f3fa5ff0a711a803bbe25"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_plugins.html#a562e9a9f92fa59024c38398cc6fefc3e">findPlugins</a> ($plugins)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Looks for multiple plugins' files on all search paths.  <a href="#a562e9a9f92fa59024c38398cc6fefc3e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_plugins.html#a30612b19259f49e4525d608cca00936f">register</a> ($plugin, <a class="el" href="interface_i_template_plugin.html">ITemplatePlugin</a> $pluginObj, $type, array &amp;$handlers)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers given elements.  <a href="#a30612b19259f49e4525d608cca00936f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_plugins.html#aadc5f1a6e0ee4961413dd6f5b091619f">registerHooks</a> ($plugin, <a class="el" href="interface_i_template_plugin.html">ITemplatePlugin</a> $pluginObj, array &amp;$hooks)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Register given hooks.  <a href="#aadc5f1a6e0ee4961413dd6f5b091619f"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_plugins.html#a36adfd02aa0e82327f89485df90b3007">$plugins</a> = array()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Already loaded plugins.  <a href="#a36adfd02aa0e82327f89485df90b3007"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_template_plugins.html#a79bcf24c03de22788f74a9a1399a2d92">$elements</a> = array()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Elements registry.  <a href="#a79bcf24c03de22788f74a9a1399a2d92"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Handles discovery, registration and utilization of plugins. </p>

<p>Definition at line <a class="el" href="_plugins_8php_source.html#l00013">13</a> of file <a class="el" href="_plugins_8php_source.html">Plugins.php</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a35839e04a5701ee2b7efdc5ce9c06501"></a><!-- doxytag: member="TemplatePlugins::__construct" ref="a35839e04a5701ee2b7efdc5ce9c06501" args="(array $builtins)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplatePlugins::__construct </td>
          <td>(</td>
          <td class="paramtype">array $&#160;</td>
          <td class="paramname"> <em>builtins</em>&#160;)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Constructor. </p>
<p>Also handles registration of built-ins.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$builtins</td><td>Built-in elements to register </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_plugins_8php_source.html#l00032">32</a> of file <a class="el" href="_plugins_8php_source.html">Plugins.php</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acad3fb00a013432da30dc682905384b0"></a><!-- doxytag: member="TemplatePlugins::load" ref="acad3fb00a013432da30dc682905384b0" args="(TemplateCompilerEx $compiler, $node, $plugin, $pluginFile=null, $noThrow=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplatePlugins::load </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_template_compiler_ex.html">TemplateCompilerEx</a> $&#160;</td>
          <td class="paramname"> <em>compiler</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>node</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>plugin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>pluginFile</em> = <code>null</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>noThrow</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Load single plugin. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$compiler</td><td><a class="el" href="class_template_compiler_ex.html">TemplateCompilerEx</a> instance </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$node</td><td>Optional <a class="el" href="class_template_node_ex.html">TemplateNodeEx</a> instance </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$plugin</td><td>Plugin name </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$pluginFile</td><td>Plugin's full filename (optional) </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$noThrow</td><td>If <code>true</code>, no exception will be thrown on error (boolean <code>false</code> will be returned) </td></tr>
  </table>
  </dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">true</td><td>Plugin has been loaded </td></tr>
    <tr><td class="paramname">false</td><td>Plugin is invalid/non-existant </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_plugins_8php_source.html#l00047">47</a> of file <a class="el" href="_plugins_8php_source.html">Plugins.php</a>.</p>

<p>References <a class="el" href="_utils_8php_source.html#l00191">TemplateUtils::checkIfAllowed()</a>, <a class="el" href="_utils_8php_source.html#l00127">TemplateUtils::doesImplement()</a>, <a class="el" href="_error_8php_source.html#l00069">TemplateError::E_INVALID_PLUGIN</a>, <a class="el" href="_plugins_8php_source.html#l00128">findPlugin()</a>, and <a class="el" href="_plugins_8php_source.html#l00211">registerHooks()</a>.</p>

<p>Referenced by <a class="el" href="_plugins_8php_source.html#l00090">loadMultiple()</a>.</p>

</div>
</div>
<a class="anchor" id="a0bea8d628f5b57b8bf8c930980ab8896"></a><!-- doxytag: member="TemplatePlugins::loadMultiple" ref="a0bea8d628f5b57b8bf8c930980ab8896" args="(TemplateCompilerEx $compiler, $node, $plugins)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplatePlugins::loadMultiple </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_template_compiler_ex.html">TemplateCompilerEx</a> $&#160;</td>
          <td class="paramname"> <em>compiler</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>node</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>plugins</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Load multiple plugins. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$compiler</td><td><a class="el" href="class_template_compiler_ex.html">TemplateCompilerEx</a> instance </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$node</td><td>Optional <a class="el" href="class_template_node_ex.html">TemplateNodeEx</a> instance </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$plugins</td><td>Array (plugins to look for) or boolean ('load all plugins' mode) </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_plugins_8php_source.html#l00090">90</a> of file <a class="el" href="_plugins_8php_source.html">Plugins.php</a>.</p>

<p>References <a class="el" href="_plugins_8php_source.html#l00017">$plugins</a>, <a class="el" href="_plugins_8php_source.html#l00148">findPlugins()</a>, and <a class="el" href="_plugins_8php_source.html#l00047">load()</a>.</p>

</div>
</div>
<a class="anchor" id="a9fdc46282fea5afe6850469897e9a0dd"></a><!-- doxytag: member="TemplatePlugins::known" ref="a9fdc46282fea5afe6850469897e9a0dd" args="($type, $name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplatePlugins::known </td>
          <td>(</td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>name</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Check whether given element is registered. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$type</td><td>Element type (<code>'tag'</code>, <code>'filter'</code>, <code>'hook'</code> or <code>'plugin'</code>) </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$name</td><td>Element name </td></tr>
  </table>
  </dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
  <table class="retval">
    <tr><td class="paramname">true</td><td>Element is registered </td></tr>
    <tr><td class="paramname">false</td><td>Element is not registered </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_plugins_8php_source.html#l00104">104</a> of file <a class="el" href="_plugins_8php_source.html">Plugins.php</a>.</p>

</div>
</div>
<a class="anchor" id="ac2bccff1c1d49f63a0f66efc118220a7"></a><!-- doxytag: member="TemplatePlugins::get" ref="ac2bccff1c1d49f63a0f66efc118220a7" args="($type, $name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">&amp; TemplatePlugins::get </td>
          <td>(</td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>name</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns handler(s) information for given element. </p>
<p>Doesn't check for element's existence.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$type</td><td>Element type (<code>'tag'</code>, <code>'filter'</code> or <code>'hook'</code>) </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$name</td><td>Element name </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Assoc. array </dd></dl>

<p>Definition at line <a class="el" href="_plugins_8php_source.html#l00117">117</a> of file <a class="el" href="_plugins_8php_source.html">Plugins.php</a>.</p>

</div>
</div>
<a class="anchor" id="a1a64cc16940f3fa5ff0a711a803bbe25"></a><!-- doxytag: member="TemplatePlugins::findPlugin" ref="a1a64cc16940f3fa5ff0a711a803bbe25" args="($plugin)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplatePlugins::findPlugin </td>
          <td>(</td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>plugin</em>&#160;)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Looks for plugin file on all search paths. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$plugin</td><td>Plugin name (as string) </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Filename or <code>false</code> </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_template_plugins.html#acad3fb00a013432da30dc682905384b0" title="Load single plugin.">TemplatePlugins::load</a> </dd></dl>

<p>Definition at line <a class="el" href="_plugins_8php_source.html#l00128">128</a> of file <a class="el" href="_plugins_8php_source.html">Plugins.php</a>.</p>

<p>Referenced by <a class="el" href="_plugins_8php_source.html#l00047">load()</a>.</p>

</div>
</div>
<a class="anchor" id="a562e9a9f92fa59024c38398cc6fefc3e"></a><!-- doxytag: member="TemplatePlugins::findPlugins" ref="a562e9a9f92fa59024c38398cc6fefc3e" args="($plugins)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplatePlugins::findPlugins </td>
          <td>(</td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>plugins</em>&#160;)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Looks for multiple plugins' files on all search paths. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$plugins</td><td>Plugins (array or boolean) </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Assoc. array (plugin =&gt; file) </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_template_plugins.html#a0bea8d628f5b57b8bf8c930980ab8896" title="Load multiple plugins.">TemplatePlugins::loadMultiple</a> </dd></dl>

<p>Definition at line <a class="el" href="_plugins_8php_source.html#l00148">148</a> of file <a class="el" href="_plugins_8php_source.html">Plugins.php</a>.</p>

<p>References <a class="el" href="_plugins_8php_source.html#l00017">$plugins</a>, and <a class="el" href="_error_8php_source.html#l00063">TemplateError::E_UNKNOWN_PLUGIN</a>.</p>

<p>Referenced by <a class="el" href="_plugins_8php_source.html#l00090">loadMultiple()</a>.</p>

</div>
</div>
<a class="anchor" id="a30612b19259f49e4525d608cca00936f"></a><!-- doxytag: member="TemplatePlugins::register" ref="a30612b19259f49e4525d608cca00936f" args="($plugin, ITemplatePlugin $pluginObj, $type, array &amp;$handlers)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplatePlugins::register </td>
          <td>(</td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>plugin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="interface_i_template_plugin.html">ITemplatePlugin</a> $&#160;</td>
          <td class="paramname"> <em>pluginObj</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">array &amp;$&#160;</td>
          <td class="paramname"> <em>handlers</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Registers given elements. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$plugin</td><td>Plugin name </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$pluginObj</td><td>Plugin instance </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$type</td><td>Element type (<code>'tag'</code> or <code>'filter'</code>) </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">$handlers</td><td>Array of handlers </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_plugins_8php_source.html#l00186">186</a> of file <a class="el" href="_plugins_8php_source.html">Plugins.php</a>.</p>

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

</div>
</div>
<a class="anchor" id="aadc5f1a6e0ee4961413dd6f5b091619f"></a><!-- doxytag: member="TemplatePlugins::registerHooks" ref="aadc5f1a6e0ee4961413dd6f5b091619f" args="($plugin, ITemplatePlugin $pluginObj, array &amp;$hooks)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplatePlugins::registerHooks </td>
          <td>(</td>
          <td class="paramtype">$&#160;</td>
          <td class="paramname"> <em>plugin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="interface_i_template_plugin.html">ITemplatePlugin</a> $&#160;</td>
          <td class="paramname"> <em>pluginObj</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">array &amp;$&#160;</td>
          <td class="paramname"> <em>hooks</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Register given hooks. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">$plugin</td><td>Plugin name </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">$pluginObj</td><td>Plugin instance </td></tr>
    <tr><td class="paramdir">[in,out]</td><td class="paramname">$hooks</td><td>Array of hooks </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_plugins_8php_source.html#l00211">211</a> of file <a class="el" href="_plugins_8php_source.html">Plugins.php</a>.</p>

<p>Referenced by <a class="el" href="_plugins_8php_source.html#l00047">load()</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a36adfd02aa0e82327f89485df90b3007"></a><!-- doxytag: member="TemplatePlugins::$plugins" ref="a36adfd02aa0e82327f89485df90b3007" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplatePlugins::$plugins = array()<code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Already loaded plugins. </p>

<p>Definition at line <a class="el" href="_plugins_8php_source.html#l00017">17</a> of file <a class="el" href="_plugins_8php_source.html">Plugins.php</a>.</p>

<p>Referenced by <a class="el" href="_plugins_8php_source.html#l00148">findPlugins()</a>, and <a class="el" href="_plugins_8php_source.html#l00090">loadMultiple()</a>.</p>

</div>
</div>
<a class="anchor" id="a79bcf24c03de22788f74a9a1399a2d92"></a><!-- doxytag: member="TemplatePlugins::$elements" ref="a79bcf24c03de22788f74a9a1399a2d92" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplatePlugins::$elements = array()<code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Elements registry. </p>

<p>Definition at line <a class="el" href="_plugins_8php_source.html#l00021">21</a> of file <a class="el" href="_plugins_8php_source.html">Plugins.php</a>.</p>

</div>
</div>
<a class="anchor" id="af9aa580edb4c30ae32a330fe74b6fff4"></a><!-- doxytag: member="TemplatePlugins::$searchPaths" ref="af9aa580edb4c30ae32a330fe74b6fff4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TemplatePlugins::$searchPaths = array()</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Plugins' search paths. </p>
<p>Reference to <code>'pluginsPaths'</code> key of <a class="el" href="class_template_environ.html#a1a6916c9094781e70523b3ed7ba20b68">TemplateEnviron::$settings</a>. </p>

<p>Definition at line <a class="el" href="_plugins_8php_source.html#l00025">25</a> of file <a class="el" href="_plugins_8php_source.html">Plugins.php</a>.</p>

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