mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 06:18:56 +00:00
14af302c9c
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334762 c90b9560-bf6c-de11-be94-00142212c4b1
145 lines
3.4 KiB
XML
145 lines
3.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="arrayobject.uasort" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ArrayObject::uasort</refname>
|
|
<refpurpose>Sort the entries with a user-defined comparison function and maintain key association</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::uasort</methodname>
|
|
<methodparam><type>callable</type><parameter>cmp_function</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function sorts the entries such that keys maintain their
|
|
correlation with the entry that they are associated with, using a
|
|
user-defined comparison function.
|
|
</para>
|
|
<para>
|
|
This is used mainly when sorting associative arrays where the actual
|
|
element order is significant.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>cmp_function</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Function <parameter>cmp_function</parameter> should accept two
|
|
parameters which will be filled by pairs of entries.
|
|
The comparison function must return an integer less than, equal
|
|
to, or greater than zero if the first argument is considered to
|
|
be respectively less than, equal to, or greater than the
|
|
second.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.void;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>ArrayObject::uasort</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Comparison function
|
|
function cmp($a, $b) {
|
|
if ($a == $b) {
|
|
return 0;
|
|
}
|
|
return ($a < $b) ? -1 : 1;
|
|
}
|
|
|
|
// Array to be sorted
|
|
$array = array('a' => 4, 'b' => 8, 'c' => -1, 'd' => -9, 'e' => 2, 'f' => 5, 'g' => 3, 'h' => -4);
|
|
$arrayObject = new ArrayObject($array);
|
|
print_r($arrayObject);
|
|
|
|
// Sort and print the resulting array
|
|
$arrayObject->uasort('cmp');
|
|
print_r($arrayObject);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Array
|
|
(
|
|
[a] => 4
|
|
[b] => 8
|
|
[c] => -1
|
|
[d] => -9
|
|
[e] => 2
|
|
[f] => 5
|
|
[g] => 3
|
|
[h] => -4
|
|
)
|
|
Array
|
|
(
|
|
[d] => -9
|
|
[h] => -4
|
|
[c] => -1
|
|
[e] => 2
|
|
[g] => 3
|
|
[a] => 4
|
|
[f] => 5
|
|
[b] => 8
|
|
)
|
|
]]>
|
|
</screen>
|
|
</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::natcasesort</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
|
|
-->
|