mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-23 04:18:56 +00:00

still using this, after discussion on the phpdoc list. From now on, manual.ced will need to be found at ~/.phpdoc/manual.ced. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@288721 c90b9560-bf6c-de11-be94-00142212c4b1
131 lines
3.1 KiB
XML
131 lines
3.1 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.natcasesort" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>natcasesort</refname>
|
|
<refpurpose>Sort an array using a case insensitive "natural order" algorithm</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>natcasesort</methodname>
|
|
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>natcasesort</function> is a case insensitive version of
|
|
<function>natsort</function>.
|
|
</para>
|
|
<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".
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>array</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The input array.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>natcasesort</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$array1 = $array2 = array('IMG0.png', 'img12.png', 'img10.png', 'img2.png', 'img1.png', 'IMG3.png');
|
|
|
|
sort($array1);
|
|
echo "Standard sorting\n";
|
|
print_r($array1);
|
|
|
|
natcasesort($array2);
|
|
echo "\nNatural order sorting (case-insensitive)\n";
|
|
print_r($array2);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
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
|
|
)
|
|
]]>
|
|
</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><function>natsort</function></member>
|
|
<member>&seealso.array.sorting;</member>
|
|
<member><function>strnatcmp</function></member>
|
|
<member><function>strnatcasecmp</function></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
|
|
-->
|