reference/datetime/datetimeimmutable/setdate.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.setdate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>DateTimeImmutable::setDate</refname>
...
...
@@ -9,20 +8,115 @@
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::setDate</methodname>
14
13
<methodparam><type>int</type><parameter>year</parameter></methodparam>
15
14
<methodparam><type>int</type><parameter>month</parameter></methodparam>
16
15
<methodparam><type>int</type><parameter>day</parameter></methodparam>
17
16
</methodsynopsis>
18
17
<para>
19
-
Like <methodname>DateTime::setDate</methodname> but works with
20
-
<classname>DateTimeImmutable</classname>.
18
+
Returns a new DateTimeImmutable object with the current date of the
19
+
DateTimeImmutable object set to the given date.
21
20
</para>
22
21
</refsect1>
23
22
24
-
</refentry>
23
+
<refsect1 role="parameters">
24
+
&reftitle.parameters;
25
+
<variablelist>
26
+
&date.datetime.description.modified;
27
+
<varlistentry>
28
+
<term><parameter>year</parameter></term>
29
+
<listitem>
30
+
<para>
31
+
Year of the date.
32
+
</para>
33
+
</listitem>
34
+
</varlistentry>
35
+
<varlistentry>
36
+
<term><parameter>month</parameter></term>
37
+
<listitem>
38
+
<para>
39
+
Month of the date.
40
+
</para>
41
+
</listitem>
42
+
</varlistentry>
43
+
<varlistentry>
44
+
<term><parameter>day</parameter></term>
45
+
<listitem>
46
+
<para>
47
+
Day of the date.
48
+
</para>
49
+
</listitem>
50
+
</varlistentry>
51
+
</variablelist>
52
+
</refsect1>
53
+
54
+
<refsect1 role="returnvalues">
55
+
&reftitle.returnvalues;
56
+
<para>
57
+
&date.datetimeimmutable.return.modifiedobject;
58
+
</para>
59
+
</refsect1>
60
+
61
+
<refsect1 role="examples">
62
+
&reftitle.examples;
63
+
<example>
64
+
<title><function>DateTimeImmutable::setDate</function> example</title>
65
+
<para>&style.oop;</para>
66
+
<programlisting role="php">
67
+
<![CDATA[
68
+
<?php
69
+
$date = new DateTimeImmutable();
70
+
$newDate = $date->setDate(2001, 2, 3);
71
+
echo $newDate->format('Y-m-d');
72
+
?>
73
+
]]>
74
+
</programlisting>
75
+
&examples.outputs;
76
+
<screen>
77
+
<![CDATA[
78
+
2001-02-03
79
+
]]>
80
+
</screen>
81
+
</example>
82
+
<example>
83
+
<title>Values exceeding ranges are added to their parent values</title>
84
+
<programlisting role="php">
85
+
<![CDATA[
86
+
<?php
87
+
$date = new DateTimeImmutable();
25
88
89
+
$newDate = $date->setDate(2001, 2, 28);
90
+
echo $newDate->format('Y-m-d') . "\n";
91
+
92
+
$newDate = $date->setDate(2001, 2, 29);
93
+
echo $newDate->format('Y-m-d') . "\n";
94
+
95
+
$newDate = $date->setDate(2001, 14, 3);
96
+
echo $newDate->format('Y-m-d') . "\n";
97
+
?>
98
+
]]>
99
+
</programlisting>
100
+
&example.outputs;
101
+
<screen>
102
+
<![CDATA[
103
+
2001-02-28
104
+
2001-03-01
105
+
2002-02-03
106
+
]]>
107
+
</screen>
108
+
</example>
109
+
</refsect1>
110
+
111
+
<refsect1 role="seealso">
112
+
&reftitle.seealso;
113
+
<simplelist>
114
+
<member><function>DateTimeImmutable::setISODate</function></member>
115
+
<member><function>DateTimeImmutable::setTime</function></member>
116
+
</simplelist>
117
+
</refsect1>
118
+
119
+
</refentry>
26
120
<!-- Keep this comment at the end of the file
27
121
Local variables:
28
122
mode: sgml
29
123