<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.datetime.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'fr',
  ),
  'this' => 
  array (
    0 => 'function.idate.php',
    1 => 'idate',
    2 => 'Formate une partie de l\'heure/date locale en tant qu\'entier',
  ),
  'up' => 
  array (
    0 => 'ref.datetime.php',
    1 => 'Fonctions Date/Heure',
  ),
  'prev' => 
  array (
    0 => 'function.gmstrftime.php',
    1 => 'gmstrftime',
  ),
  'next' => 
  array (
    0 => 'function.localtime.php',
    1 => 'localtime',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/datetime/functions/idate.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.idate" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">idate</h1>
  <p class="verinfo">(PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">idate</span> &mdash; <span class="dc-title">Formate une partie de l&#039;heure/date locale en tant qu&#039;entier</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.idate-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>idate</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$format</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$timestamp</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>idate()</strong></span> retourne un nombre formaté avec le
   format <code class="parameter">format</code> et représentant le timestamp
   <code class="parameter">timestamp</code> ou l&#039;heure courante si
   <code class="parameter">timestamp</code> est omis.
   En d&#039;autres termes, le paramètre <code class="parameter">timestamp</code> est optionnel
   et la valeur par défaut est la valeur retournée par la fonction <span class="function"><a href="function.time.php" class="function">time()</a></span>.
  </p>
  <p class="para">
   À l&#039;inverse de la fonction <span class="function"><a href="function.date.php" class="function">date()</a></span>, <span class="function"><strong>idate()</strong></span>
   accepte juste un caractère comme paramètre <code class="parameter">format</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.idate-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">format</code></dt>
     <dd>
      <p class="para">
       <table class="doctable table">
        <caption><strong>Les caractères suivants sont reconnus dans la chaîne de caractères
        du paramètre <code class="parameter">format</code></strong></caption>
        
         <thead>
          <tr>
           <th>Caractères de <code class="parameter">format</code></th>
           <th>Description</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td><code class="literal">B</code></td>
           <td>Temps Internet Swatch Beat</td>
          </tr>

          <tr>
           <td><code class="literal">d</code></td>
           <td>Le jour du mois</td>
          </tr>

          <tr>
           <td><code class="literal">h</code></td>
           <td>Heure (format 12 heures)</td>
          </tr>

          <tr>
           <td><code class="literal">H</code></td>
           <td>Heure (format 24 heures)</td>
          </tr>

          <tr>
           <td><code class="literal">i</code></td>
           <td>Minutes</td>
          </tr>

          <tr>
           <td><code class="literal">I</code>(i, en majuscule)</td>
           <td>Retourne <code class="literal">1</code> si l&#039;heure d&#039;été est activée,
            <code class="literal">0</code> sinon</td>
          </tr>

          <tr>
           <td><code class="literal">L</code>(l, en majuscule)</td>
           <td>Retourne <code class="literal">1</code> pour une année bissextile,
            <code class="literal">0</code> sinon</td>
          </tr>

          <tr>
           <td><code class="literal">m</code></td>
           <td>Numéro du mois</td>
          </tr>

          <tr>
           <td><code class="literal">N</code></td>
           <td>
            Jour de la semaine ISO-8601 (<code class="literal">1</code> pour
            le lundi à <code class="literal">7</code> pour le dimanche)
           </td>
          </tr>

          <tr>
           <td><code class="literal">o</code></td>
           <td>Année ISO-8601 (4 chiffres)</td>
          </tr>

          <tr>
           <td><code class="literal">s</code></td>
           <td>Secondes</td>
          </tr>

          <tr>
           <td><code class="literal">t</code></td>
           <td>Jour du mois courant</td>
          </tr>

          <tr>
           <td><code class="literal">U</code></td>
           <td>Secondes depuis l&#039;époque Unix - 1 Janvier 1970 00:00:00 UTC -
            c&#039;est la même chose que la fonction <span class="function"><a href="function.time.php" class="function">time()</a></span></td>
          </tr>

          <tr>
           <td><code class="literal">w</code></td>
           <td>Jour de la semaine (<code class="literal">0</code> pour Dimanche)</td>
          </tr>

          <tr>
           <td><code class="literal">W</code></td>
           <td>Le numéro de semaine de l&#039;année ; selon l&#039;ISO-8601, les semaines débutent
            le Lundi</td>
          </tr>

          <tr>
           <td><code class="literal">y</code></td>
           <td>Année sur 1 ou 2 chiffres, voir la note plus bas</td>
          </tr>

          <tr>
           <td><code class="literal">Y</code></td>
           <td>Année sur 4 chiffres</td>
          </tr>

          <tr>
           <td><code class="literal">z</code></td>
           <td>Jour de l&#039;année</td>
          </tr>

          <tr>
           <td><code class="literal">Z</code></td>
           <td>Décalage horaire, en secondes</td>
          </tr>

         </tbody>
        
       </table>

      </p>
     </dd>
    

    
<dt><code class="parameter">timestamp</code></dt><dd><p class="para">
    Le paramètre optionnel <code class="parameter">timestamp</code> est un timestamp
    Unix de type <a href="language.types.integer.php" class="link">entier</a> qui vaut par défaut l&#039;heure courante locale si
    <code class="parameter">timestamp</code> est omis ou <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>. En d&#039;autres
    termes, il vaut par défaut la valeur de la fonction <span class="function"><a href="function.time.php" class="function">time()</a></span>.
</p></dd>

   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.idate-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="para">
   Retourne un <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> en cas de succès,  ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> si une erreur survient.
  </p>
  <p class="para">
   Sachant que <span class="function"><strong>idate()</strong></span> retourne toujours un <a href="language.types.integer.php" class="link">entier</a>
   et qu&#039;il ne peut commencer par <code class="literal">0</code>,
   <span class="function"><strong>idate()</strong></span> peut retourner moins de chiffres que ce 
   dont on pourrait espérer. Voir l&#039;exemple ci-dessous.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.idate-errors">
  <h3 class="title">Erreurs / Exceptions</h3>
  <p class="para">
Chaque appel à une fonction date/heure générera un diagnostic de type
<strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> si le fuseau horaire n&#039;est pas valide.
Voir aussi <span class="function"><a href="function.date-default-timezone-set.php" class="function">date_default_timezone_set()</a></span></p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.idate-changelog">
  <h3 class="title">Historique</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Version</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>8.2.0</td>
       <td>
        Ajoute les caractères de format <code class="literal">N</code> (jour de la semaine ISO-8601)
        et <code class="literal">o</code> (année ISO-8601).
       </td>
      </tr>

      <tr>
       <td>8.0.0</td>
       <td>
        <code class="parameter">timestamp</code> est désormais nullable.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.idate-examples">
  <h3 class="title">Exemples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemple #1 Exemple avec <span class="function"><strong>idate()</strong></span></strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$timestamp </span><span style="color: #007700">= </span><span style="color: #0000BB">strtotime</span><span style="color: #007700">(</span><span style="color: #DD0000">'1st January 2004'</span><span style="color: #007700">); </span><span style="color: #FF8000">// 1072915200<br /><br />// ceci affiche l'année sur deux chiffres<br />// néanmoins, vu que ce chiffre va commencer par "0",<br />// seul "4" sera affiché<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">idate</span><span style="color: #007700">(</span><span style="color: #DD0000">'y'</span><span style="color: #007700">, </span><span style="color: #0000BB">$timestamp</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$timestamp </span><span style="color: #007700">= </span><span style="color: #0000BB">strtotime</span><span style="color: #007700">(</span><span style="color: #DD0000">'1st January 2024'</span><span style="color: #007700">); </span><span style="color: #FF8000">// 1704067200<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">idate</span><span style="color: #007700">(</span><span style="color: #DD0000">'y'</span><span style="color: #007700">, </span><span style="color: #0000BB">$timestamp</span><span style="color: #007700">);</span></span></code></div>
    </div>

    <div class="example-contents"><p>L&#039;exemple ci-dessus va afficher :</p></div>
    <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">4
24</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.idate-seealso">
  <h3 class="title">Voir aussi</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="datetime.format.php" class="methodname" rel="rdfs-seeAlso">DateTimeInterface::format()</a> - Retourne une date format&eacute;e suivant le format fourni</span></li>
    <li><span class="function"><a href="function.date.php" class="function" rel="rdfs-seeAlso">date()</a> - Formate un horodatage Unix</span></li>
    <li><span class="function"><a href="function.getdate.php" class="function" rel="rdfs-seeAlso">getdate()</a> - Retourne la date/heure</span></li>
    <li><span class="function"><a href="function.time.php" class="function" rel="rdfs-seeAlso">time()</a> - Retourne l'horodatage UNIX actuel</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>