DatePeriod 类

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

简介

DatePeriod 类表示一个时间周期。

时间周期内允许对一组日期和时间进行迭代,在指定的时间间隔内定期重复。

类摘要

class DatePeriod implements IteratorAggregate {
/* 常量 */
const int EXCLUDE_START_DATE = 1;
const int INCLUDE_END_DATE = 2;
/* 属性 */
public int $recurrences;
public bool $include_end_date;
public bool $include_start_date;
/* 方法 */
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() 构造函数中使用,排除开始时间。

DatePeriod::INCLUDE_END_DATE

DatePeriod::__construct() 构造函数中使用,包含结束时间。

属性

recurrences

如果通过显式的传入 $recurrences 来创建的 DatePeriod 实例, 那么这个参数表示循环次数。 参见:DatePeriod::getRecurrences()

include_end_date

在循环过程中,是否包含结束时间。

include_start_date

在循环过程中,是否包含开始时间。

start

时间周期的开始时间。

current

表示在时间周期内迭代的时候,当前的时间。

end

时间周期的结束时间。

interval

ISO 8601 格式的间隔。

更新日志

版本 说明
8.2.0 新增 DatePeriod::INCLUDE_END_DATE 常量和 include_end_date 属性。
8.0.0 现在 DatePeriod 实现了(implement) IteratorAggregate。之前实现的是 Traversable

目录