(PHP 7 >= 7.2.17/7.3.4, PHP 8)
DatePeriod::getRecurrences — Gets the number of recurrences
Object-oriented style
Get the number of recurrences.
This function has no parameters.
The number of recurrences as set by explicitly passing the
$recurrences to the contructor of the
DatePeriod class, or null otherwise.
Example #1 Different values for DatePeriod::getRecurrences()
<?php
$start = new DateTime('2018-12-31 00:00:00');
$end = new DateTime('2021-12-31 00:00:00');
$interval = new DateInterval('P1M');
$recurrences = 5;
// recurrences explicitly set through the constructor
$period = new DatePeriod($start, $interval, $recurrences, DatePeriod::EXCLUDE_START_DATE);
echo $period->getRecurrences(), "\n";
$period = new DatePeriod($start, $interval, $recurrences);
echo $period->getRecurrences(), "\n";
$period = new DatePeriod($start, $interval, $recurrences, DatePeriod::INCLUDE_END_DATE);
echo $period->getRecurrences(), "\n\n";
// recurrences not set in the constructor
$period = new DatePeriod($start, $interval, $end);
var_dump($period->getRecurrences());
$period = new DatePeriod($start, $interval, $end, DatePeriod::EXCLUDE_START_DATE);
var_dump($period->getRecurrences());
?>The above example will output: