<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.11 $ -->
<!-- splitted from ./en/functions/array.xml, last change in rev 1.2 -->
  <refentry id="function.ksort">
   <refnamediv>
    <refname>ksort</refname>
    <refpurpose>Sort an array by key</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>ksort</methodname>
      <methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Sorts an array by key, maintaining key to data correlations. This
     is useful mainly for associative arrays.
    </para>
    <para>
     &return.success;
    </para>
    <para>
     <example>
      <title><function>ksort</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php
$fruits = array("d"=>"lemon", "a"=>"orange", "b"=>"banana", "c"=>"apple");
ksort($fruits);
reset($fruits);
while (list($key, $val) = each($fruits)) {
    echo "$key = $val\n";
}
?>
]]>
      </programlisting>
      &example.outputs;
      <screen>
<![CDATA[
a = orange
b = banana
c = apple
d = lemon
]]>
      </screen>
     </example>
    </para>
    <para>
     You may modify the behavior of the sort using the optional
     parameter <parameter>sort_flags</parameter>, for details
     see <function>sort</function>.
    </para>
    <simpara>
     See also <function>asort</function>, <function>arsort</function>,
     <function>krsort</function>, <function>uksort</function>,
     <function>sort</function>, <function>natsort</function>, and
     <function>rsort</function>.
    </simpara>
    <note>
     <para>
      The second parameter was added in PHP 4.
     </para>
    </note>
   </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:"../../../../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
-->