archived-doc-fr/reference/datetime/functions/idate.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 3a8c3e77df070a046c9d5b56b68926ca2d7e5ee3 Maintainer: Fan2Shrek Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.idate" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>idate</refname>
  <refpurpose>Formate une partie de l'heure/date locale en tant qu'entier</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>idate</methodname>
   <methodparam><type>string</type><parameter>format</parameter></methodparam>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>timestamp</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>idate</function> retourne un nombre formaté avec le
   format <parameter>format</parameter> et représentant le timestamp
   <parameter>timestamp</parameter> ou l'heure courante si
   <parameter>timestamp</parameter> est omis.
   En d'autres termes, le paramètre <parameter>timestamp</parameter> est optionnel
   et la valeur par défaut est la valeur retournée par la fonction <function>time</function>.
  </para>
  <para>
   À l'inverse de la fonction <function>date</function>, <function>idate</function>
   accepte juste un caractère comme paramètre <parameter>format</parameter>.
  </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 de caractères
        du paramètre <parameter>format</parameter></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Caractères de <parameter>format</parameter></entry>
           <entry>Description</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>B</literal></entry>
           <entry>Temps Internet Swatch Beat</entry>
          </row>
          <row>
           <entry><literal>d</literal></entry>
           <entry>Le jour du mois</entry>
          </row>
          <row>
           <entry><literal>h</literal></entry>
           <entry>Heure (format 12 heures)</entry>
          </row>
          <row>
           <entry><literal>H</literal></entry>
           <entry>Heure (format 24 heures)</entry>
          </row>
          <row>
           <entry><literal>i</literal></entry>
           <entry>Minutes</entry>
          </row>
          <row>
           <entry><literal>I</literal>(i, en majuscule)</entry>
           <entry>Retourne <literal>1</literal> si l'heure d'été est activée,
            <literal>0</literal> sinon</entry>
          </row>
          <row>
           <entry><literal>L</literal>(l, en majuscule)</entry>
           <entry>Retourne <literal>1</literal> pour une année bissextile,
            <literal>0</literal> sinon</entry>
          </row>
          <row>
           <entry><literal>m</literal></entry>
           <entry>Numéro du mois</entry>
          </row>
          <row>
           <entry><literal>N</literal></entry>
           <entry>
            Jour de la semaine ISO-8601 (<literal>1</literal> pour
            le lundi à <literal>7</literal> pour le dimanche)
           </entry>
          </row>
          <row>
           <entry><literal>o</literal></entry>
           <entry>Année ISO-8601 (4 chiffres)</entry>
          </row>
          <row>
           <entry><literal>s</literal></entry>
           <entry>Secondes</entry>
          </row>
          <row>
           <entry><literal>t</literal></entry>
           <entry>Jour du mois courant</entry>
          </row>
          <row>
           <entry><literal>U</literal></entry>
           <entry>Secondes depuis l'époque Unix - 1 Janvier 1970 00:00:00 UTC -
            c'est la même chose que la fonction <function>time</function></entry>
          </row>
          <row>
           <entry><literal>w</literal></entry>
           <entry>Jour de la semaine (<literal>0</literal> pour Dimanche)</entry>
          </row>
          <row>
           <entry><literal>W</literal></entry>
           <entry>Le numéro de semaine de l'année ; selon l'ISO-8601, les semaines débutent
            le Lundi</entry>
          </row>
          <row>
           <entry><literal>y</literal></entry>
           <entry>Année sur 1 ou 2 chiffres, voir la note plus bas</entry>
          </row>
          <row>
           <entry><literal>Y</literal></entry>
           <entry>Année sur 4 chiffres</entry>
          </row>
          <row>
           <entry><literal>z</literal></entry>
           <entry>Jour de l'année</entry>
          </row>
          <row>
           <entry><literal>Z</literal></entry>
           <entry>Décalage horaire, en secondes</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>

    &date.timestamp.description;

   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Retourne un <type>int</type> en cas de succès, &return.falseforfailure;.
  </para>
  <para>
   Sachant que <function>idate</function> retourne toujours un &integer;
   et qu'il ne peut commencer par <literal>0</literal>,
   <function>idate</function> peut retourner moins de chiffres que ce 
   dont on pourrait espérer. Voir l'exemple ci-dessous.
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  &date.timezone.errors.description;
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.2.0</entry>
       <entry>
        Ajoute les caractères de format <literal>N</literal> (jour de la semaine ISO-8601)
        et <literal>o</literal> (année ISO-8601).
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        <parameter>timestamp</parameter> est désormais nullable.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>idate</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$timestamp = strtotime('1st January 2004'); // 1072915200

// ceci affiche l'année sur deux chiffres
// néanmoins, vu que ce chiffre va commencer par "0",
// seul "4" sera affiché
echo idate('y', $timestamp) . "\n";

$timestamp = strtotime('1st January 2024'); // 1704067200
echo idate('y', $timestamp);
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
4
24
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>DateTimeInterface::format</methodname></member>
    <member><function>date</function></member>
    <member><function>getdate</function></member>
    <member><function>time</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
-->