mirror of
https://github.com/macintoshplus/doc-fr.git
synced 2026-03-25 17:32:07 +01:00
380 lines
12 KiB
XML
380 lines
12 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- EN-Revision: 715a125af5a86f0e6d6d5aa6cfa9c45257a433ac Maintainer: yannick Status: ready -->
|
|
<!-- Reviewed: yes -->
|
|
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.money-format">
|
|
<refnamediv>
|
|
<refname>money_format</refname>
|
|
<refpurpose>Met un nombre au format monétaire</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
&warn.deprecated.function-7-4-0.removed-8-0-0;
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>money_format</methodname>
|
|
<methodparam><type>string</type><parameter>format</parameter></methodparam>
|
|
<methodparam><type>float</type><parameter>number</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>money_format</function> retourne une version formatée du nombre
|
|
<parameter>number</parameter>. Cette fonction fait l'interface avec
|
|
la fonction <function>strfmon</function> de la bibliothèque C, à la
|
|
différence près que cette implémentation ne convertit qu'un nombre à la fois.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>format</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Le paramètre de format est constitué de la séquence suivante :
|
|
<itemizedlist>
|
|
<listitem><para>un caractère <literal>%</literal></para></listitem>
|
|
<listitem><para>une configuration optionnelle</para></listitem>
|
|
<listitem><para>une taille de champ optionnelle</para></listitem>
|
|
<listitem><para>une précision à gauche optionnelle</para></listitem>
|
|
<listitem><para>une précision à droite optionnelle</para></listitem>
|
|
<listitem><para>un caractère de conversion obligatoire</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
<formalpara>
|
|
<title>Drapeaux</title>
|
|
<para>
|
|
Une ou plusieurs des configurations suivantes sont utilisables :
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><literal>=</literal><replaceable>f</replaceable></term>
|
|
<listitem>
|
|
<para>
|
|
Le caractère <literal>=</literal> suivi par un octet unique
|
|
<replaceable>f</replaceable> qui sera utilisé comme caractère
|
|
de remplissage. Le caractère de remplissage par défaut est
|
|
espace.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>^</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Désactive le groupage de caractères (tel que défini dans la
|
|
configuration locale).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>+</literal> ou <literal>(</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Spécifie le style de formatage pour les nombres positifs et
|
|
négatifs. Si <literal>+</literal> est utilisé, les équivalents
|
|
dans la configuration locale de <literal>+</literal> et
|
|
<literal>-</literal> seront utilisés. Si
|
|
<literal>(</literal> est utilisé, les sommes négatives seront
|
|
placées entre parenthèses. Si aucune spécification n'est fournie,
|
|
la valeur par défaut est <literal>+</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>!</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Supprime le simple monétaire dans la chaîne finale.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>-</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Si fourni, cette configuration fait que les champs seront justifiés
|
|
à gauche (complétés à droite), au contraire de la configuration par
|
|
défaut qui est justifiée à droite, et complétée à gauche.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</formalpara>
|
|
<formalpara>
|
|
<title>Taille du champ</title>
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><replaceable>w</replaceable></term>
|
|
<listitem>
|
|
<para>
|
|
Un nombre décimal qui spécifie la taille minimale du champ.
|
|
Le champ sera complété à gauche, à moins que la configuration
|
|
<literal>-</literal> ne soit utilisée. Par défaut, cette
|
|
valeur est de 0.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</formalpara>
|
|
<formalpara>
|
|
<title>Précision à gauche</title>
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><literal>#</literal><replaceable>n</replaceable></term>
|
|
<listitem>
|
|
<para>
|
|
Le nombre maximal de chiffres (<replaceable>n</replaceable>) attendus
|
|
à gauche du séparateur décimal (e.g. la virgule). Cette option est
|
|
généralement utilisée pour conserver l'alignement de colonnes de
|
|
nombres, en utilisant un caractère pour compléter le nombre si ce
|
|
dernier a moins de <replaceable>n</replaceable> chiffres. Si le nombre
|
|
réel de chiffres est plus grand que <replaceable>n</replaceable>,
|
|
cette spécification est ignorée.
|
|
</para>
|
|
<para>
|
|
Si le groupage n'a pas été supprimé via la configuration
|
|
<literal>^</literal>, les séparateurs de groupage seront insérés
|
|
avant le caractère de remplissage (le cas échéant). Les séparateurs
|
|
ne seront pas appliqués aux caractères de remplissage, même si
|
|
ce caractère est un nombre.
|
|
</para>
|
|
<para>
|
|
Pour s'assurer de l'alignement, tous les caractères apparaissant
|
|
avant et après le nombre formaté, tels que les symboles monétaires
|
|
ou les signes négatif et positif, seront placés au même endroit grâce
|
|
à des espaces supplémentaires, afin que toutes les tailles des nombres
|
|
soient les mêmes.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</formalpara>
|
|
<formalpara>
|
|
<title>Précision à droite</title>
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><literal>.</literal><replaceable>p</replaceable></term>
|
|
<listitem>
|
|
<para>
|
|
Un point suivi par un nombre de décimales (<replaceable>p</replaceable>).
|
|
Si la valeur de <replaceable>p</replaceable> est 0 (zéro), le
|
|
séparateur décimal et les décimales seront supprimés. Si aucune
|
|
précision à droite n'est précisée, la valeur par défaut sera
|
|
lue dans la configuration locale. Le nombre formaté sera alors
|
|
arrondi pour satisfaire les contraintes d'affichage.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</formalpara>
|
|
<formalpara>
|
|
<title>Caractères de conversion</title>
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><literal>i</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Le nombre est formaté suivant le format monétaire international
|
|
de la configuration locale (e.g. pour la France : 1 234,56 F).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>n</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Le nombre est formaté en fonction du format monétaire national
|
|
(e.g. pour la configuration <literal>de_DE</literal> :
|
|
<literal>EU1.234,56</literal>).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>%</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Retourne le caractère <literal>%</literal>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</formalpara>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>number</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Le nombre à formater.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Retourne la chaîne formatée. Les caractères avant et après la chaîne
|
|
formatée seront retournés, inchangés.
|
|
Une valeur non-numérique pour <parameter>number</parameter> retourne &null;
|
|
et émet une alerte <constant>E_WARNING</constant>.
|
|
</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>7.4.0</entry>
|
|
<entry>
|
|
Cette fonction est obsolète. Utiliser
|
|
<methodname>NumberFormatter::formatCurrency</methodname> à la place.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>Exemple avec <function>money_format</function></title>
|
|
<para>
|
|
Voici plusieurs exemples d'utilisation de la fonction
|
|
<function>money_format</function> avec différentes chaînes
|
|
de formatage, et configurations locales.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
$number = 1234.56;
|
|
|
|
// Affichons ce nombre au format international pour en_US
|
|
setlocale(LC_MONETARY, 'en_US');
|
|
echo money_format('%i', $number) . "\n";
|
|
// USD 1,234.56
|
|
|
|
// Et au format italien national avec 2 decimales
|
|
setlocale(LC_MONETARY, 'it_IT');
|
|
echo money_format('%.2n', $number) . "\n";
|
|
// L. 1.234,56
|
|
|
|
// Utilisation d'un nombre négatif
|
|
$number = -1234.5672;
|
|
|
|
// Format US national, avec les parenthèeses pour les nombres négatifs
|
|
// et 10 chiffres de précision à gauche
|
|
setlocale(LC_MONETARY, 'en_US');
|
|
echo money_format('%(#10n', $number) . "\n";
|
|
// ($ 1,234.57)
|
|
|
|
// Format similaire au précédent, en ajoutant 2 décimales
|
|
// pour la précision à droite, et en utilisant le caractère de remplissage '*'
|
|
echo money_format('%=*(#10.2n', $number) . "\n";
|
|
// ($********1,234.57)
|
|
|
|
// Utilisons maintenant la justification à gauche, avec un champ de 14 caractères
|
|
// de long, sans groupage de chiffres, et en utilisant le format international
|
|
// pour de_DE
|
|
setlocale(LC_MONETARY, 'de_DE');
|
|
echo money_format('%=*^-14#8.2i', 1234.56) . "\n";
|
|
// DEM 1234,56****
|
|
|
|
// Ajoutons encore à l'exemple précédent
|
|
setlocale(LC_MONETARY, 'en_GB');
|
|
$fmt = 'La valeur finale est %i (après 10 %% de remise)';
|
|
echo money_format($fmt, 1234.56) . "\n";
|
|
// La valeur finale est GBP 1,234.56 (après 10 % de remise)
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
La fonction <function>money_format</function> est uniquement définie si
|
|
le système a les capacités <literal>strfmon</literal>. Par exemple, Windows
|
|
ne les a pas, donc, <function>money_format</function> n'est pas définie
|
|
sous Windows.
|
|
</para>
|
|
</note>
|
|
<note>
|
|
<para>
|
|
La catégorie <constant>LC_MONETARY</constant> de la configuration locale
|
|
affecte le comportement de cette fonction. Utilisez
|
|
<function>setlocale</function> pour configurer correctement PHP avant
|
|
d'utiliser cette fonction.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>setlocale</function></member>
|
|
<member><function>sscanf</function></member>
|
|
<member><function>sprintf</function></member>
|
|
<member><function>printf</function></member>
|
|
<member><function>number_format</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
|
|
-->
|