reference/datetime/dateperiod/getrecurrences.xml
02ff7fef5b34cf8f5395180d9d39fb64d9398d00
...
...
@@ -9,7 +9,7 @@
9
9
<refsect1 role="description">
10
10
&reftitle.description;
11
11
<para>&style.oop;</para>
12
-
<methodsynopsis role="oop">
12
+
<methodsynopsis role="DatePeriod">
13
13
<modifier>public</modifier> <type class="union"><type>int</type><type>null</type></type><methodname>DatePeriod::getRecurrences</methodname>
14
14
<void/>
15
15
</methodsynopsis>
...
...
@@ -26,7 +26,52 @@
26
26
<refsect1 role="returnvalues">
27
27
&reftitle.returnvalues;
28
28
<para>
29
-
Returns the number of recurrences.
29
+
The number of recurrences as set by explicitly passing the
30
+
<literal>$recurrences</literal> to the contructor of the
31
+
<classname>DatePeriod</classname> class, or &null; otherwise.
32
+
</para>
33
+
</refsect1>
34
+
35
+
<refsect1 role="examples">
36
+
&reftitle.examples;
37
+
<para>
38
+
<example>
39
+
<title>Different values for <methodname>DatePeriod::getRecurrences</methodname></title>
40
+
<programlisting role="php">
41
+
<![CDATA[<?php
42
+
$start = new DateTime('2018-12-31 00:00:00');
43
+
$end = new DateTime('2021-12-31 00:00:00');
44
+
$interval = new DateInterval('P1M');
45
+
$recurrences = 5;
46
+

47
+
// recurrences explicitly set through the constructor
48
+
$period = new DatePeriod($start, $interval, $recurrences, DatePeriod::EXCLUDE_START_DATE);
49
+
echo $period->getRecurrences(), "\n";
50
+

51
+
$period = new DatePeriod($start, $interval, $recurrences);
52
+
echo $period->getRecurrences(), "\n";
53
+

54
+
$period = new DatePeriod($start, $interval, $recurrences, DatePeriod::INCLUDE_END_DATE);
55
+
echo $period->getRecurrences(), "\n\n";
56
+

57
+
// recurrences not set in the constructor
58
+
$period = new DatePeriod($start, $interval, $end);
59
+
var_dump($period->getRecurrences());
60
+

61
+
$period = new DatePeriod($start, $interval, $end, DatePeriod::EXCLUDE_START_DATE);
62
+
var_dump($period->getRecurrences());
63
+
?>]]>
64
+
</programlisting>
65
+
&example.outputs;
66
+
<screen role="php">
67
+
5
68
+
5
69
+
5
70
+

71
+
NULL
72
+
NULL
73
+
</screen>
74
+
</example>
30
75
</para>
31
76
</refsect1>
32
77

33
78