1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
|
<?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 role="ArrayObject">
<modifier>public</modifier> <type>true</type><methodname>ArrayObject::uasort</methodname>
<methodparam><type>callable</type><parameter>callback</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>
¬e.sort-unstable;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>callback</parameter></term>
<listitem>
&sort.callback.description;
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.true.always;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&return.type.true;
</tbody>
</tgroup>
</informaltable>
</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);
var_dump($arrayObject);
// Sort and print the resulting array
$arrayObject->uasort('cmp');
var_dump($arrayObject);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
object(ArrayObject)#1 (1) {
["storage":"ArrayObject":private]=>
array(8) {
["a"]=>
int(4)
["b"]=>
int(8)
["c"]=>
int(-1)
["d"]=>
int(-9)
["e"]=>
int(2)
["f"]=>
int(5)
["g"]=>
int(3)
["h"]=>
int(-4)
}
}
object(ArrayObject)#1 (1) {
["storage":"ArrayObject":private]=>
array(8) {
["d"]=>
int(-9)
["h"]=>
int(-4)
["c"]=>
int(-1)
["e"]=>
int(2)
["g"]=>
int(3)
["a"]=>
int(4)
["f"]=>
int(5)
["b"]=>
int(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>
<member><function>uasort</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
-->
|