reference/array/functions/rsort.xml
2ca090342977839edca2f7f4e52305a1b5da6095
...
...
@@ -3,20 +3,24 @@
3
3
<refentry xml:id="function.rsort" xmlns="http://docbook.org/ns/docbook">
4
4
<refnamediv>
5
5
<refname>rsort</refname>
6
-
<refpurpose>Sort an array in reverse order</refpurpose>
6
+
<refpurpose>Sort an array in descending order</refpurpose>
7
7
</refnamediv>
8
8
<refsect1 role="description">
9
9
&reftitle.description;
10
10
<methodsynopsis>
11
-
<type>bool</type><methodname>rsort</methodname>
11
+
<type>true</type><methodname>rsort</methodname>
12
12
<methodparam><type>array</type><parameter role="reference">array</parameter></methodparam>
13
-
<methodparam choice="opt"><type>int</type><parameter>sort_flags</parameter><initializer>SORT_REGULAR</initializer></methodparam>
13
+
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>SORT_REGULAR</constant></initializer></methodparam>
14
14
</methodsynopsis>
15
15
<para>
16
-
This function sorts an array in reverse order (highest to lowest).
16
+
Sorts <parameter>array</parameter> in place by values
17
+
in descending order.
17
18
</para>
18
19
&note.sort-unstable;
20
+
&note.no-key-association;
21
+
&note.reset-index;
19
22
</refsect1>
23
+

20
24
<refsect1 role="parameters">
21
25
&reftitle.parameters;
22
26
<para>
...
...
@@ -29,25 +33,37 @@
29
33
</para>
30
34
</listitem>
31
35
</varlistentry>
32
-
<varlistentry>
33
-
<term><parameter>sort_flags</parameter></term>
34
-
<listitem>
35
-
<para>
36
-
You may modify the behavior of the sort using the optional
37
-
parameter <parameter>sort_flags</parameter>, for details see
38
-
<function>sort</function>.
39
-
</para>
40
-
</listitem>
41
-
</varlistentry>
36
+
&sort.flags.parameter;
42
37
</variablelist>
43
38
</para>
44
39
</refsect1>
40
+

45
41
<refsect1 role="returnvalues">
46
42
&reftitle.returnvalues;
47
43
<para>
48
-
&return.success;
44
+
&return.true.always;
49
45
</para>
50
46
</refsect1>
47
+

48
+
<refsect1 role="changelog">
49
+
&reftitle.changelog;
50
+
<para>
51
+
<informaltable>
52
+
<tgroup cols="2">
53
+
<thead>
54
+
<row>
55
+
<entry>&Version;</entry>
56
+
<entry>&Description;</entry>
57
+
</row>
58
+
</thead>
59
+
<tbody>
60
+
&return.type.true;
61
+
</tbody>
62
+
</tgroup>
63
+
</informaltable>
64
+
</para>
65
+
</refsect1>
66
+

51
67
<refsect1 role="examples">
52
68
&reftitle.examples;
53
69
<para>
...
...
@@ -79,22 +95,18 @@ foreach ($fruits as $key => $val) {
79
95
</example>
80
96
</para>
81
97
</refsect1>
82
-
<refsect1 role="notes">
83
-
&reftitle.notes;
84
-
&note.no-key-association;
85
-
</refsect1>
98
+

86
99
<refsect1 role="seealso">
87
100
&reftitle.seealso;
88
-
<para>
89
-
<simplelist>
90
-
<member><function>arsort</function></member>
91
-
<member><function>krsort</function></member>
92
-
<member>&seealso.array.sorting;</member>
93
-
</simplelist>
94
-
</para>
101
+
<simplelist>
102
+
<member><function>sort</function></member>
103
+
<member><function>arsort</function></member>
104
+
<member><function>krsort</function></member>
105
+
<member>&seealso.array.sorting;</member>
106
+
</simplelist>
95
107
</refsect1>
96
-
</refentry>
97
108

109
+
</refentry>
98
110
<!-- Keep this comment at the end of the file
99
111
Local variables:
100
112
mode: sgml
101
113