doc-fr/reference/strings/functions/number-format.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.21 $ -->
<!-- EN-Revision: 1.15 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->

<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.number-format" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>number_format</refname>
  <refpurpose>Formate un nombre pour l'affichage</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>number_format</methodname>
   <methodparam><type>float</type><parameter>number</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>decimals</parameter></methodparam>
  </methodsynopsis>
  <methodsynopsis>
   <type>string</type><methodname>number_format</methodname>
   <methodparam><type>float</type><parameter>number</parameter></methodparam>
   <methodparam><type>int</type><parameter>decimals</parameter></methodparam>
   <methodparam><type>string</type><parameter>dec_point</parameter></methodparam>
   <methodparam><type>string</type><parameter>thousands_sep</parameter></methodparam>
  </methodsynopsis>

  <para>
   Cette fonction accepte un, deux, ou quatre paramètres (et pas trois) :
  </para>
  <para>
   Si seul le paramètre <parameter>number</parameter> est donné,
   il sera formaté sans partie décimale, mais avec une
   virgule entre chaque millier.
  </para>
  <para>
   Si les deux paramètres <parameter>number</parameter> et
   <parameter>decimals</parameter> sont fournis, <parameter>number</parameter> sera
   formaté avec <parameter>decimals</parameter> décimales,
   un point (".") comme séparateur décimal et une virgule entre chaque
   millier.
  </para>
  <para>
   Avec quatre paramètres, <parameter>number</parameter> sera
   formaté avec <parameter>decimals</parameter> décimales,
   <parameter>dec_point</parameter> comme séparateur décimal, et
   <parameter>thousands_sep</parameter> comme séparateur de milliers.
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Une version formatée du nombre <parameter>number</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>number</parameter></term>
     <listitem>
      <para>
       Le nombre à formater.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>decimals</parameter></term>
     <listitem>
      <para>
       Définit le nombre de décimal.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dec_point</parameter></term>
     <listitem>
      <para>
       Définit le séparateur pour le point décimal.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>thousands_sep</parameter></term>
     <listitem>
      <para>
       Définit le séparateur des milliers.
      </para>
      <para>
       Seul le premier caractère du paramètre <parameter>thousands_sep</parameter>
       est utilisé. Par exemple, si vous utilisez <literal>bar</literal> comme
       séparateur de milliers, sur le nombre <literal>1000</literal>,
       <function>number_format</function> retournera <literal>1b000</literal>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>number_format</function></title>
    <para>
     En notation française, on utilise généralement deux chiffres
     après la virgule, une virgule comme séparateur décimal, et un
     espace comme séparateur de milliers. Cela donne :
    </para>
    <programlisting role="php">
<![CDATA[
<?php

$number = 1234.56;

// Notation anglaise (par défaut)
$english_format_number = number_format($number);
// 1,235

// Notation française
$nombre_format_francais = number_format($number, 2, ',', ' ');
// 1 234,56

$number = 1234.5678;

// Notation anglaise sans séparateur des centaines
$english_format_number = number_format($number, 2, '.', '');
// 1234.57

?>
]]>
    </programlisting>
   </example>
  </para>
 </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:"../../../../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
-->