Location: PHPKode > projects > Open Power Template > docs/Opt/api.opt-generator-interface.generate.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>generate() - 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>generate()</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-generator-interface.html">Opt_Generator_Interface</a> &raquo; <a href="api.opt-generator-interface.generate.html">Opt_Generator_Interface::generate()</a></p>
	</div>
	
	<div id="content"><dl class="location"><dt><a href="api.opt-generator-interface.html">7.23. Opt_Generator_Interface</a><br/>7.23.1. generate()</dt><dd class="prev">7.23. Opt_Generator_Interface<br/><a href="api.opt-generator-interface.html">&laquo; Previous</a></dd><dd class="next">7.24. Opt_Output_Interface class<br/><a href="api.opt-output-interface.html">Next &raquo;</a></dd></dl>	<h1>7.23.1. generate()</h1><div class="tf_reference"><table><tr><th>Construct</th><td>Abstract method</td></tr><tr><th>Visibility</th><td>public</td></tr><tr><th>Reference</th><td><code>mixed generate(string $what)</code></td></tr><tr><th>Argument list</th><td><dl><dt><code>$what</code> <small>- string</small></dt><dd>The section name that the generator was used in.</dd></dl></td></tr><tr><th>Returned value</th><td>The section data.</td></tr></table><hr/></div><p>Generates the data for the section. The data format provides the section name with the <code>$what</code> attribute, so that one class may support different sections.</p>

<p>A sample generator:</p>

<pre class="php"><span style="color: #000000; font-weight: bold;">class</span> myGenerator implements Opt_Generator_Interface
<span style="color: #009900;">&#123;</span>
    <span style="color: #000000; font-weight: bold;">public</span> <span style="color: #000000; font-weight: bold;">function</span> generate<span style="color: #009900;">&#40;</span><span style="color: #000088;">$what</span><span style="color: #009900;">&#41;</span>
    <span style="color: #009900;">&#123;</span>
        <span style="color: #b1b100;">return</span> <a href="http://www.php.net/array"><span style="color: #990000;">array</span></a><span style="color: #009900;">&#40;</span>0 <span style="color: #339933;">=&gt;</span>
            <a href="http://www.php.net/array"><span style="color: #990000;">array</span></a><span style="color: #009900;">&#40;</span><span style="color: #0000ff;">'item'</span> <span style="color: #339933;">=&gt;</span> <span style="color: #0000ff;">'Item 1'</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">,</span>
            <a href="http://www.php.net/array"><span style="color: #990000;">array</span></a><span style="color: #009900;">&#40;</span><span style="color: #0000ff;">'item'</span> <span style="color: #339933;">=&gt;</span> <span style="color: #0000ff;">'Item 2'</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">,</span>
            <a href="http://www.php.net/array"><span style="color: #990000;">array</span></a><span style="color: #009900;">&#40;</span><span style="color: #0000ff;">'item'</span> <span style="color: #339933;">=&gt;</span> <span style="color: #0000ff;">'Item 3'</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">,</span>
        <span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
    <span style="color: #009900;">&#125;</span> <span style="color: #666666; font-style: italic;">// end generate();</span>
<span style="color: #009900;">&#125;</span> <span style="color: #666666; font-style: italic;">// end myGenerator;</span>
&nbsp;
<span style="color: #000088;">$view</span> <span style="color: #339933;">=</span> <span style="color: #000000; font-weight: bold;">new</span> Opt_View<span style="color: #009900;">&#40;</span><span style="color: #0000ff;">'view.tpl'</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
<span style="color: #000088;">$view</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">section</span> <span style="color: #339933;">=</span> <span style="color: #000000; font-weight: bold;">new</span> myGenerator<span style="color: #009900;">&#40;</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
<span style="color: #000088;">$view</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">setFormat</span><span style="color: #009900;">&#40;</span><span style="color: #0000ff;">'section'</span><span style="color: #339933;">,</span> <span style="color: #0000ff;">'RuntimeGenerator/Array'</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span></pre>

<p>The template:</p>

<pre class="xml"><span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;?xml</span> <span style="color: #000066;">version</span>=<span style="color: #ff0000;">&quot;1.0&quot;</span> <span style="color: #000000; font-weight: bold;">?&gt;</span></span>
<span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;opt:root<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
    <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;opt:section</span> <span style="color: #000066;">name</span>=<span style="color: #ff0000;">&quot;section&quot;</span><span style="color: #000000; font-weight: bold;">&gt;</span></span>
        <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;p<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>{$section.item}<span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/p<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
    <span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/opt:section<span style="color: #000000; font-weight: bold;">&gt;</span></span></span>
<span style="color: #009900;"><span style="color: #000000; font-weight: bold;">&lt;/opt:root<span style="color: #000000; font-weight: bold;">&gt;</span></span></span></pre>
<dl class="location location-bottom"><dt>7.23.1. generate()<br/><a href="api.opt-generator-interface.html">7.23. Opt_Generator_Interface</a></dt><dd class="prev"><a href="api.opt-generator-interface.html">&laquo; Previous</a><br/>7.23. Opt_Generator_Interface</dd><dd class="next"><a href="api.opt-output-interface.html">Next &raquo;</a><br/>7.24. Opt_Output_Interface class</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