reference/intl/locale/get-display-name.xml
1976eae0d815797af97a1e16c5cd90ffc2868395
...
...
@@ -1,6 +1,6 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="locale.getdisplayname">
3
+
<refentry xml:id="locale.getdisplayname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
4
4
<refnamediv>
5
5
<refname>Locale::getDisplayName</refname>
6
6
<refname>locale_get_display_name</refname>
...
...
@@ -12,25 +12,21 @@
12
12
<para>
13
13
&style.oop;
14
14
</para>
15
-
<methodsynopsis>
16
-
<modifier>public</modifier>
17
-
<modifier>static</modifier>
18
-
<type>string</type>
19
-
<methodname>Locale::getDisplayName</methodname>
15
+
<methodsynopsis role="Locale">
16
+
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>Locale::getDisplayName</methodname>
20
17
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
21
-
<methodparam choice="opt"><type>string</type><parameter>in_locale</parameter></methodparam>
18
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>displayLocale</parameter><initializer>&null;</initializer></methodparam>
22
19
</methodsynopsis>
23
20
<para>
24
21
&style.procedural;
25
22
</para>
26
23
<methodsynopsis>
27
-
<type>string</type>
28
-
<methodname>locale_get_display_name</methodname>
24
+
<type class="union"><type>string</type><type>false</type></type><methodname>locale_get_display_name</methodname>
29
25
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
30
-
<methodparam choice="opt"><type>string</type><parameter>in_locale</parameter></methodparam>
26
+
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>displayLocale</parameter><initializer>&null;</initializer></methodparam>
31
27
</methodsynopsis>
32
28
<para>
33
-
Returns an appropriately localized display name for the input locale. If is
29
+
Returns an appropriately localized display name for the input locale. If <parameter>locale</parameter> is
34
30
&null; then the default locale is used.
35
31
</para>
36
32
</refsect1>
...
...
@@ -48,7 +44,7 @@
48
44
</listitem>
49
45
</varlistentry>
50
46
<varlistentry>
51
-
<term><parameter>in_locale</parameter></term>
47
+
<term><parameter>displayLocale</parameter></term>
52
48
<listitem>
53
49
<para>optional format locale</para>
54
50
</listitem>
...
...
@@ -57,14 +53,35 @@
57
53
</para>
58
54
</refsect1>
59
55

60
-

61
56
<refsect1 role="returnvalues">
62
57
&reftitle.returnvalues;
63
58
<para>
64
-
Display name of the locale in the format appropriate for $in_locale.
59
+
Display name of the locale in the format appropriate for <parameter>displayLocale</parameter>, &return.falseforfailure;.
65
60
</para>
66
61
</refsect1>
67
62

63
+
<refsect1 role="changelog">
64
+
&reftitle.changelog;
65
+
<informaltable>
66
+
<tgroup cols="2">
67
+
<thead>
68
+
<row>
69
+
<entry>&Version;</entry>
70
+
<entry>&Description;</entry>
71
+
</row>
72
+
</thead>
73
+
<tbody>
74
+
<row>
75
+
<entry>8.0.0</entry>
76
+
<entry>
77
+
<parameter>displayLocale</parameter> is nullable now.
78
+
</entry>
79
+
</row>
80
+
</tbody>
81
+
</tgroup>
82
+
</informaltable>
83
+
</refsect1>
84
+

68
85
<refsect1 role="examples">
69
86
&reftitle.examples;
70
87
<example>
71
88