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
244
245
246
247
248
249
250
251
252
253
254
255
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 299350 $ -->
<refentry xml:id="dateinterval.format" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>DateInterval::format</refname>
<refpurpose>Formats the interval</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="oop">
<modifier>public</modifier> <type>string</type><methodname>DateInterval::format</methodname>
<methodparam><type>string</type><parameter>format</parameter></methodparam>
</methodsynopsis>
<para>
Formats the interval.
</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.
Each format character must be proceeded by a percent sign
(<literal>%</literal>).
</title>
<tgroup cols="3">
<thead>
<row>
<entry><parameter>format</parameter> character</entry>
<entry>Description</entry>
<entry>Example values</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>%</literal></entry>
<entry>Literal <literal>%</literal></entry>
<entry><literal>%</literal></entry>
</row>
<row>
<entry><literal>Y</literal></entry>
<entry>Years, numeric, at least 2 digits with leading 0</entry>
<entry><literal>01</literal>, <literal>03</literal></entry>
</row>
<row>
<entry><literal>y</literal></entry>
<entry>Years, numeric</entry>
<entry><literal>1</literal>, <literal>3</literal></entry>
</row>
<row>
<entry><literal>M</literal></entry>
<entry>Months, numeric, at least 2 digits with leading 0</entry>
<entry><literal>01</literal>, <literal>03</literal>, <literal>12</literal></entry>
</row>
<row>
<entry><literal>m</literal></entry>
<entry>Months, numeric</entry>
<entry><literal>1</literal>, <literal>3</literal>, <literal>12</literal></entry>
</row>
<row>
<entry><literal>D</literal></entry>
<entry>Days, numeric, at least 2 digits with leading 0</entry>
<entry><literal>01</literal>, <literal>03</literal>, <literal>31</literal></entry>
</row>
<row>
<entry><literal>d</literal></entry>
<entry>Days, numeric</entry>
<entry><literal>1</literal>, <literal>3</literal>, <literal>31</literal></entry>
</row>
<row>
<entry><literal>a</literal></entry>
<entry>Total amount of days</entry>
<entry><literal>4</literal>, <literal>18</literal>, <literal>8123</literal></entry>
</row>
<row>
<entry><literal>H</literal></entry>
<entry>Hours, numeric, at least 2 digits with leading 0</entry>
<entry><literal>01</literal>, <literal>03</literal>, <literal>23</literal></entry>
</row>
<row>
<entry><literal>h</literal></entry>
<entry>Hours, numeric</entry>
<entry><literal>1</literal>, <literal>3</literal>, <literal>23</literal></entry>
</row>
<row>
<entry><literal>I</literal></entry>
<entry>Minutes, numeric, at least 2 digits with leading 0</entry>
<entry><literal>01</literal>, <literal>03</literal>, <literal>59</literal></entry>
</row>
<row>
<entry><literal>i</literal></entry>
<entry>Minutes, numeric</entry>
<entry><literal>1</literal>, <literal>3</literal>, <literal>59</literal></entry>
</row>
<row>
<entry><literal>S</literal></entry>
<entry>Seconds, numeric, at least 2 digits with leading 0</entry>
<entry><literal>01</literal>, <literal>03</literal>, <literal>57</literal></entry>
</row>
<row>
<entry><literal>s</literal></entry>
<entry>Seconds, numeric</entry>
<entry><literal>1</literal>, <literal>3</literal>, <literal>57</literal></entry>
</row>
<row>
<entry><literal>R</literal></entry>
<entry>Sign "<literal>-</literal>" when negative, "<literal>+</literal>" when positive</entry>
<entry><literal>-</literal>, <literal>+</literal></entry>
</row>
<row>
<entry><literal>r</literal></entry>
<entry>Sign "<literal>-</literal>" when negative, empty when positive</entry>
<entry><literal>-</literal>, <literal></literal></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the formatted interval.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
The <methodname>DateInterval::format</methodname> method does not
recalculate carry over points in time strings nor in date segments. This
is expected because it is not possible to overflow values like <literal>"32 days"</literal>
which could be interpreted as anything from <literal>"1 month and 4 days"</literal>
to <literal>"1 month and 1 day"</literal>.
</para>
</note>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><classname>DateInterval</classname> example</title>
<programlisting role="php">
<![CDATA[
<?php
$interval = new DateInterval('P2Y4DT6H8M');
echo $interval->format('%d days');
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
4 days
]]>
</screen>
</example>
</para>
<para>
<example>
<title><classname>DateInterval</classname> and carry over points</title>
<programlisting role="php">
<![CDATA[
<?php
$interval = new DateInterval('P32D');
echo $interval->format('%d days');
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
32 days
]]>
</screen>
</example>
</para>
<para>
<example>
<title>
<classname>DateInterval</classname> and
<methodname>DateTime::diff</methodname> with the %a and %d modifiers
</title>
<programlisting role="php">
<![CDATA[
<?php
$january = new DateTime('2010-01-01');
$february = new DateTime('2010-02-01');
$interval = $february->diff($january);
// %a will output the total number of days.
echo $interval->format('%a total days')."\n";
// While %d will only output the number of days not already covered by the
// month.
echo $interval->format('%m month, %d days');
?>
]]>
</programlisting>
&example.outputs;
<screen role="php">
<![CDATA[
31 total days
1 month, 0 days
]]>
</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:"~/.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
-->
|
