Added localtime docs.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@22316 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Sterling Hughes 2000-04-02 04:37:28 +00:00
parent 754d3d1889
commit 5ecfba1db9

View file

@ -440,6 +440,90 @@ echo gmstrftime ("%b %d %Y %H:%M:%S", mktime (20,0,0,12,31,98))."\n";
</refsect1>
</refentry>
<refentry id="function.localtime">
<refnamediv>
<refname>localtime</refname>
<refpurpose>
Get the local time
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>array <function>localtime</function></funcdef>
<paramdef>int
<parameter>
<optional>timestamp</optional>
</parameter>
</paramdef>
<paramdef>bool
<parameter>
<optional>is_associative</optional>
</parameter>
</paramdef>
</funcsynopsis>
<para>
The <function>localtime</function> function returns an array identical to that
of the structure returned by the C function call. The first argument to
<function>localtime</function> is the timestamp, if this is not given the current
time is used. The second argument to the <function>localtime</function> is the
<parameter>is_associative</parameter>, if this is set to 0 or not supplied than the
array is returned as a regular, numerically indexed array. If the argument is set to
1 then <function>localtime</function> is 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:
<itemizedlist>
<listitem>
<simpara>
"tm_sec" - seconds
</simpara>
</listitem>
<listitem>
<simpara>
"tm_min" - minutes
</simpara>
</listitem>
<listitem>
<simpara>
"tm_hour" - hour
</simpara>
</listitem>
<listitem>
<simpara>
"tm_mday" - day of the month
</simpara>
</listitem>
<listitem>
<simpara>
"tm_mon" - month of the year
</simpara>
</listitem>
<listitem>
<simpara>
"tm_year" - Year, not y2k compliant
</simpara>
</listitem>
<listitem>
<simpara>
"tm_wday" - Day of the week
</simpara>
</listitem>
<listitem>
<simpara>
"tm_yday" - Day of the year
</simpara>
</listitem>
<listitem>
<simpara>
"tm_isdst" - Is daylight savings time in effect
<simpara>
</listitem>
</itemizedlist>
</para>
</refsect1>
</refentry>
<refentry id="function.microtime">
<refnamediv>
<refname>microtime</refname>