reference/datetime/datetimezone/listidentifiers.xml
02ff7fef5b34cf8f5395180d9d39fb64d9398d00
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="datetimezone.listidentifiers" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>DateTimeZone::listIdentifiers</refname>
...
...
@@ -10,16 +9,16 @@
10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
11
<para>&style.oop;</para>
13
-
<methodsynopsis role="oop">
12
+
<methodsynopsis role="DateTimeZone">
14
13
<modifier>public</modifier> <modifier>static</modifier> <type>array</type><methodname>DateTimeZone::listIdentifiers</methodname>
15
-
<methodparam choice="opt"><type>int</type><parameter>what</parameter><initializer>DateTimeZone::ALL</initializer></methodparam>
16
-
<methodparam choice="opt"><type>string</type><parameter>country</parameter><initializer>&null;</initializer></methodparam>
14
+
<methodparam choice="opt"><type>int</type><parameter>timezoneGroup</parameter><initializer>DateTimeZone::ALL</initializer></methodparam>
15
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>countryCode</parameter><initializer>&null;</initializer></methodparam>
17
16
</methodsynopsis>
18
17
<para>&style.procedural;</para>
19
-
<methodsynopsis role="procedural">
18
+
<methodsynopsis>
20
19
<type>array</type><methodname>timezone_identifiers_list</methodname>
21
-
<methodparam choice="opt"><type>int</type><parameter>what</parameter><initializer>DateTimeZone::ALL</initializer></methodparam>
22
-
<methodparam choice="opt"><type>string</type><parameter>country</parameter><initializer>&null;</initializer></methodparam>
20
+
<methodparam choice="opt"><type>int</type><parameter>timezoneGroup</parameter><initializer>DateTimeZone::ALL</initializer></methodparam>
21
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>countryCode</parameter><initializer>&null;</initializer></methodparam>
23
22
</methodsynopsis>
24
23
</refsect1>
25
24

