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

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: seros Status: ready -->
<refentry xml:id="function.idate" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>idate</refname>
  <refpurpose>Formatea una fecha/hora local como un entero</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>idate</methodname>
   <methodparam><type>string</type><parameter>format</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter><initializer>time()</initializer></methodparam>
  </methodsynopsis>
  <para>
   Devuelve un número formateado según la cadena de formato dada usando la marca de
   tiempo <parameter>timestamp</parameter> de tipo entero dado o el momento local actual
   si no se da la marca de tiempo. En otras palabras, <parameter>timestamp</parameter>
   es opcional y su valor por defecto es el de <function>time</function>.
  </para>
  <para>
   A diferencia de <function>date</function>, <function>idate</function>
   acepta un sólo carácter en el parámetro <parameter>format</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>format</parameter></term>
     <listitem>
      <para>
       <table>
        <title>Los siguientes caracteres son reconocidos por el
        parámetro de cadena <parameter>format</parameter></title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry>Caracter <parameter>format</parameter></entry>
           <entry>Descripción</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>B</literal></entry>
           <entry>Swatch Beat/Hora Internet</entry>
          </row>
          <row>
           <entry><literal>d</literal></entry>
           <entry>Día del mes</entry>
          </row>
          <row>
           <entry><literal>h</literal></entry>
           <entry>Hora (formato de 12 horas)</entry>
          </row>
          <row>
           <entry><literal>H</literal></entry>
           <entry>Hora (formato de 24 horas)</entry>
          </row>
          <row>
           <entry><literal>i</literal></entry>
           <entry>Minutos</entry>
          </row>
          <row>
           <entry><literal>I</literal> (i mayúscula)</entry>
           <entry>devuelve <literal>1</literal> si el horario de verano (DST) está activado,
            <literal>0</literal> si no</entry>
          </row>
          <row>
           <entry><literal>L</literal> (l mayúscula)</entry>
           <entry>devuelve <literal>1</literal> para años bisiestos,
            <literal>0</literal> si no</entry>
          </row>
          <row>
           <entry><literal>m</literal></entry>
           <entry>Número de mes</entry>
          </row>
          <row>
           <entry><literal>s</literal></entry>
           <entry>Segundos</entry>
          </row>
          <row>
           <entry><literal>t</literal></entry>
           <entry>Días en el mes actual</entry>
          </row>
          <row>
           <entry><literal>U</literal></entry>
           <entry>Segundos desde la Época Unix - 1 de enero de 1970 00:00:00 UTC -
            esto es lo mismo que en <function>time</function></entry>
          </row>
          <row>
           <entry><literal>w</literal></entry>
           <entry>Día de la semana (<literal>0</literal> para Domingo)</entry>
          </row>
          <row>
           <entry><literal>W</literal></entry>
           <entry>Número del mes del año ISO-8601, las semanas comienzan en
            Lunes</entry>
          </row>
          <row>
           <entry><literal>y</literal></entry>
           <entry>Año (1 ó 2 dígitos - comprobar la anotación de abajo)</entry>
          </row>
          <row>
           <entry><literal>Y</literal></entry>
           <entry>Año (4 dígitos)</entry>
          </row>
          <row>
           <entry><literal>z</literal></entry>
           <entry>Día del año</entry>
          </row>
          <row>
           <entry><literal>Z</literal></entry>
           <entry>Ínidce de la zona horaria en segundos</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    
    &date.timestamp.description;
      
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve un <type>integer</type>.
  </para>
  <para>
   Ya que <function>idate</function> devuelve siempre un <type>integer</type> y
   como éste nunca puede empezar por un "0", <function>idate</function> puede devolver
   menos dígitos de los que se esperarían. Vea el ejemplo de abajo.
  </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>
      
      &date.timezone.errors.changelog;
     
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

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

// esto imprime el año en un formato de dos dígitos
// sin embargo, ya que éste podría empezar con un "0",
// sólo se imprime "4"
echo idate('y', $timestamp);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <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
-->