reference/datetime/datetimeimmutable/add.xml
02ff7fef5b34cf8f5395180d9d39fb64d9398d00
...
...
@@ -1,28 +1,124 @@
1
1
<?xml version="1.0" encoding="utf-8"?>
2
2
<!-- $Revision$ -->
3
-

4
3
<refentry xml:id="datetimeimmutable.add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
5
4
<refnamediv>
6
5
<refname>DateTimeImmutable::add</refname>
7
6
<refpurpose>
8
-
Adds an amount of days, months, years, hours, minutes and seconds
7
+
Returns a new object, with added amount of days, months, years, hours, minutes and seconds
9
8
</refpurpose>
10
9
</refnamediv>
11
10

12
11
<refsect1 role="description">
13
12
&reftitle.description;
14
-
<methodsynopsis role="oop">
13
+
<methodsynopsis role="DateTimeImmutable">
15
14
<modifier>public</modifier> <type>DateTimeImmutable</type><methodname>DateTimeImmutable::add</methodname>
16
15
<methodparam><type>DateInterval</type><parameter>interval</parameter></methodparam>
17
16
</methodsynopsis>
18
17
<para>
19
-
Like <methodname>DateTime::add</methodname> but works with
20
-
<classname>DateTimeImmutable</classname>.
18
+
Creates a new <classname>DateTimeImmutable</classname> object, and adds the
19
+
specified <classname>DateInterval</classname> object to this, to represent
20
+
the new value.
21
21
</para>
22
22
</refsect1>
23
23

24
-
</refentry>
24
+
<refsect1 role="parameters">
25
+
&reftitle.parameters;
26
+
<variablelist>
27
+
<varlistentry>
28
+
<term>
29
+
<parameter>interval</parameter>
30
+
</term>
31
+
<listitem>
32
+
<para>
33
+
A <classname>DateInterval</classname> object
34
+
</para>
35
+
</listitem>
36
+
</varlistentry>
37
+
</variablelist>
38
+
</refsect1>
39
+

40
+
<refsect1 role="returnvalues">
41
+
&reftitle.returnvalues;
42
+
<para>
43
+
&date.datetimeimmutable.return.modifiedobject;
44
+
</para>
45
+
</refsect1>
46
+

47
+
<refsect1 role="examples">
48
+
&reftitle.examples;
49
+
<example>
50
+
<title><function>DateTimeImmutable::add</function> example</title>
51
+
<para>&style.oop;</para>
52
+
<programlisting role="php">
53
+
<![CDATA[
54
+
<?php
55
+
$date = new DateTimeImmutable('2000-01-01');
56
+
$newDate = $date->add(new DateInterval('P10D'));
57
+
echo $newDate->format('Y-m-d') . "\n";
58
+
?>
59
+
]]>
60
+
</programlisting>
61
+
</example>
25
62

63
+
<example>
64
+
<title>Further <function>DateTimeImmutable::add</function> examples</title>
65
+
<programlisting role="php">
66
+
<![CDATA[
67
+
<?php
68
+
$date = new DateTimeImmutable('2000-01-01');
69
+
$newDate = $date->add(new DateInterval('PT10H30S'));
70
+
echo $newDate->format('Y-m-d H:i:s') . "\n";
71
+

72
+
$date = new DateTimeImmutable('2000-01-01');
73
+
$newDate = $date->add(new DateInterval('P7Y5M4DT4H3M2S'));
74
+
echo $newDate->format('Y-m-d H:i:s') . "\n";
75
+
?>
76
+
]]>
77
+
</programlisting>
78
+
&example.outputs;
79
+
<screen>
80
+
<![CDATA[
81
+
2000-01-01 10:00:30
82
+
2007-06-05 04:03:02
83
+
]]>
84
+
</screen>
85
+
</example>
86
+

87
+
<example>
88
+
<title>Beware when adding months</title>
89
+
<programlisting role="php">
90
+
<![CDATA[
91
+
<?php
92
+
$date = new DateTimeImmutable('2000-12-31');
93
+
$interval = new DateInterval('P1M');
94
+

95
+
$newDate1 = $date->add($interval);
96
+
echo $newDate1->format('Y-m-d') . "\n";
97
+

98
+
$newDate2 = $newDate1->add($interval);
99
+
echo $newDate2->format('Y-m-d') . "\n";
100
+
?>
101
+
]]>
102
+
</programlisting>
103
+
&example.outputs;
104
+
<screen>
105
+
<![CDATA[
106
+
2001-01-31
107
+
2001-03-03
108
+
]]>
109
+
</screen>
110
+
</example>
111
+
</refsect1>
112
+

113
+
<refsect1 role="seealso">
114
+
&reftitle.seealso;
115
+
<simplelist>
116
+
<member><function>DateTimeImmutable::sub</function></member>
117
+
<member><function>DateTimeImmutable::diff</function></member>
118
+
<member><function>DateTimeImmutable::modify</function></member>
119
+
</simplelist>
120
+
</refsect1>
121
+
</refentry>
26
122
<!-- Keep this comment at the end of the file
27
123
Local variables:
28
124
mode: sgml
29
125