php-doc-en/reference/datetime/functions/localtime.xml

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

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>localtime</methodname>
   <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter><initializer>time()</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>is_associative</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   The <function>localtime</function> function returns an array
   identical to that of the structure returned by the C function
   call.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    
    &date.timestamp.description;
   
    <varlistentry>
     <term><parameter>is_associative</parameter></term>
     <listitem>
      <para>
       If set to &false; or not supplied then the array is returned as a regular, 
       numerically indexed array.  If the argument is set to &true; then
       <function>localtime</function> returns an associative array containing
       all the different elements of the structure returned by the C
       function call to localtime.  The names of the different keys of
       the associative array are as follows:
      </para>
      <para>
       <itemizedlist>
        <listitem>
         <simpara>
          "tm_sec" - seconds, <literal>0</literal> to <literal>59</literal>
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          "tm_min" - minutes, <literal>0</literal> to <literal>59</literal>
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          "tm_hour" - hours, <literal>0</literal> to <literal>23</literal>
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          "tm_mday" - day of the month, <literal>1</literal> to <literal>31</literal>
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          "tm_mon" - month of the year, <literal>0</literal> (Jan) to <literal>11</literal> (Dec)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          "tm_year" - years since 1900
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          "tm_wday" - day of the week, <literal>0</literal> (Sun) to <literal>6</literal> (Sat)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          "tm_yday" - day of the year, <literal>0</literal> to <literal>365</literal>
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          "tm_isdst" - is daylight savings time in effect? 
         </simpara>
         <simpara>
          Positive if yes, <literal>0</literal> if not, negative if unknown.
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </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>localtime</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$localtime = localtime();
$localtime_assoc = localtime(time(), true);
print_r($localtime);
print_r($localtime_assoc);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Array
(
    [0] => 24
    [1] => 3
    [2] => 19
    [3] => 3
    [4] => 3
    [5] => 105
    [6] => 0
    [7] => 92
    [8] => 1
)

Array
(
    [tm_sec] => 24
    [tm_min] => 3
    [tm_hour] => 19
    [tm_mday] => 3
    [tm_mon] => 3
    [tm_year] => 105
    [tm_wday] => 0
    [tm_yday] => 92
    [tm_isdst] => 1
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

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