DatePeriod::getRecurrences

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

DatePeriod::getRecurrences — 繰り返しの数を取得する

説明

オブジェクト指向型

public DatePeriod::getRecurrences(): ?int

繰り返しの数を取得します。

パラメータ

この関数にはパラメータはありません。

戻り値

DatePeriod のコンストラクタの $recurrences に明示的に渡すことで設定した繰り返しの数を返します。設定されていない場合、null を返します。

例

例1 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;
// コンストラクタで明示的に繰り返し回数を設定
$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";
// コンストラクタで繰り返し回数を設定しない場合
$period = new DatePeriod($start, $interval, $end);
var_dump($period->getRecurrences());
$period = new DatePeriod($start, $interval, $end, DatePeriod::EXCLUDE_START_DATE);
var_dump($period->getRecurrences());

上の例の出力は以下となります。

5
5
5

NULL
NULL

参考

DatePeriod::$recurrences