reference/datetime/datetimezone/listabbreviations.xml
02ff7fef5b34cf8f5395180d9d39fb64d9398d00
02ff7fef5b34cf8f5395180d9d39fb64d9398d00
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
4
3
<refentry xml:id="datetimezone.listabbreviations" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>DateTimeZone::listAbbreviations</refname>
...
...
@@ -10,21 +9,42 @@
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::listAbbreviations</methodname>
15
14
<void/>
16
15
</methodsynopsis>
17
16
<para>&style.procedural;</para>
18
-
<methodsynopsis role="procedural">
17
+
<methodsynopsis>
19
18
<type>array</type><methodname>timezone_abbreviations_list</methodname>
20
19
<void/>
21
20
</methodsynopsis>
21
+
<para>
22
+
The returned list of abbreviations includes all historical use of
23
+
abbreviations, which can lead to correct, but confusing entries.
24
+
There are also conflicts, as <literal>PST</literal> is used both in the US
25
+
and in the Philippines.
26
+
</para>
27
+
<para>
28
+
The list that this function returns is therefore not suitable for building
29
+
an array with options to present a choice of timezone to users.
30
+
</para>
31
+
<note>
32
+
<para>
33
+
The data for this function are precompiled for performance reasons, and are not updated
34
+
when using a newer <link xlink:href="&url.pecl.package;timezonedb">timezonedb</link>.
35
+
</para>
36
+
</note>
37
+
</refsect1>
38
+
39
+
<refsect1 role="parameters">
40
+
&reftitle.parameters;
41
+
&no.function.parameters;
22
42
</refsect1>
23
43
24
44
<refsect1 role="returnvalues">
25
45
&reftitle.returnvalues;
26
46
<para>
27
-
Returns array on success&return.falseforfailure;.
47
+
Returns the array of timezone abbreviations.
28
48
</para>
29
49
</refsect1>
30
50
...
...
@@ -91,7 +111,6 @@ Array
91
111
</refsect1>
92
112
93
113
</refentry>
94
-
95
114
<!-- Keep this comment at the end of the file
96
115
Local variables:
97
116
mode: sgml
98
117