DatePeriod クラス

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

はじめに

日付の期間をあらわします。

日付の期間を使うと、指定した期間に定期的に発生する内容を反復処理できます。

class DatePeriod implements IteratorAggregate {

/* 定数 */

const int EXCLUDE_START_DATE = 1;

/* プロパティ */

public int $recurrences;

public bool $include_start_date;

public DateTimeInterface $start;

public DateTimeInterface $current;

public DateTimeInterface $end;

public DateInterval $interval;

/* メソッド */

public __construct(
    DateTimeInterface $start,
    DateInterval $interval,
    int $recurrences,
    int $options = 0
)

public __construct(
    DateTimeInterface $start,
    DateInterval $interval,
    DateTimeInterface $end,
    int $options = 0
)

public __construct(string $isostr, int $options = 0)

public getRecurrences(): ?int

}

DatePeriod::EXCLUDE_START_DATE: 開始日を含まない。DatePeriod::__construct() で使用します。

recurrences: DatePeriod インスタンスが $recurrences を明示的に渡すことによって作成された場合の反復回数 DatePeriod::getRecurrences() もご覧ください。
include_start_date: 開始日を反復日のセットに含めるかどうか。
start: 期間の開始日。
current: 反復中に期間内の現在の日付が含まれます。
end: 期間の終了日。
interval: ISO 8601 の繰り返し間隔の指定。

バージョン	説明
8.0.0	DatePeriod は、 IteratorAggregate を実装するようになりました。これより前のバージョンでは、 Traversable を実装していました。