DatePeriod::getRecurrences

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

DatePeriod::getRecurrences — Recupera el número de recurrencias

Descripción

Estilo orientado a objetos

public DatePeriod::getRecurrences(): ?int

Recupera el número de recurrencias.

Parámetros

Esta función no contiene ningún parámetro.

Valores devueltos

El número de recurrencias se define pasando explícitamente las $recurrences al constructor de la clase DatePeriod, de lo contrario se define como null.

Ejemplos

Ejemplo #1 Valores diferentes 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;
// recurrencias definidas explícitamente a través del 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";

// recurrencias no definidas en el 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());

El ejemplo anterior mostrará:

5
5
5

NULL
NULL

Ver también

DatePeriod::$recurrences