DatePeriod::getRecurrences

Gets the number of recurrences

&reftitle.description;

&style.oop;

public ``int``null```DatePeriod::getRecurrences`

Get the number of recurrences.

&reftitle.parameters; &no.function.parameters;
&reftitle.returnvalues;

The number of recurrences as set by explicitly passing the `$recurrences` to the contructor of the `DatePeriod` class, or &null; otherwise.

&reftitle.examples;

### 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());
    ?>

&example.outputs;

    5
    5
    5

    NULL
    NULL

&reftitle.seealso;

- DatePeriod::$recurrences