<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Format a number</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="numberformatter.formatcurrency.html">NumberFormatter::formatCurrency</a></div>
<div class="next" style="text-align: right; float: right;"><a href="numberformatter.getattribute.html">NumberFormatter::getAttribute</a></div>
<div class="up"><a href="class.numberformatter.html">NumberFormatter</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="numberformatter.format" class="refentry">
<div class="refnamediv">
<h1 class="refname">NumberFormatter::format</h1>
<h1 class="refname">numfmt_format</h1>
<p class="verinfo">(PHP 5 >= 5.3.0, PECL intl >= 1.0.0)</p><p class="refpurpose"><span class="refname">NumberFormatter::format</span> -- <span class="refname">numfmt_format</span> — <span class="dc-title">Format a number</span></p>
</div>
<div class="refsect1 description" id="refsect1-numberformatter.format-description">
<h3 class="title">Description</h3>
<p class="para">
Object oriented style
</p>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span>
<span class="type">string</span>
<span class="methodname"><strong>NumberFormatter::format</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.number" class="type number">number</a></span> <code class="parameter">$value</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span>
] )</div>
<p class="para rdfs-comment">
Procedural style
</p>
<div class="methodsynopsis dc-description">
<span class="type">string</span>
<span class="methodname"><strong>numfmt_format</strong></span>
( <span class="methodparam"><span class="type"><a href="class.numberformatter.html" class="type NumberFormatter">NumberFormatter</a></span> <code class="parameter">$fmt</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.number" class="type number">number</a></span> <code class="parameter">$value</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span>
] )</div>
<p class="para rdfs-comment">
Format a numeric value according to the formatter rules.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-numberformatter.format-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">fmt</code></em></span>
<dd>
<p class="para">
<a href="class.numberformatter.html" class="classname">NumberFormatter</a> object.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">value</code></em></span>
<dd>
<p class="para">
The value to format. Can be <span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span> or <span class="type"><a href="language.types.float.html" class="type float">float</a></span>,
other values will be converted to a numeric value.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">type</code></em></span>
<dd>
<p class="para">
The
<a href="class.numberformatter.html#intl.numberformatter-constants.types" class="link">
formatting type</a> to use.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-numberformatter.format-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the string containing formatted value, or <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-numberformatter.format-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-2506">
<p><strong>Example #1 <span class="function"><strong>numfmt_format()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$fmt </span><span style="color: #007700">= </span><span style="color: #0000BB">numfmt_create</span><span style="color: #007700">( </span><span style="color: #DD0000">'de_DE'</span><span style="color: #007700">, </span><span style="color: #0000BB">NumberFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">DECIMAL </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$data </span><span style="color: #007700">= </span><span style="color: #0000BB">numfmt_format</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">, </span><span style="color: #0000BB">1234567.891234567890000</span><span style="color: #007700">);<br />if(</span><span style="color: #0000BB">intl_is_failure</span><span style="color: #007700">(</span><span style="color: #0000BB">numfmt_format</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">))) {<br /> </span><span style="color: #0000BB">report_error</span><span style="color: #007700">(</span><span style="color: #DD0000">"Formatter error"</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-2507">
<p><strong>Example #2 OO example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$fmt </span><span style="color: #007700">= new </span><span style="color: #0000BB">NumberFormatter</span><span style="color: #007700">( </span><span style="color: #DD0000">'de_DE'</span><span style="color: #007700">, </span><span style="color: #0000BB">NumberFormatter</span><span style="color: #007700">::</span><span style="color: #0000BB">DECIMAL </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #0000BB">1234567.891234567890000</span><span style="color: #007700">);<br />if(</span><span style="color: #0000BB">intl_is_failure</span><span style="color: #007700">(</span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-></span><span style="color: #0000BB">getErrorCode</span><span style="color: #007700">())) {<br /> </span><span style="color: #0000BB">report_error</span><span style="color: #007700">(</span><span style="color: #DD0000">"Formatter error"</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<p class="para">The above example will output:</p>
<div class="example-contents screen">
<div class="cdata"><pre>
1.234.567,891
</pre></div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-numberformatter.format-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="numberformatter.geterrorcode.html" class="function" rel="rdfs-seeAlso">numfmt_get_error_code()</a> - Get formatter's last error code.</span></li>
<li class="member"> <span class="function"><a href="numberformatter.formatcurrency.html" class="function" rel="rdfs-seeAlso">numfmt_format_currency()</a> - Format a currency value</span></li>
<li class="member"> <span class="function"><a href="numberformatter.parse.html" class="function" rel="rdfs-seeAlso">numfmt_parse()</a> - Parse a number</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="numberformatter.formatcurrency.html">NumberFormatter::formatCurrency</a></div>
<div class="next" style="text-align: right; float: right;"><a href="numberformatter.getattribute.html">NumberFormatter::getAttribute</a></div>
<div class="up"><a href="class.numberformatter.html">NumberFormatter</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
