doc-fr/reference/datetime/dateinterval/format.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.3 $ -->
<!-- EN-Revision: 1.3 Maintainer: dams Status: ready -->
<!-- Reviewed: yes -->

<refentry xml:id="dateinterval.format" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>DateInterval::format</refname>
  <refpurpose>Formate l'intervalle</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>string</type><methodname>DateInterval::format</methodname>
   <methodparam><type>string</type><parameter>format</parameter></methodparam>
  </methodsynopsis>
  <para>
   Format l'intervalle.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>format</parameter></term>
     <listitem>
      <para>
       <table>
        <title>
         Les caractères suivants sont reconnus dans la chaîne
         <parameter>format</parameter>.
        </title>
        <tgroup cols="3">
         <thead>
          <row>
           <entry>Caractère de <parameter>format</parameter></entry>
           <entry>Description</entry>
           <entry>Valeur d'exemple</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>Y</literal></entry>
           <entry>Années, numérique, au moins 2 chiffres avec zéros initiaux</entry>
           <entry><literal>01</literal>, <literal>03</literal></entry>
          </row>
          <row>
           <entry><literal>y</literal></entry>
           <entry>Années, numérique</entry>
           <entry><literal>1</literal>, <literal>3</literal></entry>
          </row>
          <row>
           <entry><literal>M</literal></entry>
           <entry>Mois, numérique, au moins 2 chiffres avec zéros initiaux</entry>
           <entry><literal>01</literal>, <literal>03</literal>, <literal>12</literal></entry>
          </row>
          <row>
           <entry><literal>m</literal></entry>
           <entry>Mois, numérique</entry>
           <entry><literal>01</literal>, <literal>03</literal>, <literal>12</literal></entry>
          </row>
          <row>
           <entry><literal>D</literal></entry>
           <entry>Jours, numérique, au moins 2 chiffres avec zéros initiaux</entry>
           <entry><literal>01</literal>, <literal>03</literal>, <literal>31</literal></entry>
          </row>
          <row>
           <entry><literal>d</literal></entry>
           <entry>Jours, numérique</entry>
           <entry><literal>1</literal>, <literal>3</literal>, <literal>31</literal></entry>
          </row>
          <row>
           <entry><literal>a</literal></entry>
           <entry>Nombre total de jours</entry>
           <entry><literal>4</literal>, <literal>18</literal>, <literal>8123</literal></entry>
          </row>
          <row>
           <entry><literal>H</literal></entry>
           <entry>Heures, numérique, au moins 2 chiffres avec zéros initiaux</entry>
           <entry><literal>01</literal>, <literal>03</literal>, <literal>23</literal></entry>
          </row>
          <row>
           <entry><literal>h</literal></entry>
           <entry>Heures, numérique</entry>
           <entry><literal>1</literal>, <literal>3</literal>, <literal>23</literal></entry>
          </row>
          <row>
           <entry><literal>I</literal></entry>
           <entry>Minutes, numérique, au moins 2 chiffres avec zéros initiaux</entry>
           <entry><literal>01</literal>, <literal>03</literal>, <literal>59</literal></entry>
          </row>
          <row>
           <entry><literal>i</literal></entry>
           <entry>Minutes, numérique</entry>
           <entry><literal>1</literal>, <literal>3</literal>, <literal>59</literal></entry>
          </row>
          <row>
           <entry><literal>S</literal></entry>
           <entry>Secondes, numérique, au moins 2 chiffres avec zéros initiaux</entry>
           <entry><literal>01</literal>, <literal>03</literal>, <literal>57</literal></entry>
          </row>
          <row>
           <entry><literal>s</literal></entry>
           <entry>Secondes, numérique</entry>
           <entry><literal>1</literal>, <literal>3</literal>, <literal>57</literal></entry>
          </row>
          <row>
           <entry><literal>R</literal></entry>
           <entry>Signe "<literal>-</literal>" lorsque négatif, "<literal>+</literal>" si positif</entry>
           <entry><literal>-</literal>, <literal>+</literal></entry>
          </row>
          <row>
           <entry><literal>r</literal></entry>
           <entry>Signe "<literal>-</literal>" lorsque négatif, vide si positif</entry>
           <entry><literal>-</literal>, <literal></literal></entry>
          </row>
          <row>
           <entry><literal>%</literal></entry>
           <entry>Caractère <literal>%</literal> littéral</entry>
           <entry><literal>%</literal></entry>
          </row>
         </tbody>
        </tgroup>
       </table>       
      </para>
      <note>
       <para>
        Le préfixe <literal>%</literal> est nécessaire pour que les spécificateurs
        de formats fonctionnent correctement.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne l'intervalle formaté.
  </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
-->