<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Sort entries using a "natural order" algorithm</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="arrayobject.natcasesort.html">ArrayObject::natcasesort</a></div>
<div class="next" style="text-align: right; float: right;"><a href="arrayobject.offsetexists.html">ArrayObject::offsetExists</a></div>
<div class="up"><a href="class.arrayobject.html">ArrayObject</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="arrayobject.natsort" class="refentry">
<div class="refnamediv">
<h1 class="refname">ArrayObject::natsort</h1>
<p class="verinfo">(PHP 5 >= 5.2.0)</p><p class="refpurpose"><span class="refname">ArrayObject::natsort</span> — <span class="dc-title">Sort entries using a "natural order" algorithm</span></p>
</div>
<div class="refsect1 description" id="refsect1-arrayobject.natsort-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>ArrayObject::natsort</strong></span>
( <span class="methodparam">void</span>
)</div>
<p class="para rdfs-comment">
This method implements a sort algorithm that orders alphanumeric strings
in the way a human being would while maintaining key/value associations.
This is described as a "natural ordering". An example of the difference
between this algorithm and the regular computer string sorting algorithms
(used in <a href="arrayobject.asort.html" class="link">ArrayObject::asort</a>) method
can be seen in the example below.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-arrayobject.natsort-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-arrayobject.natsort-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-arrayobject.natsort-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3988">
<p><strong>Example #1 <span class="function"><strong>ArrayObject::natsort()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$array </span><span style="color: #007700">= array(</span><span style="color: #DD0000">"img12.png"</span><span style="color: #007700">, </span><span style="color: #DD0000">"img10.png"</span><span style="color: #007700">, </span><span style="color: #DD0000">"img2.png"</span><span style="color: #007700">, </span><span style="color: #DD0000">"img1.png"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$arr1 </span><span style="color: #007700">= new </span><span style="color: #0000BB">ArrayObject</span><span style="color: #007700">(</span><span style="color: #0000BB">$array</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$arr2 </span><span style="color: #007700">= clone </span><span style="color: #0000BB">$arr1</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$arr1</span><span style="color: #007700">-></span><span style="color: #0000BB">asort</span><span style="color: #007700">();<br />echo </span><span style="color: #DD0000">"Standard sorting\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$arr1</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$arr2</span><span style="color: #007700">-></span><span style="color: #0000BB">natsort</span><span style="color: #007700">();<br />echo </span><span style="color: #DD0000">"\nNatural order sorting\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$arr2</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Standard sorting
ArrayObject Object
(
[3] => img1.png
[1] => img10.png
[0] => img12.png
[2] => img2.png
)
Natural order sorting
ArrayObject Object
(
[3] => img1.png
[2] => img2.png
[1] => img10.png
[0] => img12.png
)
</pre></div>
</div>
<div class="example-contents"><p>
For more information see: Martin Pool's <a href="http://sourcefrog.net/projects/natsort/" class="link external">» Natural Order String Comparison</a>
page.
</p></div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-arrayobject.natsort-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="arrayobject.asort.html" class="methodname" rel="rdfs-seeAlso">ArrayObject::asort()</a> - Sort the entries by value</span></li>
<li class="member"> <span class="methodname"><a href="arrayobject.ksort.html" class="methodname" rel="rdfs-seeAlso">ArrayObject::ksort()</a> - Sort the entries by key</span></li>
<li class="member"> <span class="methodname"><a href="arrayobject.natcasesort.html" class="methodname" rel="rdfs-seeAlso">ArrayObject::natcasesort()</a> - Sort an array using a case insensitive "natural order" algorithm</span></li>
<li class="member"> <span class="methodname"><a href="arrayobject.uasort.html" class="methodname" rel="rdfs-seeAlso">ArrayObject::uasort()</a> - Sort the entries with a user-defined comparison function and maintain key association</span></li>
<li class="member"> <span class="methodname"><a href="arrayobject.uksort.html" class="methodname" rel="rdfs-seeAlso">ArrayObject::uksort()</a> - Sort the entries by keys using a user-defined comparison function</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="arrayobject.natcasesort.html">ArrayObject::natcasesort</a></div>
<div class="next" style="text-align: right; float: right;"><a href="arrayobject.offsetexists.html">ArrayObject::offsetExists</a></div>
<div class="up"><a href="class.arrayobject.html">ArrayObject</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
