Location: PHPKode > projects > Open Power Template > docs/Opt/api.opt-class.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="pl">
<head>
	<meta http-equiv="content-type" content="text/html; charset=utf-8" />
	<meta name="robots" content="all" />

	<title>Opt_Class class - Open Power Template</title>
	
	<link rel="stylesheet" type="text/css" href="design/generic.css" media="all"  />
	<link rel="stylesheet" type="text/css" href="design/print.css" media="print" />
	<!--[if lte IE 6]><link rel="stylesheet" href="design/ie.css" type="text/css" /><![endif]-->	
	<!--[if IE 7]><link rel="stylesheet" href="design/ie7.css" type="text/css" /><![endif]-->
</head>
<body>

<div id="wrap">
	<div id="header">
		<h1>Open Power Template 2.0</h1>
		<h2>Opt_Class class</h2>
		<p class="generated">@ 02.09.2010</p>
		<p class="location"><a href="index.html"><strong>User manual</strong></a> &raquo; <a href="api.html">API Reference</a> &raquo; <a href="api.opt-class.html">Opt_Class</a></p>
	</div>
	
	<div id="content"><dl class="location"><dt><a href="api.html">7. API Reference</a><br/>7.1. Opt_Class class</dt><dd class="prev">7. API Reference<br/><a href="api.html">&laquo; Previous</a></dd><dd class="next">7.1.1. getBufferState()<br/><a href="api.opt-class.get-buffer-state.html">Next &raquo;</a></dd></dl>	<h1>7.1. Opt_Class class</h1><h4>Table of Contents</h4><ul class="toc"><li><a href="api.opt-class.get-buffer-state.html">7.1.1. getBufferState()</a></li><li><a href="api.opt-class.get-cache.html">7.1.2. getCache()</a></li><li><a href="api.opt-class.get-compiler.html">7.1.3. getCompiler()</a></li><li><a href="api.opt-class.get-translation-interface.html">7.1.4. getTranslationInterface()</a></li><li><a href="api.opt-class.load-config.html">7.1.5. loadConfig()</a></li><li><a href="api.opt-class.register.html">7.1.6. register()</a></li><li><a href="api.opt-class.set-buffer-state.html">7.1.7. setBufferState()</a></li><li><a href="api.opt-class.set-cache.html">7.1.8. setCache()</a></li><li><a href="api.opt-class.set-translation-interface.html">7.1.9. setTranslationInterface()</a></li><li><a href="api.opt-class.setup.html">7.1.10. setup()</a></li></ul><div class="tf_reference"><table><tr><th>Construct</th><td>Class</td></tr></table><hr/></div><p>This is the main class of Open Power Template. It provides the configuration, plugin support and initialization issues. You need only one object of this class in your script. Below, a sample initialization is shown:</p>

<pre class="php"><span style="color: #000088;">$tpl</span> <span style="color: #339933;">=</span> <span style="color: #000000; font-weight: bold;">new</span> Opt_Class<span style="color: #339933;">;</span>
<span style="color: #666666; font-style: italic;">// Load part of the configuration from the external INI file</span>
<span style="color: #000088;">$tpl</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">loadConfig</span><span style="color: #009900;">&#40;</span><span style="color: #0000ff;">'./someconfig.ini'</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
&nbsp;
<span style="color: #666666; font-style: italic;">// Configure the paths</span>
<span style="color: #000088;">$tpl</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">sourceDir</span> <span style="color: #339933;">=</span> <span style="color: #0000ff;">'./templates/'</span><span style="color: #339933;">;</span>
<span style="color: #000088;">$tpl</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">compileDir</span> <span style="color: #339933;">=</span> <span style="color: #0000ff;">'./templates_c/'</span><span style="color: #339933;">;</span>
&nbsp;
<span style="color: #666666; font-style: italic;">// Register new add-ons</span>
<span style="color: #000088;">$tpl</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">register</span><span style="color: #009900;">&#40;</span>Opt_Class<span style="color: #339933;">::</span><span style="color: #004000;">OPT_COMPONENT</span><span style="color: #339933;">,</span> <span style="color: #0000ff;">'opt:myComponent'</span><span style="color: #339933;">,</span> <span style="color: #0000ff;">'My_Component_Class'</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
&nbsp;
<span style="color: #666666; font-style: italic;">// Perform the initialization</span>
<span style="color: #000088;">$tpl</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">setup</span><span style="color: #009900;">&#40;</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span></pre>

<p>Now we can create <a href="api.opt-view.html" title="7.2. Opt_View">Opt_View</a> objects and parse the templates.</p>

<blockquote class="error">
  <p>Do not forget to call <a href="api.opt-class.setup.html" title="7.1.10. Opt_Class::setup()">Opt_Class::setup()</a> method.</p>
</blockquote>
<dl class="location location-bottom"><dt>7.1. Opt_Class class<br/><a href="api.html">7. API Reference</a></dt><dd class="prev"><a href="api.html">&laquo; Previous</a><br/>7. API Reference</dd><dd class="next"><a href="api.opt-class.get-buffer-state.html">Next &raquo;</a><br/>7.1.1. getBufferState()</dd></dl>		</div>
	
	<div id="footer">
		<p>Copyright &copy; <a href="http://www.invenzzia.org/">Invenzzia Group 2008-2009</a></p>
		<p>Available under the terms of license: <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License 1.2</a></p>
		<p>Generated by <strong>TypeFriendly 0.1.4</strong> by <a href="http://www.invenzzia.org/">Invenzzia</a></p>
	</div>
</div>

</body>
</html>
Return current item: Open Power Template