Location: PHPKode > projects > Open Power Template > docs/Opt/api.opt-xml-scannable.sort.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>sort() - 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>sort()</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-xml-scannable.html">Opt_Xml_Scannable</a> &raquo; <a href="api.opt-xml-scannable.sort.html">Opt_Xml_Scannable::sort()</a></p>
	</div>
	
	<div id="content"><dl class="location"><dt><a href="api.opt-xml-scannable.html">7.18. Opt_Xml_Scannable class</a><br/>7.18.16. sort()</dt><dd class="prev">7.18.15. replaceChild()<br/><a href="api.opt-xml-scannable.replace-child.html">&laquo; Previous</a></dd><dd class="next">7.19. Opt_Xml_Text class<br/><a href="api.opt-xml-text.html">Next &raquo;</a></dd></dl>	<h1>7.18.16. sort()</h1><div class="tf_reference"><table><tr><th>Status</th><td>public</td></tr><tr><th>Reference</th><td><code>void sort(Array $prototypes)</code></td></tr></table><hr/></div><p>Changes the order of child nodes to follow the specified rules. It takes an array of tag names in the requested order. It must also include the element <code>*</code> to mark the location of the undefined nodes. An example:</p>

<pre class="php"><span style="color: #000088;">$node</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">sort</span><span style="color: #009900;">&#40;</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;">'opt:foo'</span><span style="color: #339933;">,</span>
    <span style="color: #0000ff;">'opt:bar'</span><span style="color: #339933;">,</span>
    <span style="color: #0000ff;">'*'</span>
<span style="color: #009900;">&#41;</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span></pre>

<p>After the execution of the call above, in the first place, we will have <code>opt:foo</code> tags, later <code>opt:bar</code> and at last, the remaining tags. <code>sort()</code> is widely used in complex instructions to provide the correct order of important sub-tags. For example, <code>opt:if</code> uses the following code to make sure that <code>opt:elseif</code> and <code>opt:else</code> are located at the end of child list:</p>

<pre class="php"><span style="color: #000088;">$node</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">sort</span><span style="color: #009900;">&#40;</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;">'*'</span> <span style="color: #339933;">=&gt;</span> <span style="color: #cc66cc;">0</span><span style="color: #339933;">,</span> <span style="color: #0000ff;">'opt:elseif'</span> <span style="color: #339933;">=&gt;</span> <span style="color: #cc66cc;">1</span><span style="color: #339933;">,</span> <span style="color: #0000ff;">'opt:else'</span> <span style="color: #339933;">=&gt;</span> 2<span style="color: #009900;">&#41;</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span></pre>

<blockquote class="warning">
  <p>If the element <code>*</code> is not specified in <code>$prototypes</code>, the method generates <code>Opt_InvalidAttributes_Exception</code>.</p>
</blockquote>

<!-- # -->

<blockquote class="information">
  <p>The method uses a stable sorting algorithm. It means that it keeps the order of <em>equal</em> nodes.</p>
</blockquote>
<dl class="location location-bottom"><dt>7.18.16. sort()<br/><a href="api.opt-xml-scannable.html">7.18. Opt_Xml_Scannable class</a></dt><dd class="prev"><a href="api.opt-xml-scannable.replace-child.html">&laquo; Previous</a><br/>7.18.15. replaceChild()</dd><dd class="next"><a href="api.opt-xml-text.html">Next &raquo;</a><br/>7.19. Opt_Xml_Text 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