php-doc-en/reference/spl/arrayobject/natcasesort.xml
Jakub Vrana 81ee02feed Methods visibility
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322381 c90b9560-bf6c-de11-be94-00142212c4b1
2012-01-17 08:20:53 +00:00

130 lines
3.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="arrayobject.natcasesort" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>ArrayObject::natcasesort</refname>
<refpurpose>Sort an array using a case insensitive "natural order" algorithm</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::natcasesort</methodname>
<void/>
</methodsynopsis>
<para>
This method is a case insensitive version of
<link linkend="arrayobject.natsort">ArrayObject::natsort</link>.
</para>
<para>
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".
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ArrayObject::natcasesort</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$array = array('IMG0.png', 'img12.png', 'img10.png', 'img2.png', 'img1.png', 'IMG3.png');
$arr1 = new ArrayObject($array);
$arr2 = clone $arr1;
$arr1->asort();
echo "Standard sorting\n";
print_r($arr1);
$arr2->natcasesort();
echo "\nNatural order sorting (case-insensitive)\n";
print_r($arr2);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Standard sorting
ArrayObject Object
(
[0] => IMG0.png
[5] => IMG3.png
[4] => img1.png
[2] => img10.png
[1] => img12.png
[3] => img2.png
)
Natural order sorting (case-insensitive)
ArrayObject Object
(
[0] => IMG0.png
[4] => img1.png
[3] => img2.png
[5] => IMG3.png
[2] => img10.png
[1] => img12.png
)
]]>
</screen>
<para>
For more information see: Martin Pool's <link
xlink:href="&url.strnatcmp;">Natural Order String Comparison</link>
page.
</para>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>ArrayObject::asort</methodname></member>
<member><methodname>ArrayObject::ksort</methodname></member>
<member><methodname>ArrayObject::natsort</methodname></member>
<member><methodname>ArrayObject::uasort</methodname></member>
<member><methodname>ArrayObject::uksort</methodname></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->