Obtém o número de recorrências

# DatePeriod::getRecurrences

(PHP 7 >= 7.2.17/7.3.4, PHP 8)

DatePeriod::getRecurrences — Obtém o número de recorrências

### Descrição

Estilo orientado a objetos

public function DatePeriod::getRecurrences(): ?int

Obtém o número de recorrências.

### Parâmetros

Esta função não possui parâmetros.

### Valor Retornado

O número de recorrências como definido explicitamente pelo parâmetro `$recurrences` passado ao construtor da classe DatePeriod, ou `null` caso não tenha sido definido.

### Exemplos

Exemplo #1 Diferentes valores para 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;

    // recorrências definidas explicitamente através do construtor
    $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";

    // recorrências não definidas no construtor
    $period = new DatePeriod($start, $interval, $end);
    var_dump($period->getRecurrences());

    $period = new DatePeriod($start, $interval, $end, DatePeriod::EXCLUDE_START_DATE);
    var_dump($period->getRecurrences());

O exemplo acima produzirá:

    5
    5
    5

    NULL
    NULL

### Veja Também

- DatePeriod::$recurrences

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open