reference/datetime/datetimezone/listidentifiers.xml
02ff7fef5b34cf8f5395180d9d39fb64d9398d00
...
...
@@ -9,13 +9,13 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<para>&style.oop;</para>
12
-
<methodsynopsis role="oop">
12
+
<methodsynopsis role="DateTimeZone">
13
13
<modifier>public</modifier> <modifier>static</modifier> <type>array</type><methodname>DateTimeZone::listIdentifiers</methodname>
14
14
<methodparam choice="opt"><type>int</type><parameter>timezoneGroup</parameter><initializer>DateTimeZone::ALL</initializer></methodparam>
15
15
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>countryCode</parameter><initializer>&null;</initializer></methodparam>
16
16
</methodsynopsis>
17
17
<para>&style.procedural;</para>
18
-
<methodsynopsis role="procedural">
18
+
<methodsynopsis>
19
19
<type>array</type><methodname>timezone_identifiers_list</methodname>
20
20
<methodparam choice="opt"><type>int</type><parameter>timezoneGroup</parameter><initializer>DateTimeZone::ALL</initializer></methodparam>
21
21
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>countryCode</parameter><initializer>&null;</initializer></methodparam>
...
...
@@ -38,7 +38,7 @@
38
38
<term><parameter>countryCode</parameter></term>
39
39
<listitem>
40
40
<para>
41
-
A two-letter ISO 3166-1 compatible country code.
41
+
A two-letter (uppercase) ISO 3166-1 compatible country code.
42
42
</para>
43
43
<note>
44
44
<simpara>
...
...
@@ -55,7 +55,10 @@
55
55
<refsect1 role="returnvalues">
56
56
&reftitle.returnvalues;
57
57
<para>
58
-
Returns the array of timezone identifiers.
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>.
59
62
</para>
60
63
</refsect1>
61
64
...
...
@@ -93,7 +96,7 @@
93
96
&reftitle.examples;
94
97
<para>
95
98
<example>
96
-
<title>A <function>timezone_identifiers_list</function> example</title>
99
+
<title>A <methodname>DateTimeZone::listIdentifiers</methodname> example</title>
97
100
<programlisting role="php">
98
101
<![CDATA[
99
102
<?php
...
...
@@ -116,6 +119,102 @@ Africa/Asmara
116
119
</screen>
117
120
</example>
118
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>
119
218
</refsect1>
120
219

121
220
<refsect1 role="seealso">
122
221