File: getdate.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (187 lines) | stat: -rw-r--r-- 5,456 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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<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>int</type><parameter>timestamp</parameter><initializer>time()</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 no <parameter>timestamp</parameter> is given.
  </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="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>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
-->