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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->
<refentry xml:id="collator.sort" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>Collator::sort</refname>
<refname>collator_sort</refname>
<refpurpose>Sort array using specified collator</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
Object oriented style
</para>
<methodsynopsis>
<type>bool</type>
<methodname>Collator::sort</methodname>
<methodparam><type>array</type><parameter role="reference">arr</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>sort_flag</parameter></methodparam>
</methodsynopsis>
<para>
Procedural style
</para>
<methodsynopsis>
<type>bool</type>
<methodname>collator_sort</methodname>
<methodparam><type>Collator</type><parameter>coll</parameter></methodparam>
<methodparam><type>array</type><parameter role="reference">arr</parameter></methodparam>
<methodparam choice="opt"><type>integer</type><parameter>sort_flag</parameter></methodparam>
</methodsynopsis>
<para>This function sorts an array according to current locale rules.</para>
<para>
Equivalent to standard PHP
<function>sort</function> .
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>coll</parameter></term>
<listitem>
<para>
<classname>Collator</classname> object.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>arr</parameter></term>
<listitem>
<para>
Array of strings to sort.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>sort_flag</parameter></term>
<listitem>
<para>
Optional sorting type, one of the following:
</para>
<para>
<itemizedlist>
<listitem>
<para>
<constant>Collator::SORT_REGULAR</constant>
- compare items normally (don't change types)
</para>
</listitem>
<listitem>
<para>
<constant>Collator::SORT_NUMERIC</constant>
- compare items numerically
</para>
</listitem>
<listitem>
<para>
<constant>Collator::SORT_STRING</constant>
- compare items as strings
</para>
</listitem>
</itemizedlist>
Default sorting type is <constant>Collator::SORT_REGULAR</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>collator_sort</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$coll = collator_create( 'en_US' );
$arr = array( 'at', 'às', 'as' );
var_export( $arr );
collator_sort( $coll, $arr );
var_export( $arr );
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array (
0 => 'at',
1 => 'às',
2 => 'as',
)array (
0 => 'as',
1 => 'às',
2 => 'at',
)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link linkend="intl.collator-constants"><classname>Collator</classname> constants</link></member>
<member><function>collator_asort</function></member>
<member><function>collator_sort_with_sort_keys</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:"../../../../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
-->
|
