reference/datetime/datetimeimmutable/settime.xml
02ff7fef5b34cf8f5395180d9d39fb64d9398d00
02ff7fef5b34cf8f5395180d9d39fb64d9398d00
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-
4
3
<refentry xml:id="datetimeimmutable.settime" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>DateTimeImmutable::setTime</refname>
...
...
@@ -9,21 +8,159 @@
9
8
10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis role="oop">
11
+
<methodsynopsis role="DateTimeImmutable">
13
12
<modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::setTime</methodname>
14
13
<methodparam><type>int</type><parameter>hour</parameter></methodparam>
15
14
<methodparam><type>int</type><parameter>minute</parameter></methodparam>
16
15
<methodparam choice="opt"><type>int</type><parameter>second</parameter><initializer>0</initializer></methodparam>
17
-
<methodparam choice="opt"><type>int</type><parameter>microseconds</parameter><initializer>0</initializer></methodparam>
16
+
<methodparam choice="opt"><type>int</type><parameter>microsecond</parameter><initializer>0</initializer></methodparam>
18
17
</methodsynopsis>
19
18
<para>
20
-
Like <methodname>DateTime::setTime</methodname> but works with
21
-
<classname>DateTimeImmutable</classname>.
19
+
Returns a new DateTimeImmutable object with the time set to the given time.
22
20
</para>
23
21
</refsect1>
24
22
25
-
</refentry>
23
+
<refsect1 role="parameters">
24
+
&reftitle.parameters;
25
+
<variablelist>
26
+
<varlistentry>
27
+
<term><parameter>hour</parameter></term>
28
+
<listitem>
29
+
<para>
30
+
Hour of the time.
31
+
</para>
32
+
</listitem>
33
+
</varlistentry>
34
+
<varlistentry>
35
+
<term><parameter>minute</parameter></term>
36
+
<listitem>
37
+
<para>
38
+
Minute of the time.
39
+
</para>
40
+
</listitem>
41
+
</varlistentry>
42
+
<varlistentry>
43
+
<term><parameter>second</parameter></term>
44
+
<listitem>
45
+
<para>
46
+
Second of the time.
47
+
</para>
48
+
</listitem>
49
+
</varlistentry>
50
+
<varlistentry>
51
+
<term><parameter>microsecond</parameter></term>
52
+
<listitem>
53
+
<para>
54
+
Microsecond of the time.
55
+
</para>
56
+
</listitem>
57
+
</varlistentry>
58
+
</variablelist>
59
+
</refsect1>
60
+
61
+
<refsect1 role="returnvalues">
62
+
&reftitle.returnvalues;
63
+
<para>
64
+
&date.datetimeimmutable.return.modifiedobject;
65
+
</para>
66
+
</refsect1>
67
+
68
+
<refsect1 role="changelog">
69
+
&reftitle.changelog;
70
+
<informaltable>
71
+
<tgroup cols="2">
72
+
<thead>
73
+
<row>
74
+
<entry>&Version;</entry>
75
+
<entry>&Description;</entry>
76
+
</row>
77
+
</thead>
78
+
<tbody>
79
+
<row>
80
+
<entry>8.1.0</entry>
81
+
<entry>The behaviour with double existing hours (during the fall-back
82
+
DST transition) changed. Previously PHP would pick the second occurrence
83
+
(after the DST transition), instead of the first occurrence (before DST
84
+
transition).</entry>
85
+
</row>
86
+
<row>
87
+
<entry>7.1.0</entry>
88
+
<entry>The <parameter>microsecond</parameter> parameter was added.</entry>
89
+
</row>
90
+
</tbody>
91
+
</tgroup>
92
+
</informaltable>
93
+
</refsect1>
94
+
95
+
<refsect1 role="examples">
96
+
&reftitle.examples;
97
+
<example>
98
+
<title><function>DateTimeImmutable::setTime</function> example</title>
99
+
<para>&style.oop;</para>
100
+
<programlisting role="php">
101
+
<![CDATA[
102
+
<?php
103
+
$date = new DateTimeImmutable('2001-01-01');
104
+
105
+
$newDate = $date->setTime(14, 55);
106
+
echo $newDate->format('Y-m-d H:i:s') . "\n";
26
107
108
+
$newDate = $date->setTime(14, 55, 24);
109
+
echo $newDate->format('Y-m-d H:i:s') . "\n";
110
+
?>
111
+
]]>
112
+
</programlisting>
113
+
&examples.outputs.similar;
114
+
<screen>
115
+
<![CDATA[
116
+
2001-01-01 14:55:00
117
+
2001-01-01 14:55:24
118
+
]]>
119
+
</screen>
120
+
</example>
121
+
<example>
122
+
<title>Values exceeding ranges are added to their parent values</title>
123
+
<programlisting role="php">
124
+
<![CDATA[
125
+
<?php
126
+
$date = new DateTimeImmutable('2001-01-01');
127
+
128
+
$newDate = $date->setTime(14, 55, 24);
129
+
echo $newDate->format('Y-m-d H:i:s') . "\n";
130
+
131
+
$newDate = $date->setTime(14, 55, 65);
132
+
echo $newDate->format('Y-m-d H:i:s') . "\n";
133
+
134
+
$newDate = $date->setTime(14, 65, 24);
135
+
echo $newDate->format('Y-m-d H:i:s') . "\n";
136
+
137
+
$newDate = $date->setTime(25, 55, 24);
138
+
echo $newDate->format('Y-m-d H:i:s') . "\n";
139
+
?>
140
+
]]>
141
+
</programlisting>
142
+
&example.outputs;
143
+
<screen>
144
+
<![CDATA[
145
+
2001-01-01 14:55:24
146
+
2001-01-01 14:56:05
147
+
2001-01-01 15:05:24
148
+
2001-01-02 01:55:24
149
+
]]>
150
+
</screen>
151
+
</example>
152
+
</refsect1>
153
+
154
+
<refsect1 role="seealso">
155
+
&reftitle.seealso;
156
+
<simplelist>
157
+
<member><function>DateTimeImmutable::setDate</function></member>
158
+
<member><function>DateTimeImmutable::setISODate</function></member>
159
+
</simplelist>
160
+
</refsect1>
161
+
162
+
163
+
</refentry>
27
164
<!-- Keep this comment at the end of the file
28
165
Local variables:
29
166
mode: sgml
30
167