File: create.xml

package info (click to toggle)
php-doc 20081024-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 57,752 kB
  • ctags: 3,858
  • sloc: xml: 686,554; php: 19,446; perl: 610; cpp: 500; makefile: 336; sh: 114; awk: 28
file content (165 lines) | stat: -rwxr-xr-x 4,916 bytes parent folder | download
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="numberformatter.create" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>NumberFormatter::create</refname>
  <refname>numfmt_create</refname>
  <refname>NumberFormatter::__construct</refname>
  <refpurpose>Create a number formatter</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   Object oriented style (method)
  </para>
  <methodsynopsis>
   <modifier>static</modifier>
   <type>NumberFormatter</type>
   <methodname>NumberFormatter::create</methodname>
   <methodparam><type>string</type><parameter>locale</parameter></methodparam>
   <methodparam><type>integer</type><parameter>style</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam>
  </methodsynopsis>
  <para>
   Procedural style
  </para>
  <methodsynopsis>
   <type>NumberFormatter</type>
   <methodname>numfmt_create</methodname>
   <methodparam><type>string</type><parameter>locale</parameter></methodparam>
   <methodparam><type>integer</type><parameter>style</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam>
  </methodsynopsis>
  <para>
   Object oriented style (constructor):
  </para>
   <constructorsynopsis>
    <methodname>NumberFormatter::__construct</methodname>
    <methodparam><type>string</type><parameter>locale</parameter></methodparam>
    <methodparam><type>integer</type><parameter>style</parameter></methodparam>
    <methodparam choice="opt"><type>string</type><parameter>pattern</parameter></methodparam>
   </constructorsynopsis>
  <para>
   Creates a number formatter.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>locale</parameter></term>
     <listitem>
      <para>
       Locale in which the number would be formatted (locale name, e.g. en_CA).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>style</parameter></term>
     <listitem>
      <para>
       Style of the formatting, one of the
       <link linkend="intl.numberformatter-constants.UNumberFormatStyle">
        format style</link> constants. If
       <constant>NumberFormatter::PATTERN_DECIMAL</constant>
       or <constant>NumberFormatter::PATTERN_RULEBASED</constant>
       is passed then the number format is opened using the given pattern,
       which must conform to the syntax described in
       <link xlink:href="&url.icu.decimalformat;">ICU DecimalFormat
       documentation</link> or
       <link xlink:href="&url.icu.ruleformat;">ICU RuleBasedNumberFormat
       documentation</link>, respectively.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>pattern</parameter></term>
     <listitem>
      <para>
       Pattern string in case chosen style requires pattern.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>


 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns <classname>NumberFormatter</classname> object or &false; on error.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>numfmt_create</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$fmt = numfmt_create( 'de_DE', NumberFormatter::DECIMAL );
echo numfmt_format($fmt, 1234567.891234567890000)."\n";
$fmt = numfmt_create( 'it', NumberFormatter::SPELLOUT );
echo numfmt_format($fmt, 1142)."\n";
?>
]]>
   </programlisting>
  </example>
  <example>
   <title><function>NumberFormatter</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$fmt = new NumberFormatter( 'de_DE', NumberFormatter::DECIMAL );
echo $fmt->format(1234567.891234567890000)."\n";
$fmt = new NumberFormatter( 'it', NumberFormatter::SPELLOUT );
echo $fmt->format(1142)."\n";
?>
]]>
   </programlisting>
  </example>
  &example.outputs;
  <screen>
<![CDATA[
1.234.567,891
millicentoquarantadue
]]>
  </screen>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>numfmt_format</function></member>
    <member><function>numfmt_parse</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
-->