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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.3 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="messageformatter.formatmessage">
<refnamediv>
<refname>MessageFormatter::formatMessage</refname>
<refname>msgfmt_format_message</refname>
<refpurpose>Quick format message</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<para>
Object oriented style
</para>
<methodsynopsis>
<modifier>static</modifier>
<type>string</type>
<methodname>MessageFormatter::formatMessage</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>array</type><parameter>args</parameter></methodparam>
</methodsynopsis>
<para>
Procedural style
</para>
<methodsynopsis>
<type>string</type>
<methodname>msgfmt_format_message</methodname>
<methodparam><type>string</type><parameter>locale</parameter></methodparam>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>array</type><parameter>args</parameter></methodparam>
</methodsynopsis>
<para>
Quick formatting function that formats the string without having to
explicitly create the formatter object. Use this function when the format
operation is done only once and does not need and parameters or state to be
kept.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>locale</parameter></term>
<listitem>
<para>
The locale to use for formatting locale-dependent parts
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
<para>
The pattern <type>string</type> to insert things into.
The pattern uses an 'apostrophe-friendly' syntax; it is run through
<link
xlink:href="&url.icu.autoQuoteApostrophe;">umsg_autoQuoteApostrophe</link>
before being interpreted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem>
<para>
The <type>array</type> of values to insert into the format <type>string</type>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The formatted pattern string or &false; if an error occurred
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>msgfmt_format_message</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo msgfmt_format_message("en_US", "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree", array(4560, 123, 4560/123));
echo msgfmt_format_message("de", "{0,number,integer} Affen über {1,number,integer} Bäume um {2,number} Affen pro Baum", array(4560, 123, 4560/123));
]]>
</programlisting>
</example>
<example>
<title>OO example</title>
<programlisting role="php">
<![CDATA[
<?php
echo msgfmt_format_message("en_US", "{0,number,integer} monkeys on {1,number,integer} trees make {2,number} monkeys per tree", array(4560, 123, 4560/123));
echo msgfmt_format_message("de", "{0,number,integer} Affen über {1,number,integer} Bäume um {2,number} Affen pro Baum", array(4560, 123, 4560/123));
?>
]]>
</programlisting>
</example>
&example.outputs;
<screen>
<![CDATA[
4,560 monkeys on 123 trees make 37.073 monkeys per tree
4.560 Affen über 123 Bäume um 37,073 Affen pro Baum
]]>
</screen>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>msgfmt_create</function></member>
<member><function>msgfmt_parse</function></member>
<member><function>msgfmt_get_error_code</function></member>
<member><function>msgfmt_get_error_message</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
-->
|
