File: localtime.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (150 lines) | stat: -rw-r--r-- 3,653 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/datetime.xml, last change in rev 1.10 -->
<refentry id="function.localtime">
 <refnamediv>
  <refname>localtime</refname>
  <refpurpose>Get the local time</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <methodsynopsis>
   <type>array</type><methodname>localtime</methodname>
   <methodparam choice="opt"><type>int</type><parameter>timestamp</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>is_associative</parameter></methodparam>
  </methodsynopsis>
  <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 as returned
   from <function>time</function> 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, starting with 0 for January
     </simpara>
    </listitem>
    <listitem>
     <simpara>
      "tm_year" - Years since 1900
     </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>
  <note>
   <simpara>
    Months are from 0 (Jan) to 11 (Dec) and days of the week are from 0 (Sun) to 6 (Sat).
   </simpara>
  </note>
  <para>
   <example>
    <title><function>time</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$localtime = localtime();
$localtime_assoc = localtime(time(), 1);
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
    [9] => 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>
</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:"../../../../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
-->