<!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 an array using a case insensitive "natural order" algorithm</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.list.html">list</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.natsort.html">natsort</a></div>
<div class="up"><a href="ref.array.html">Array Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.natcasesort" class="refentry">
<div class="refnamediv">
<h1 class="refname">natcasesort</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">natcasesort</span> — <span class="dc-title">Sort an array using a case insensitive "natural order" algorithm</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.natcasesort-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>natcasesort</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$array</code></span>
)</div>
<p class="para rdfs-comment">
<span class="function"><strong>natcasesort()</strong></span> is a case insensitive version of
<span class="function"><a href="function.natsort.html" class="function">natsort()</a></span>.
</p>
<p class="para">
This function 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".
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.natcasesort-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">array</code></em></span>
<dd>
<p class="para">
The input array.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.natcasesort-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.natcasesort-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5023">
<p><strong>Example #1 <span class="function"><strong>natcasesort()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$array1 </span><span style="color: #007700">= </span><span style="color: #0000BB">$array2 </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'IMG0.png'</span><span style="color: #007700">, </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">, </span><span style="color: #DD0000">'IMG3.png'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">sort</span><span style="color: #007700">(</span><span style="color: #0000BB">$array1</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">$array1</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">natcasesort</span><span style="color: #007700">(</span><span style="color: #0000BB">$array2</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"\nNatural order sorting (case-insensitive)\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">$array2</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
Array
(
[0] => IMG0.png
[1] => IMG3.png
[2] => img1.png
[3] => img10.png
[4] => img12.png
[5] => img2.png
)
Natural order sorting (case-insensitive)
Array
(
[0] => IMG0.png
[4] => img1.png
[3] => img2.png
[5] => IMG3.png
[2] => img10.png
[1] => 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-function.natcasesort-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.natsort.html" class="function" rel="rdfs-seeAlso">natsort()</a> - Sort an array using a "natural order" algorithm</span></li>
<li class="member">The <a href="array.sorting.html" class="link">comparison of array sorting functions</a></li>
<li class="member"> <span class="function"><a href="function.strnatcmp.html" class="function" rel="rdfs-seeAlso">strnatcmp()</a> - String comparisons using a "natural order" algorithm</span></li>
<li class="member"> <span class="function"><a href="function.strnatcasecmp.html" class="function" rel="rdfs-seeAlso">strnatcasecmp()</a> - Case insensitive string comparisons using a "natural order" algorithm</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="function.list.html">list</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.natsort.html">natsort</a></div>
<div class="up"><a href="ref.array.html">Array Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
