reference/datetime/datetimeimmutable/modify.xml
a11c5b53bc132289a0ddcc6d3efee5d97f0027b4
...
...
@@ -1,6 +1,5 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="datetimeimmutable.modify" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>DateTimeImmutable::modify</refname>
...
...
@@ -9,9 +8,9 @@
9
8

10
9
<refsect1 role="description">
11
10
&reftitle.description;
12
-
<methodsynopsis role="oop">
13
-
<modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::modify</methodname>
14
-
<methodparam><type>string</type><parameter>modify</parameter></methodparam>
11
+
<methodsynopsis role="DateTimeImmutable">
12
+
<modifier>public</modifier> <type class="union"><type>DateTimeImmutable</type><type>false</type></type><methodname>DateTimeImmutable::modify</methodname>
13
+
<methodparam><type>string</type><parameter>modifier</parameter></methodparam>
15
14
</methodsynopsis>
16
15
<para>
17
16
Creates a new <type>DateTimeImmutable</type> object with modified timestamp.
...
...
@@ -22,9 +21,8 @@
22
21
<refsect1 role="parameters">
23
22
&reftitle.parameters;
24
23
<variablelist>
25
-
&date.datetime.description.modified;
26
24
<varlistentry>
27
-
<term><parameter>modify</parameter></term>
25
+
<term><parameter>modifier</parameter></term>
28
26
<listitem>
29
27
<para>&date.formats.parameter;</para>
30
28
</listitem>
...
...
@@ -35,12 +33,101 @@
35
33
<refsect1 role="returnvalues">
36
34
&reftitle.returnvalues;
37
35
<para>
38
-
Returns the newly created object&return.falseforfailure;.
36
+
Returns a new modified DateTimeImmutable object&return.falseforfailure;.
39
37
</para>
40
38
</refsect1>
41
39

42
-
</refentry>
40
+
<refsect1 role="errors">
41
+
&reftitle.errors;
42
+
<para>
43
+
If an invalid Date/Time string is passed,
44
+
<exceptionname>DateMalformedStringException</exceptionname> is thrown.
45
+
Previous to PHP 8.3, this was a warning.
46
+
</para>
47
+
</refsect1>
48
+

49
+
<refsect1 role="changelog">
50
+
&reftitle.changelog;
51
+
<informaltable>
52
+
<tgroup cols="2">
53
+
<thead>
54
+
<row>
55
+
<entry>&Version;</entry>
56
+
<entry>&Description;</entry>
57
+
</row>
58
+
</thead>
59
+
<tbody>
60
+
<row>
61
+
<entry>8.3.0</entry>
62
+
<entry>
63
+
Now throws
64
+
<exceptionname>DateMalformedStringException</exceptionname> if an
65
+
invalid string is passed, instead of a warning.
66
+
</entry>
67
+
</row>
68
+
</tbody>
69
+
</tgroup>
70
+
</informaltable>
71
+
</refsect1>
72
+
<refsect1 role="examples">
73
+
&reftitle.examples;
74
+
<example>
75
+
<title><function>DateTimeImmutable::modify</function> example</title>
76
+
<para>&style.oop;</para>
77
+
<programlisting role="php">
78
+
<![CDATA[
79
+
<?php
80
+
$date = new DateTimeImmutable('2006-12-12');
81
+
$newDate = $date->modify('+1 day');
82
+
echo $newDate->format('Y-m-d');
83
+
?>
84
+
]]>
85
+
</programlisting>
86
+
&examples.outputs;
87
+
<screen>
88
+
<![CDATA[
89
+
2006-12-13
90
+
]]>
91
+
</screen>
92
+
</example>
93
+
<example>
94
+
<title>Beware when adding or subtracting months</title>
95
+
<programlisting role="php">
96
+
<![CDATA[
97
+
<?php
98
+
$date = new DateTimeImmutable('2000-12-31');
43
99

100
+
$newDate1 = $date->modify('+1 month');
101
+
echo $newDate1->format('Y-m-d') . "\n";
102
+

103
+
$newDate2 = $newDate1->modify('+1 month');
104
+
echo $newDate2->format('Y-m-d') . "\n";
105
+
?>
106
+
]]>
107
+
</programlisting>
108
+
&example.outputs;
109
+
<screen>
110
+
<![CDATA[
111
+
2001-01-31
112
+
2001-03-03
113
+
]]>
114
+
</screen>
115
+
</example>
116
+
</refsect1>
117
+

118
+
<refsect1 role="seealso">
119
+
&reftitle.seealso;
120
+
<simplelist>
121
+
<member><function>DateTimeImmutable::add</function></member>
122
+
<member><function>DateTimeImmutable::sub</function></member>
123
+
<member><function>DateTimeImmutable::setDate</function></member>
124
+
<member><function>DateTimeImmutable::setISODate</function></member>
125
+
<member><function>DateTimeImmutable::setTime</function></member>
126
+
<member><function>DateTimeImmutable::setTimestamp</function></member>
127
+
</simplelist>
128
+
</refsect1>
129
+

130
+
</refentry>
44
131
<!-- Keep this comment at the end of the file
45
132
Local variables:
46
133
mode: sgml
47
134