<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.numberformatter.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'numberformatter.format.php',
    1 => 'NumberFormatter::format',
    2 => 'Formata um n&uacute;mero',
  ),
  'up' => 
  array (
    0 => 'class.numberformatter.php',
    1 => 'NumberFormatter',
  ),
  'prev' => 
  array (
    0 => 'numberformatter.create.php',
    1 => 'NumberFormatter::create',
  ),
  'next' => 
  array (
    0 => 'numberformatter.formatcurrency.php',
    1 => 'NumberFormatter::formatCurrency',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/intl/numberformatter/format.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<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 &gt;= 5.3.0, PHP 7, PHP 8, PECL intl &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">NumberFormatter::format</span> -- <span class="refname">numfmt_format</span> &mdash; <span class="dc-title">Formata um número</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-numberformatter.format-description">
  <h3 class="title">Descrição</h3>
  <p class="para">
   Estilo orientado a objetos
  </p>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>NumberFormatter::format</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.float.php" class="type float">float</a></span></span> <code class="parameter">$num</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$type</code><span class="initializer"> = <strong><code><a href="class.numberformatter.php#numberformatter.constants.type-default">NumberFormatter::TYPE_DEFAULT</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Estilo procedural
  </p>
  <div class="methodsynopsis dc-description"><span class="methodname"><strong>numfmt_format</strong></span>(<span class="methodparam"><span class="type"><a href="class.numberformatter.php" class="type NumberFormatter">NumberFormatter</a></span> <code class="parameter">$formatter</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.float.php" class="type float">float</a></span></span> <code class="parameter">$num</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$type</code><span class="initializer"> = <strong><code><a href="class.numberformatter.php#numberformatter.constants.type-default">NumberFormatter::TYPE_DEFAULT</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   Formata um valor numérico de acordo com as regras de formatação.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-numberformatter.format-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">formatter</code></dt>
     <dd>
      <p class="para">
       Objeto <span class="classname"><a href="class.numberformatter.php" class="classname">NumberFormatter</a></span>.
      </p>
     </dd>
    
    
     <dt><code class="parameter">num</code></dt>
     <dd>
      <p class="para">
       O valor a formatar. Pode ser <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> ou <span class="type"><a href="language.types.float.php" class="type float">float</a></span>,
       outros tipos serão convertidos para valores numéricos.
      </p>
     </dd>
    
    
     <dt><code class="parameter">type</code></dt>
     <dd>
      <p class="para">
       O
       <a href="class.numberformatter.php#intl.numberformatter-constants.types" class="link">
       tipo de formatação</a> a ser usado.
       Observe que <strong><code><a href="class.numberformatter.php#numberformatter.constants.type-currency">NumberFormatter::TYPE_CURRENCY</a></code></strong> não é suportado;
       use <span class="methodname"><a href="numberformatter.formatcurrency.php" class="methodname">NumberFormatter::formatCurrency()</a></span> em seu lugar.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>



 <div class="refsect1 returnvalues" id="refsect1-numberformatter.format-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna a string contendo o valor formatado, ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de erro.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-numberformatter.format-examples">
  <h3 class="title">Exemplos</h3>
  <div class="example" id="example-1">
   <p><strong>Exemplo #1 Exemplo de <span class="function"><strong>numfmt_format()</strong></span></strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?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 /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <div class="example" id="example-2">
   <p><strong>Exemplo #2 Exemplo OO</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?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">$data </span><span style="color: #007700">= </span><span style="color: #0000BB">$fmt</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">format</span><span style="color: #007700">(</span><span style="color: #0000BB">1234567.891234567890000</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
  <p class="para">O exemplo acima produzirá:</p>
  <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">string(13) &quot;1.234.567,891&quot;</pre>
</div>
  </div>
 </div>


 <div class="refsect1 notes" id="refsect1-numberformatter.format-notes">
  <h3 class="title">Notas</h3>
  <blockquote class="note"><p><strong class="note">Nota</strong>: 
   <p class="para">
    Formatos possíveis por este método não usam todas as possibilidades da biblioteca ICU subjacente,
    como por exemplo usar o símbolo da moeda em sua forma curta ou abreviada.
   </p>
   <p class="para">
    Para usar todas as possibilidades, use a função <span class="function"><a href="messageformatter.formatmessage.php" class="function">msgfmt_format_message()</a></span>.
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-numberformatter.format-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="numberformatter.geterrorcode.php" class="function" rel="rdfs-seeAlso">numfmt_get_error_code()</a> - Obt&eacute;m o &uacute;ltimo c&oacute;digo de erro do formatador</span></li>
    <li><span class="function"><a href="numberformatter.formatcurrency.php" class="function" rel="rdfs-seeAlso">numfmt_format_currency()</a> - Formata um valor de moeda</span></li>
    <li><span class="function"><a href="numberformatter.parse.php" class="function" rel="rdfs-seeAlso">numfmt_parse()</a> - Interpreta um n&uacute;mero</span></li>
    <li><span class="function"><a href="messageformatter.formatmessage.php" class="function" rel="rdfs-seeAlso">msgfmt_format_message()</a> - Formata uma mensagem rapidamente</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>