...
...
@@ -28,22 +27,22 @@
28
27
<para>
29
28
<variablelist>
30
29
<varlistentry>
31
-
<term><parameter>what</parameter></term>
30
+
<term><parameter>timezoneGroup</parameter></term>
32
31
<listitem>
33
32
<para>
34
-
One of <classname>DateTimeZone</classname> class constants.
33
+
One of the <classname>DateTimeZone</classname> class constants (or a combination).
35
34
</para>
36
35
</listitem>
37
36
</varlistentry>
38
37
<varlistentry>
39
-
<term><parameter>country</parameter></term>
38
+
<term><parameter>countryCode</parameter></term>
40
39
<listitem>
41
40
<para>
42
-
A two-letter ISO 3166-1 compatible country code.
41
+
A two-letter (uppercase) ISO 3166-1 compatible country code.
43
42
</para>
44
43
<note>
45
44
<simpara>
46
-
This option is only used when <parameter>what</parameter> is set to
45
+
This option is only used when <parameter>timezoneGroup</parameter> is set to
47
46
<constant>DateTimeZone::PER_COUNTRY</constant>.
48
47
</simpara>
49
48
</note>
...
...
@@ -56,7 +55,10 @@
56
55
<refsect1 role="returnvalues">
57
56
&reftitle.returnvalues;
58
57
<para>
59
-
Returns array on success&return.falseforfailure;.
58
+
Returns the array of timezone identifiers. Only non-outdated items are
59
+
returned. To get all, including outdated timezone identifiers, use the
60
+
<literal>DateTimeZone::ALL_WITH_BC</literal> as value for
61
+
<parameter>timezoneGroup</parameter>.
60
62
</para>
61
63
</refsect1>
62
64
...
...
@@ -73,10 +75,15 @@
73
75
</thead>
74
76
<tbody>
75
77
<row>
76
-
<entry>5.3.0</entry>
78
+
<entry>8.0.0</entry>
79
+
<entry>
80
+
Prior to this version, &false; was returned on failure.
81
+
</entry>
82
+
</row>
83
+
<row>
84
+
<entry>7.1.0</entry>
77
85
<entry>
78
-
Added the optional <parameter>what</parameter> and
79
-
<parameter>country</parameter> parameters.
86
+
<parameter>countryCode</parameter> is nullable now.
80
87
</entry>
81
88
</row>
82
89
</tbody>
...
...
@@ -89,7 +96,7 @@
89
96
&reftitle.examples;
90
97
<para>
91
98
<example>
92
-
<title>A <function>timezone_identifiers_list</function> example</title>
99
+
<title>A <methodname>DateTimeZone::listIdentifiers</methodname> example</title>
93
100
<programlisting role="php">
94
101
<![CDATA[
95
102
<?php
...
...
@@ -112,6 +119,102 @@ Africa/Asmara
112
119
</screen>
113
120
</example>
114
121
</para>
122
+

123
+
<para>
124
+
<example>
125
+
<title>Listing identifiers for a specific region</title>
126
+
<programlisting role="php">
127
+
<![CDATA[
128
+
<?php
129
+
$timezone_identifiers = DateTimeZone::listIdentifiers( DateTimeZone::ASIA );
130
+
for ($i=0; $i < 5; $i++) {
131
+
echo "$timezone_identifiers[$i]\n";
132
+
}
133
+
?>
134
+
]]>
135
+
</programlisting>
136
+
&example.outputs.similar;
137
+
<screen>
138
+
<![CDATA[
139
+
Asia/Aden
140
+
Asia/Almaty
141
+
Asia/Amman
142
+
Asia/Anadyr
143
+
Asia/Aqtau
144
+
]]>
145
+
</screen>
146
+
</example>
147
+
</para>
148
+

149
+
<para>
150
+
<example>
151
+
<title>Listing identifiers for multiple regions</title>
152
+
<programlisting role="php">
153
+
<![CDATA[
154
+
<?php
155
+
$timezone_identifiers = DateTimeZone::listIdentifiers( DateTimeZone::ASIA | DateTimeZone::PACIFIC );
156
+
echo join( ', ', $timezone_identifiers );
157
+
?>
158
+
]]>
159
+
</programlisting>
160
+
&example.outputs.similar;
161
+
<screen>
162
+
<![CDATA[
163
+
Asia/Aden, Asia/Almaty, Asia/Amman, Asia/Anadyr, Asia/Aqtau, Asia/Aqtobe,
164
+
Asia/Ashgabat, Asia/Atyrau, Asia/Baghdad, Asia/Bahrain, Asia/Baku,
165
+
Asia/Bangkok, Asia/Barnaul, Asia/Beirut, Asia/Bishkek, Asia/Brunei,
166
+
Asia/Chita, Asia/Choibalsan, Asia/Colombo, Asia/Damascus, Asia/Dhaka,
167
+
Asia/Dili, Asia/Dubai, Asia/Dushanbe, Asia/Famagusta, Asia/Gaza, Asia/Hebron,
168
+
Asia/Ho_Chi_Minh, Asia/Hong_Kong, Asia/Hovd, Asia/Irkutsk, Asia/Jakarta,
169
+
Asia/Jayapura, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi,
170
+
Asia/Kathmandu, Asia/Khandyga, Asia/Kolkata, Asia/Krasnoyarsk,
171
+
Asia/Kuala_Lumpur, Asia/Kuching, Asia/Kuwait, Asia/Macau, Asia/Magadan,
172
+
Asia/Makassar, Asia/Manila, Asia/Muscat, Asia/Nicosia, Asia/Novokuznetsk,
173
+
Asia/Novosibirsk, Asia/Omsk, Asia/Oral, Asia/Phnom_Penh, Asia/Pontianak,
174
+
Asia/Pyongyang, Asia/Qatar, Asia/Qostanay, Asia/Qyzylorda, Asia/Riyadh,
175
+
Asia/Sakhalin, Asia/Samarkand, Asia/Seoul, Asia/Shanghai, Asia/Singapore,
176
+
Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran,
177
+
Asia/Thimphu, Asia/Tokyo, Asia/Tomsk, Asia/Ulaanbaatar, Asia/Urumqi,
178
+
Asia/Ust-Nera, Asia/Vientiane, Asia/Vladivostok, Asia/Yakutsk, Asia/Yangon,
179
+
Asia/Yekaterinburg, Asia/Yerevan, Pacific/Apia, Pacific/Auckland,
180
+
Pacific/Bougainville, Pacific/Chatham, Pacific/Chuuk, Pacific/Easter,
181
+
Pacific/Efate, Pacific/Fakaofo, Pacific/Fiji, Pacific/Funafuti,
182
+
Pacific/Galapagos, Pacific/Gambier, Pacific/Guadalcanal, Pacific/Guam,
183
+
Pacific/Honolulu, Pacific/Kanton, Pacific/Kiritimati, Pacific/Kosrae,
184
+
Pacific/Kwajalein, Pacific/Majuro, Pacific/Marquesas, Pacific/Midway,
185
+
Pacific/Nauru, Pacific/Niue, Pacific/Norfolk, Pacific/Noumea,
186
+
Pacific/Pago_Pago, Pacific/Palau, Pacific/Pitcairn, Pacific/Pohnpei,
187
+
Pacific/Port_Moresby, Pacific/Rarotonga, Pacific/Saipan, Pacific/Tahiti,
188
+
Pacific/Tarawa, Pacific/Tongatapu, Pacific/Wake, Pacific/Wallis
189
+
]]>
190
+
</screen>
191
+
</example>
192
+
</para>
193
+

194
+
<para>
195
+
<example>
196
+
<title>Listing identifiers for a single country</title>
197
+
<programlisting role="php">
198
+
<![CDATA[
199
+
<?php
200
+
$timezone_identifiers = DateTimeZone::listIdentifiers( DateTimeZone::PER_COUNTRY, "UA" );
201
+
foreach( $timezone_identifiers as $identifier ) {
202
+
echo "$identifier\n";
203
+
}
204
+
?>
205
+
]]>
206
+
</programlisting>
207
+
&example.outputs.similar;
208
+
<screen>
209
+
<![CDATA[
210
+
Europe/Kyiv
211
+
Europe/Simferopol
212
+
Europe/Uzhgorod
213
+
Europe/Zaporozhye
214
+
]]>
215
+
</screen>
216
+
</example>
217
+
</para>
115
218
</refsect1>
116
219

117
220
<refsect1 role="seealso">
...
...
@@ -124,7 +227,6 @@ Africa/Asmara
124
227
</refsect1>
125
228

126
229
</refentry>
127
-

128
230
<!-- Keep this comment at the end of the file
129
231
Local variables:
130
232
mode: sgml
131
233



Tools (Chinese (Simplified) Manual)