reference/spl/arrayobject/uksort.xml
2226ad08fd93e3979efbba47c5ae3545eec97d25
...
...
@@ -7,14 +7,15 @@
7
7
</refnamediv>
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
-
<methodsynopsis>
11
-
<modifier>public</modifier> <type>void</type><methodname>ArrayObject::uksort</methodname>
12
-
<methodparam><type>callable</type><parameter>cmp_function</parameter></methodparam>
10
+
<methodsynopsis role="ArrayObject">
11
+
<modifier>public</modifier> <type>true</type><methodname>ArrayObject::uksort</methodname>
12
+
<methodparam><type>callable</type><parameter>callback</parameter></methodparam>
13
13
</methodsynopsis>
14
14
<para>
15
15
This function sorts the keys of the entries using a user-supplied
16
16
comparison function. The key to entry correlations will be maintained.
17
17
</para>
18
+
&note.sort-unstable;
18
19
</refsect1>
19
20

20
21
<refsect1 role="parameters">
...
...
@@ -22,19 +23,9 @@
22
23
<para>
23
24
<variablelist>
24
25
<varlistentry>
25
-
<term><parameter>cmp_function</parameter></term>
26
+
<term><parameter>callback</parameter></term>
26
27
<listitem>
27
-
<para>
28
-
The callback comparison function.
29
-
</para>
30
-
<para>
31
-
Function <parameter>cmp_function</parameter> should accept two
32
-
parameters which will be filled by pairs of entry keys.
33
-
The comparison function must return an integer less than, equal
34
-
to, or greater than zero if the first argument is considered to
35
-
be respectively less than, equal to, or greater than the
36
-
second.
37
-
</para>
28
+
&sort.callback.description;
38
29
</listitem>
39
30
</varlistentry>
40
31
</variablelist>
...
...
@@ -44,7 +35,26 @@
44
35
<refsect1 role="returnvalues">
45
36
&reftitle.returnvalues;
46
37
<para>
47
-
&return.void;
38
+
&return.true.always;
39
+
</para>
40
+
</refsect1>
41
+

42
+
<refsect1 role="changelog">
43
+
&reftitle.changelog;
44
+
<para>
45
+
<informaltable>
46
+
<tgroup cols="2">
47
+
<thead>
48
+
<row>
49
+
<entry>&Version;</entry>
50
+
<entry>&Description;</entry>
51
+
</row>
52
+
</thead>
53
+
<tbody>
54
+
&return.type.true;
55
+
</tbody>
56
+
</tgroup>
57
+
</informaltable>
48
58
</para>
49
59
</refsect1>
50
60

...
...
@@ -94,12 +104,12 @@ John: 1
94
104
<member><methodname>ArrayObject::natsort</methodname></member>
95
105
<member><methodname>ArrayObject::natcasesort</methodname></member>
96
106
<member><methodname>ArrayObject::uasort</methodname></member>
107
+
<member><function>uksort</function></member>
97
108
</simplelist>
98
109
</para>
99
110
</refsect1>
100
111

101
112
</refentry>
102
-

103
113
<!-- Keep this comment at the end of the file
104
114
Local variables:
105
115
mode: sgml
...
...
@@ -120,4 +130,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
120
130
vim: et tw=78 syn=sgml
121
131
vi: ts=1 sw=1
122
132
-->
123
-

124
133