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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.idate" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>idate</refname>
<refpurpose>Format a local time/date part as integer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>false</type></type><methodname>idate</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>timestamp</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Returns a number formatted according to the given format string using the
given integer <parameter>timestamp</parameter> or the current local time
if no timestamp is given. In other words, <parameter>timestamp</parameter>
is optional and defaults to the value of <function>time</function>.
</para>
<para>
Unlike the function <function>date</function>, <function>idate</function>
accepts just one char in the <parameter>format</parameter> parameter.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>format</parameter></term>
<listitem>
<para>
<table>
<title>The following characters are recognized in the
<parameter>format</parameter> parameter string</title>
<tgroup cols="2">
<thead>
<row>
<entry><parameter>format</parameter> character</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>B</literal></entry>
<entry>Swatch Beat/Internet Time</entry>
</row>
<row>
<entry><literal>d</literal></entry>
<entry>Day of the month</entry>
</row>
<row>
<entry><literal>h</literal></entry>
<entry>Hour (12 hour format)</entry>
</row>
<row>
<entry><literal>H</literal></entry>
<entry>Hour (24 hour format)</entry>
</row>
<row>
<entry><literal>i</literal></entry>
<entry>Minutes</entry>
</row>
<row>
<entry><literal>I</literal> (uppercase i)</entry>
<entry>returns <literal>1</literal> if DST is activated,
<literal>0</literal> otherwise</entry>
</row>
<row>
<entry><literal>L</literal> (uppercase l)</entry>
<entry>returns <literal>1</literal> for leap year,
<literal>0</literal> otherwise</entry>
</row>
<row>
<entry><literal>m</literal></entry>
<entry>Month number</entry>
</row>
<row>
<entry><literal>N</literal></entry>
<entry>ISO-8601 day of the week (<literal>1</literal> for Monday
through <literal>7</literal> for Sunday)</entry>
</row>
<row>
<entry><literal>o</literal></entry>
<entry>ISO-8601 year (4 digits)</entry>
</row>
<row>
<entry><literal>s</literal></entry>
<entry>Seconds</entry>
</row>
<row>
<entry><literal>t</literal></entry>
<entry>Days in current month</entry>
</row>
<row>
<entry><literal>U</literal></entry>
<entry>Seconds since the Unix Epoch - January 1 1970 00:00:00 UTC -
this is the same as <function>time</function></entry>
</row>
<row>
<entry><literal>w</literal></entry>
<entry>Day of the week (<literal>0</literal> on Sunday)</entry>
</row>
<row>
<entry><literal>W</literal></entry>
<entry>ISO-8601 week number of year, weeks starting on
Monday</entry>
</row>
<row>
<entry><literal>y</literal></entry>
<entry>Year (1 or 2 digits - check note below)</entry>
</row>
<row>
<entry><literal>Y</literal></entry>
<entry>Year (4 digits)</entry>
</row>
<row>
<entry><literal>z</literal></entry>
<entry>Day of the year</entry>
</row>
<row>
<entry><literal>Z</literal></entry>
<entry>Timezone offset in seconds</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
&date.timestamp.description;
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an <type>int</type> on success, &return.falseforfailure;.
</para>
<para>
As <function>idate</function> always returns an <type>int</type> and
as they can't start with a "0", <function>idate</function> may return
fewer digits than you would expect. See the example below.
</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>
<row>
<entry>8.2.0</entry>
<entry>
Adds the <literal>N</literal> (ISO-8601 day of the week) and
<literal>o</literal> (ISO-8601 year) format characters.
</entry>
</row>
<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>idate</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$timestamp = strtotime('1st January 2004'); //1072915200
// this prints the year in a two digit format
// however, as this would start with a "0", it
// only prints "4"
echo idate('y', $timestamp);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>DateTimeInterface::format</methodname></member>
<member><function>date</function></member>
<member><function>getdate</function></member>
<member><function>time</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
-->
|
