Files
doc-fr/reference/strings/functions/sprintf.xml
T
Damien Seguy 72198868f4 correcting the <function> mess
git-svn-id: https://svn.php.net/repository/phpdoc/fr/trunk@91701 c90b9560-bf6c-de11-be94-00142212c4b1
2002-08-13 02:59:48 +00:00

241 lines
9.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/strings.xml, last change in rev 1.2 -->
<refentry id="function.sprintf">
<refnamediv>
<refname>sprintf</refname>
<refpurpose>Retourne une cha&icirc;ne formatt&eacute;e</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>sprintf</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>args</parameter></methodparam>
</methodsynopsis>
<simpara>
<methodname>sprintf</methodname> retourne une cha&icirc;ne format&eacute;e, avec
le format <parameter>format</parameter> et en utilisant les arguments
<parameter>args</parameter>.
</simpara>
<simpara>
La cha&icirc;ne de format est compos&eacute;e de z&eacute;ro, une ou plusieurs directives :
les caract&egrave;res ordinaires (&agrave; l'exception de <literal>%</literal>)
qui sont copi&eacute;s directement dans le r&eacute;sultat, et des
<emphasis>des sp&eacute;cifications de conversion</emphasis>, qui exploite
chacune un des arguments pass&eacute; apr&egrave;s la cha&icirc;ne de format.
Ces formats s'appliquent &agrave; <function>sprintf</function>
et <function>printf</function>.
</simpara>
<para>
Chaque sp&eacute;cification de conversion est consistitu&eacute; d'un signe
de pourcentage (<literal>%</literal>), suivi d'un ou plusieurs
des &eacute;l&eacute;ments suivants, dans cet ordre :
<orderedlist>
<listitem>
<simpara>
Un <emphasis>remplisseur</emphasis> optionnel qui indique
quel caract&egrave;re sera utilis&eacute; pour compl&eacute;ter le r&eacute;sultat
jusqu'&agrave; la longueur requise. Ce peut &ecirc;tre le caract&egrave;re d'espace,
ou le caract&egrave;re <literal>0</literal>. Par d&eacute;faut, le remplissage
se fait avec des espaces. Un autre caract&egrave;re de remplissage peut
&ecirc;tre sp&eacute;cifi&eacute; en le pr&eacute;fixant avec un guillemet simple
(<literal>'</literal>) : voir les exemples ci-dessous.
</simpara>
</listitem>
<listitem>
<simpara>
Un <emphasis>sp&eacute;cificateur d'alignement</emphasis> qui indique
si le r&eacute;sultat doit &ecirc;tre align&eacute; &agrave; gauche ou &agrave; droite. Par
d&eacute;faut, le r&eacute;sultat est align&eacute; &agrave; gauche. Le caract&egrave;re
<literal>-</literal> fera que le r&eacute;sultat est align&eacute; &agrave; droite.
</simpara>
</listitem>
<listitem>
<simpara>
Un nombre optionnel, <emphasis>sp&eacute;cificateur de taille</emphasis>
indique le nombre minimum de caract&egrave;res que cette conversion doit
fournir en r&eacute;sultat.
</simpara>
</listitem>
<listitem>
<simpara>
Un <emphasis>sp&eacute;cificateur de pr&eacute;cision</emphasis> qui indique
le nombre de d&eacute;cimales qui doivent &ecirc;tre affich&eacute;es pour les nombres
&agrave; virgule flottante. Cette option n'a pas d'effet pour les autres
types que <type>float</type>. Une auter fonction pratique pour
formatter les nombres &agrave; virgule flottante est <function>number_format</function>.
</simpara>
</listitem>
<listitem>
<para>
Un <emphasis>sp&eacute;cificateur de type</emphasis> qui indique le type
avec lequel l'argument sera trait&eacute;. Plusieurs types possibles :
<simplelist>
<member>
<literal>%</literal> - un caract&egrave;re de pourcentage lit&eacute;ral.
Aucun argument n'est n&eacute;cessaire.
</member>
<member>
<literal>b</literal> - l'argument est trait&eacute; comme un entier,
et pr&eacute;sent&eacute; comme un nombre binaire.
</member>
<member>
<literal>c</literal> - l'argument est trait&eacute; comme un entier,
et pr&eacute;sent&eacute; comme le caract&egrave;re de code ASCII correspondant.
</member>
<member>
<literal>d</literal> - l'argument est trait&eacute; comme un entier,
et pr&eacute;sent&eacute; comme un nombre d&eacute;cimal sign&eacute;.
</member>
<member>
<literal>u</literal> - l'argument est trait&eacute; comme un entier,
et pr&eacute;sent&eacute; comme un nombre d&eacute;cimal non sign&eacute;.
</member>
<member>
<literal>f</literal> - l'argument est trait&eacute; comme un nombre &agrave;
virgule flottante (type <type>float</type>), et pr&eacute;sent&eacute; comme un nombre &agrave;
virgule flottante.
</member>
<member>
<literal>o</literal> - l'argument est trait&eacute; comme un entier,
et pr&eacute;sent&eacute; comme un nombre octal.
</member>
<member>
<literal>s</literal> - l'argument est trait&eacute; et
pr&eacute;sent&eacute; comme une cha&icirc;ne de caract&egrave;res.
</member>
<member>
<literal>x</literal> - l'argument est trait&eacute; comme un entier,
et pr&eacute;sent&eacute; comme un nombre hexad&eacute;cimal (les lettres en minuscules).
</member>
<member>
<literal>X</literal> - l'argument est trait&eacute; comme un entier,
et pr&eacute;sent&eacute; comme un nombre hexad&eacute;cimal (les lettres en majuscules).
</member>
</simplelist>
</para>
</listitem>
</orderedlist>
</para>
<para>
Depuis PHP 4.0.6, la cha&icirc;ne de format support le num&eacute;rotage
et l'&eacute;change d'arguments. Par exemple :
<example>
<title>Echange d'arguments</title>
<programlisting role="php">
<![CDATA[
<?php
$format = "Il y a %d singes dans le %s";
printf($format,$num,$location);
?>
]]>
</programlisting>
</example>
Ce exemple peut afficher par exemple : "Il y a 5 signes dans le bananier".
Mais imaginez que la cha&icirc;ne de format soit cr&eacute;&eacute;e dans un script
s&eacute;par&eacute; (une librairie), ca nous devons internationaliser cet
affichage. Nous aurons peut &ecirc;tre &agrave; &eacute;crire :
<example>
<title>Echange d'arguments (2)</title>
<programlisting role="php">
<![CDATA[
<?php
$format = "Le %s a %d singes";
printf($format,$num,$location);
?>
]]>
</programlisting>
</example>
Maintenant, nous avnos un probl&egrave;me. L'ordre des arguments a &eacute;t&eacute; chang&eacute;,
et ne correspond pas &agrave; l'ordre des arguments dans le script PHP.
Nous souhaitons laisser le code PHP tel quel, et simplement indiquer
dans la cha&icirc;ne de formattage l'ordre dans lequel les arguments doivent
&ecirc;tre repris. La cha&icirc;ne de format peut &ecirc;tre r&eacute;&eacute;crite ainsi :
<example>
<title>Echange d'arguments (3)</title>
<programlisting role="php">
<![CDATA[
<?php
$format = "Le %2\$s a %1\$d signes";
printf($format,$num,$location);
?>
]]>
</programlisting>
</example>
Un des avantages est que vous pouvez d&eacute;sormais exploiter plusieurs fois les
arguments sans les r&eacute;p&eacute;ter. Ainsi :
<example>
<title>Echange d'arguments (4)</title>
<programlisting role="php">
<![CDATA[
<?php
$format = "Le %2\$s a %1\$d singes.
C'est un beau %2\$s, avec %1\$d signes.";
printf($format, $num, $location);
?>
]]>
</programlisting>
</example>
</para>
<simpara>
Voir aussi
<function>printf</function>,
<function>sscanf</function>,
<function>fscanf</function> et
<function>number_format</function>.
</simpara>
</refsect1>
<refsect1>
<title>Exemples avec <function>printf</function> et <function>sprintf</function></title>
<para>
<example>
<title><function>sprintf</function>: entiers compl&eacute;t&eacute;s de z&eacute;ros</title>
<programlisting role="php">
<![CDATA[
<?php
$isodate = sprintf("%04d-%02d-%02d", $year, $month, $day);
?>
]]>
</programlisting>
</example>
<example>
<title><function>sprintf</function>: format de mon&eacute;taire</title>
<programlisting role="php">
<![CDATA[
<?php
$money1 = 68.75;
$money2 = 54.35;
$money = $money1 + $money2;
// echo $money va afficher "123.1";
$formatted = sprintf("%01.2f", $money);
// echo $formatted va afficher "123.10"
?>
]]>
</programlisting>
</example>
</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
-->