<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision$ -->
<refentry xml:id="function.idate" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>idate</refname>
  <refpurpose>Format a local time/date as integer</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>
   Returns a number formatted according to the given format string using the
   given integer <parameter>timestamp</parameter> or the current local time
   if no timestamp is given. In other words, <parameter>timestamp</parameter>
   is optional and defaults to the value of <function>time</function>.
  </para>
  <para>
   Unlike the function <function>date</function>, <function>idate</function>
   accepts just one char in the <parameter>format</parameter> parameter.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>format</parameter></term>
     <listitem>
      <para>
       <table>
        <title>The following characters are recognized in the
        <parameter>format</parameter> parameter string</title>
        <tgroup cols="2">
         <thead>
          <row>
           <entry><parameter>format</parameter> character</entry>
           <entry>Description</entry>
          </row>
         </thead>
         <tbody>
          <row>
           <entry><literal>B</literal></entry>
           <entry>Swatch Beat/Internet Time</entry>
          </row>
          <row>
           <entry><literal>d</literal></entry>
           <entry>Day of the month</entry>
          </row>
          <row>
           <entry><literal>h</literal></entry>
           <entry>Hour (12 hour format)</entry>
          </row>
          <row>
           <entry><literal>H</literal></entry>
           <entry>Hour (24 hour format)</entry>
          </row>
          <row>
           <entry><literal>i</literal></entry>
           <entry>Minutes</entry>
          </row>
          <row>
           <entry><literal>I</literal> (uppercase i)</entry>
           <entry>returns <literal>1</literal> if DST is activated,
            <literal>0</literal> otherwise</entry>
          </row>
          <row>
           <entry><literal>L</literal> (uppercase l)</entry>
           <entry>returns <literal>1</literal> for leap year,
            <literal>0</literal> otherwise</entry>
          </row>
          <row>
           <entry><literal>m</literal></entry>
           <entry>Month number</entry>
          </row>
          <row>
           <entry><literal>s</literal></entry>
           <entry>Seconds</entry>
          </row>
          <row>
           <entry><literal>t</literal></entry>
           <entry>Days in current month</entry>
          </row>
          <row>
           <entry><literal>U</literal></entry>
           <entry>Seconds since the Unix Epoch - January 1 1970 00:00:00 UTC -
            this is the same as <function>time</function></entry>
          </row>
          <row>
           <entry><literal>w</literal></entry>
           <entry>Day of the week (<literal>0</literal> on Sunday)</entry>
          </row>
          <row>
           <entry><literal>W</literal></entry>
           <entry>ISO-8601 week number of year, weeks starting on
            Monday</entry>
          </row>
          <row>
           <entry><literal>y</literal></entry>
           <entry>Year (1 or 2 digits - check note below)</entry>
          </row>
          <row>
           <entry><literal>Y</literal></entry>
           <entry>Year (4 digits)</entry>
          </row>
          <row>
           <entry><literal>z</literal></entry>
           <entry>Day of the year</entry>
          </row>
          <row>
           <entry><literal>Z</literal></entry>
           <entry>Timezone offset in seconds</entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    
    &date.timestamp.description;
      
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an <type>integer</type>.
  </para>
  <para>
   As <function>idate</function> always returns an <type>integer</type> and
   as they can't start with a "0", <function>idate</function> may return
   fewer digits than you would expect. See the example below.
  </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><function>idate</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$timestamp = strtotime('1st January 2004'); //1072915200

// this prints the year in a two digit format
// however, as this would start with a "0", it
// only prints "4"
echo idate('y', $timestamp);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

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