<?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 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'function.idate.php',
    1 => 'idate',
    2 => 'Formata uma parte de uma data/hor&aacute;rio local como um inteiro',
  ),
  'up' => 
  array (
    0 => 'ref.datetime.php',
    1 => 'Fun&ccedil;&otilde;es de Data/Hor&aacute;rio',
  ),
  'prev' => 
  array (
    0 => 'function.gmstrftime.php',
    1 => 'gmstrftime',
  ),
  'next' => 
  array (
    0 => 'function.localtime.php',
    1 => 'localtime',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    '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">Formata uma parte de uma data/horário local como um inteiro</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.idate-description">
  <h3 class="title">Descrição</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">
   Retorna um número formatado de acordo com um formato informado utilizando o
   inteiro <code class="parameter">timestamp</code>, ou o horário local atual
   se nenhum timestamp foi informado. Em outras palavras, <code class="parameter">timestamp</code>
   é opcional e tem como padrão o valor da função <span class="function"><a href="function.time.php" class="function">time()</a></span>.
  </p>
  <p class="para">
   Ao contrário da função <span class="function"><a href="function.date.php" class="function">date()</a></span>, a <span class="function"><strong>idate()</strong></span>,
   aceita apenas um caractere no parâmetro <code class="parameter">format</code>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.idate-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">format</code></dt>
     <dd>
      <p class="para">
       <table class="doctable table">
        <caption><strong>Os caracteres a seguir são reconhecidos como válidos
        no parâmetro <code class="parameter">format</code></strong></caption>
        
         <thead>
          <tr>
           <th>Caractere <code class="parameter">format</code></th>
           <th>Descrição</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td><code class="literal">B</code></td>
           <td>Swatch Beat/Horário da Internet</td>
          </tr>

          <tr>
           <td><code class="literal">d</code></td>
           <td>Dia do mês</td>
          </tr>

          <tr>
           <td><code class="literal">h</code></td>
           <td>Hora (no formato de 12 horas)</td>
          </tr>

          <tr>
           <td><code class="literal">H</code></td>
           <td>Hora (no formato de 24 horas)</td>
          </tr>

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

          <tr>
           <td><code class="literal">I</code> (i maiúsculo)</td>
           <td>retorna <code class="literal">1</code> se o horário de verão está ativo,
            <code class="literal">0</code>, caso contrário</td>
          </tr>

          <tr>
           <td><code class="literal">L</code> (l maiúsculo)</td>
           <td>retorna <code class="literal">1</code> para anos bissextos,
            <code class="literal">0</code>, caso contrário</td>
          </tr>

          <tr>
           <td><code class="literal">m</code></td>
           <td>Número do mês</td>
          </tr>

          <tr>
           <td><code class="literal">N</code></td>
           <td>Dia da semana, baseado na ISO-8601 (<code class="literal">1</code> para segunda-feira
            até<code class="literal">7</code> para domingo)</td>
          </tr>

          <tr>
           <td><code class="literal">o</code></td>
           <td>ISO-8601 year (4 digits)</td>
          </tr>

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

          <tr>
           <td><code class="literal">t</code></td>
           <td>Dias do mês atual</td>
          </tr>

          <tr>
           <td><code class="literal">U</code></td>
           <td>Segundos desde a época Unix - January 1 1970 00:00:00 UTC -
            isso é o mesmo que a função <span class="function"><a href="function.time.php" class="function">time()</a></span></td>
          </tr>

          <tr>
           <td><code class="literal">w</code></td>
           <td>Dia da semana (<code class="literal">0</code> para domingo)</td>
          </tr>

          <tr>
           <td><code class="literal">W</code></td>
           <td>Semana do ano, baseado na ISO-8601, com a semana começando na
            segunda-feira</td>
          </tr>

          <tr>
           <td><code class="literal">y</code></td>
           <td>Ano (1 ou 2 dígitos - veja a nota abaixo)</td>
          </tr>

          <tr>
           <td><code class="literal">Y</code></td>
           <td>Ano (4 dígitos)</td>
          </tr>

          <tr>
           <td><code class="literal">z</code></td>
           <td>Dia do ano</td>
          </tr>

          <tr>
           <td><code class="literal">Z</code></td>
           <td>Deslocamento do fuso horário em segundos</td>
          </tr>

         </tbody>
        
       </table>

      </p>
     </dd>
    

    
<dt><code class="parameter">timestamp</code></dt><dd><p class="para">
O parâmetro opcional <code class="parameter">timestamp</code> é um
<span class="type"><a href="language.types.integer.php" class="type int">int</a></span> de timestamp Unix cujo padrão é a hora local
atual se <code class="parameter">timestamp</code> não for informado ou for <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>. Em outras
palavras, o padrão é o valor de <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">Valor Retornado</h3>
  <p class="para">
   Retorna um <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> em caso de sucesso,  ou <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> em caso de falha.
  </p>
  <p class="para">
   Como a função <span class="function"><strong>idate()</strong></span> sempre retorna um <span class="type"><a href="language.types.integer.php" class="type int">int</a></span> e
   como ela não começa com um &quot;0&quot;, <span class="function"><strong>idate()</strong></span> pode retornar
   menos dígitos do que se espera. Veja o exemplo abaixo.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.idate-errors">
  <h3 class="title">Erros/Exceções</h3>

   <p class="para">
Toda chamada a uma função de data/hora gerará um <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong>
se o fuso horário não for válido. Veja também <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">Registro de Alterações</h3>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>Versão</th>
       <th>Descrição</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>8.2.0</td>
       <td>
        Inclui os caracteres de formato <code class="literal">N</code> (dia da semana ISO-8601) e
        <code class="literal">o</code> (ano ISO-8601).
       </td>
      </tr>

      <tr>
       <td>8.0.0</td>
       <td>
        <code class="parameter">timestamp</code> agora pode ser nulo.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.idate-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Exemplo da função <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 />// este código imprime o ano em um formato de dois dígitos<br />// entretanto, como começaria com um "0", ele<br />// só imprime "4"<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>O exemplo acima produzirá:</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">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="datetime.format.php" class="methodname" rel="rdfs-seeAlso">DateTimeInterface::format()</a> - Retorna a data formatada de acordo com um formato informado</span></li>
    <li><span class="function"><a href="function.date.php" class="function" rel="rdfs-seeAlso">date()</a> - Formata um timestamp Unix</span></li>
    <li><span class="function"><a href="function.getdate.php" class="function" rel="rdfs-seeAlso">getdate()</a> - Recupera informa&ccedil;&otilde;es de data/hor&aacute;rio</span></li>
    <li><span class="function"><a href="function.time.php" class="function" rel="rdfs-seeAlso">time()</a> - Retorna o timestamp Unix atual</span></li>
   </ul>
  </p>
 </div>

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