getdate.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.getdate" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>getdate</refname>
  <refpurpose>Get date/time information</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>getdate</methodname>
   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>timestamp</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   Returns an associative <type>array</type> containing the date
   information of the <parameter>timestamp</parameter>, or the current
   local time if <parameter>timestamp</parameter> is omitted or &null;.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    
    &date.timestamp.description;
   
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an associative <type>array</type> of information related to
   the <parameter>timestamp</parameter>. Elements from the returned 
   associative array are as follows:
  </para>
  <para>
   <table>
    <title>Key elements of the returned associative array</title>
    <tgroup cols="3">
     <thead>
      <row>
       <entry>Key</entry>
       <entry>Description</entry>
       <entry>Example returned values</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry><literal>"seconds"</literal></entry>
       <entry>Numeric representation of seconds</entry>
       <entry><literal>0</literal> to <literal>59</literal></entry>
      </row>
      <row>
       <entry><literal>"minutes"</literal></entry>
       <entry>Numeric representation of minutes</entry>
       <entry><literal>0</literal> to <literal>59</literal></entry>
      </row>
      <row>
       <entry><literal>"hours"</literal></entry>
       <entry>Numeric representation of hours</entry>
       <entry><literal>0</literal> to <literal>23</literal></entry>
      </row>
      <row>
       <entry><literal>"mday"</literal></entry>
       <entry>Numeric representation of the day of the month</entry>
       <entry><literal>1</literal> to <literal>31</literal></entry>
      </row>
      <row>
       <entry><literal>"wday"</literal></entry>
       <entry>Numeric representation of the day of the week</entry>
       <entry><literal>0</literal> (for Sunday) through <literal>6</literal> (for Saturday)</entry>
      </row>
      <row>
       <entry><literal>"mon"</literal></entry>
       <entry>Numeric representation of a month</entry>
       <entry><literal>1</literal> through <literal>12</literal></entry>
      </row>
      <row>
       <entry><literal>"year"</literal></entry>
       <entry>A full numeric representation of a year, 4 digits</entry>
       <entry>Examples: <literal>1999</literal> or <literal>2003</literal></entry>
      </row>
      <row>
       <entry><literal>"yday"</literal></entry>
       <entry>Numeric representation of the day of the year</entry>
       <entry><literal>0</literal> through <literal>365</literal></entry>
      </row>
      <row>
       <entry><literal>"weekday"</literal></entry>
       <entry>A full textual representation of the day of the week</entry>
       <entry><literal>Sunday</literal> through <literal>Saturday</literal></entry>
      </row>
      <row>
       <entry><literal>"month"</literal></entry>
       <entry>A full textual representation of a month, such as January or March</entry>
       <entry><literal>January</literal> through <literal>December</literal></entry>
      </row>
      <row>
       <entry><literal>0</literal></entry>
       <entry>
        Seconds since the Unix Epoch, similar to the values returned by
        <function>time</function> and used by <function>date</function>.
       </entry>
       <entry>
        System Dependent, typically <literal>-2147483648</literal> through
        <literal>2147483647</literal>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </table>
  </para>
 </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.0.0</entry>
       <entry>
        <parameter>timestamp</parameter> is nullable now.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>getdate</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$today = getdate();
print_r($today);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Array
(
    [seconds] => 40
    [minutes] => 58
    [hours]   => 21
    [mday]    => 17
    [wday]    => 2
    [mon]     => 6
    [year]    => 2003
    [yday]    => 167
    [weekday] => Tuesday
    [month]   => June
    [0]       => 1055901520
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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