Location: PHPKode > projects > Open Power Template > docs/Opt/api.opt-view.set-format-global.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>setFormatGlobal() - 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>setFormatGlobal()</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-view.html">Opt_View</a> &raquo; <a href="api.opt-view.set-format-global.html">Opt_View::setFormatGlobal()</a></p>
	</div>
	
	<div id="content"><dl class="location"><dt><a href="api.opt-view.html">7.2. Opt_View class</a><br/>7.2.29. setFormatGlobal()</dt><dd class="prev">7.2.28. setFormat()<br/><a href="api.opt-view.set-format.html">&laquo; Previous</a></dd><dd class="next">7.2.30. setTemplate()<br/><a href="api.opt-view.set-template.html">Next &raquo;</a></dd></dl>	<h1>7.2.29. setFormatGlobal()</h1><div class="tf_reference"><table><tr><th>Construct</th><td>Static method</td></tr><tr><th>Visibility</th><td>public</td></tr><tr><th>Reference</th><td><code>void setFormatGlobal( string $item, string $format [, boolean $global = true ] )</code></td></tr></table><hr/></div><p>Sets the format to the global template item <code>$name</code>. To get to know more about data formats in OPT, see a chapter about <a href="guide.data-formats.html" title="4.6. Data formats">data formats</a>.</p>

<blockquote class="information">
  <p><code>Opt_View::setFormatGlobal()</code> in fact provides a nice, object-independent wrapper to specify the global variable format without the need of having an <code>Opt_View</code> object. The following two lines are equivalent:</p>

<pre class="php"><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;">'global.variable'</span><span style="color: #339933;">,</span> <span style="color: #0000ff;">'Objective'</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
Opt_View<span style="color: #339933;">::</span><span style="color: #004000;">setFormatGlobal</span><span style="color: #009900;">&#40;</span><span style="color: #0000ff;">'variable'</span><span style="color: #339933;">,</span> <span style="color: #0000ff;">'Objective'</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span></pre>
</blockquote>

<p>If the <code>$global</code> argument is <strong>false</strong>, the method does not prepend <em>global.</em> string to the registered item. It
can be used to specify the data format of the local variable in all the views, instead of one. Note that a particular
view can overwrite this format with <code>setFormat()</code>.</p>

<blockquote class="information">
  <p>The <code>$global</code> attribute is available since OPT 2.0.1.</p>
</blockquote>
<h4>See also:</h4><ul><li><a href="api.opt-view.set-format.html">7.2.28. Opt_View::setFormat()</a></li><li><a href="guide.data-formats.html">4.6. Data formats</a></li></ul><dl class="location location-bottom"><dt>7.2.29. setFormatGlobal()<br/><a href="api.opt-view.html">7.2. Opt_View class</a></dt><dd class="prev"><a href="api.opt-view.set-format.html">&laquo; Previous</a><br/>7.2.28. setFormat()</dd><dd class="next"><a href="api.opt-view.set-template.html">Next &raquo;</a><br/>7.2.30. setTemplate()</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