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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.number-format" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>number_format</refname>
<refpurpose>Format a number with grouped thousands</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>number_format</methodname>
<methodparam><type>float</type><parameter>num</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>decimals</parameter><initializer>0</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>decimal_separator</parameter><initializer>"."</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>thousands_separator</parameter><initializer>","</initializer></methodparam>
</methodsynopsis>
<para>
Formats a number with grouped thousands and optionally decimal digits using the rounding half up rule.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>num</parameter></term>
<listitem>
<para>
The number being formatted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>decimals</parameter></term>
<listitem>
<para>
Sets the number of decimal digits.
If <literal>0</literal>, the <parameter>decimal_separator</parameter> is
omitted from the return value.
As of PHP 8.3.0, when the value is negative, <parameter>num</parameter>
is rounded to <parameter>decimals</parameter> significant digits before
the decimal point.
Prior to PHP 8.3.0, negative values were ignored and handled the
same as <literal>0</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>decimal_separator</parameter></term>
<listitem>
<para>
Sets the separator for the decimal point.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>thousands_separator</parameter></term>
<listitem>
<para>
Sets the thousands separator.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
A formatted version of <parameter>num</parameter>.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.3.0</entry>
<entry>
Added handling of negative values for <parameter>decimals</parameter>.
</entry>
</row>
<row>
<entry>8.0.0</entry>
<entry>
Prior to this version, <function>number_format</function> accepted
one, two, or four parameters (but not three).
</entry>
</row>
<row>
<entry>7.2.0</entry>
<entry>
<function>number_format</function> was changed to not being able to return
<literal>-0</literal>, previously <literal>-0</literal> could be returned
for cases like where <parameter>num</parameter> would be <literal>-0.01</literal>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>number_format</function> Example</title>
<para>
For instance, French notation usually use two decimals,
comma (',') as decimal separator, and space (' ') as
thousand separator. The following example demonstrates various ways to format a number:
</para>
<programlisting role="php">
<![CDATA[
<?php
$number = 1234.56;
// english notation (default)
echo number_format($number), PHP_EOL;
// 1,235
// French notation
echo number_format($number, 2, ',', ' '), PHP_EOL;
// 1 234,56
$number = 1234.5678;
// english notation without thousands separator
echo number_format($number, 2, '.', ''), PHP_EOL;
// 1234.57
?>
]]>
</programlisting>
</example>
</para>
<example>
<title>A negative value for <parameter>decimals</parameter></title>
<simpara>
As of PHP 8.3.0, a negative value for <parameter>decimals</parameter>
is used to round the number of significant digits before the decimal
point.
</simpara>
<programlisting role="php">
<![CDATA[
<?php
$number = "1234.5678";
var_dump(number_format($number, -1));
var_dump(number_format($number, -2));
var_dump(number_format($number, -3));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(5) "1,230"
string(5) "1,200"
string(5) "1,000"
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>money_format</function></member>
<member><function>sprintf</function></member>
<member><function>printf</function></member>
<member><function>sscanf</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:"~/.phpdoc/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
-->
|
