【PHP8.x】recurrencesプロパティの使い方

『recurrencesプロパティは、DatePeriodオブジェクトが繰り返す回数を保持するプロパティです』 DatePeriodオブジェクトは、特定の開始日時から一定の間隔で日付や時刻を繰り返し生成するために使用されます。このオブジェクトを作成する際、コンストラクタの第4引数で、何回繰り返すかを整数で指定することができます。recurrencesプロパティには、その時に設定された繰り返し回数が格納されます。例えば、「2024年4月1日から1週間ごとに5回」という条件でDatePeriodオブジェクトを生成した場合、このプロパティの値は整数の5になります。一方で、繰り返し回数ではなく終了日時を指定してオブジェクトを生成した場合、このプロパティの値はnullとなります。そのため、このプロパティの値を調べることで、そのDatePeriodオブジェクトが回数によって制限されているのか、あるいは終了日時によって制限されているのかを判別することが可能です。このプロパティは読み取り専用であり、オブジェクトが作成された後に値を変更することはできません。

Copy
1<?php
2
3// 開始日、間隔、4回の繰り返しを指定してDatePeriodオブジェクトを作成します
4$datePeriod = new DatePeriod(
5    new DateTime('2023-01-01'),
6    new DateInterval('P1D'),
7    4
8);
9
10// recurrences プロパティから繰り返し回数を取得します
11$numberOfRecurrences = $datePeriod->recurrences;
12
13?>

int|null

DatePeriod::recurrences は、この期間オブジェクトが繰り返される回数を整数で返します。繰り返し回数が設定されていない場合は null を返します。