PHP Conference Japan 2024

    DatePeriod 类

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

    简介

    表示一个日期周期。

    日期周期允许迭代给定周期内以规律间隔重复的一组日期和时间。

    类概要

    class DatePeriod implements IteratorAggregate {
    /* 常量 */
    public const int EXCLUDE_START_DATE;
    public const int INCLUDE_END_DATE;
    /* 属性 */
    public readonly ?DateTimeInterface $start;
    public readonly ?DateTimeInterface $current;
    public readonly ?DateTimeInterface $end;
    public readonly ?DateInterval $interval;
    public readonly int $recurrences;
    public readonly bool $include_start_date;
    public readonly bool $include_end_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 static createFromISO8601String(string $specification, int $options = 0): static
    public getDateInterval(): DateInterval
    public getEndDate(): ?DateTimeInterface
    public getRecurrences(): ?int
    public getStartDate(): DateTimeInterface
    }

    预定义常量

    DatePeriod::EXCLUDE_START_DATE int

    排除起始日期，在 DatePeriod::__construct() 中使用。

    DatePeriod::INCLUDE_END_DATE int

    包含结束日期，在 DatePeriod::__construct() 中使用。

    属性

    recurrences

    迭代器返回的最小实例数。

    如果在 DatePeriod 实例的构造函数中通过 recurrences 参数显式传递了重复次数，则此属性包含此值，加上如果起始日期未通过 DatePeriod::EXCLUDE_START_DATE 禁用则为 1，加上如果结束日期已通过 DatePeriod::INCLUDE_END_DATE 启用则为 1。

    如果未显式传递重复次数，则此属性包含返回实例的最小数量。这将是 0，加上如果起始日期未通过 DatePeriod::EXCLUDE_START_DATE 禁用则为 1，加上如果结束日期已通过 DatePeriod::INCLUDE_END_DATE 启用则为 1。

    <?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->recurrences, "\n";

    $period = new DatePeriod($start, $interval, $recurrences);
    echo     $period->recurrences, "\n";

    $period = new DatePeriod($start, $interval, $recurrences, DatePeriod::INCLUDE_END_DATE);
    echo     $period->recurrences, "\n";

    // 未在构造函数中设置循环次数
    $period = new DatePeriod($start, $interval, $end);
    echo     $period->recurrences, "\n";

    $period = new DatePeriod($start, $interval, $end, DatePeriod::EXCLUDE_START_DATE);
    echo     $period->recurrences, "\n";
    ?>

    以上示例将输出


    5
    6
    7
    1
    0

    另见 DatePeriod::getRecurrences()。

    include_end_date

    是否包含结束日期在重复日期集中。

    include_start_date

    是否包含开始日期在重复日期集中。

    start

    周期的开始日期。

    current

    在迭代期间，这将包含周期内的当前日期。

    end

    周期的结束日期。

    interval

    ISO 8601 重复间隔规范。

    变更日志

    版本 描述
    8.4.0 类常量现在已类型化。
    8.2.0 已添加DatePeriod::INCLUDE_END_DATE 常量和 include_end_date 属性。
    8.0.0 DatePeriod 现在实现 IteratorAggregate。之前，实现的是 Traversable。

    目录

    发现问题？

    了解如何改进此页面 • 提交拉取请求 • 报告错误
    ＋添加注释

    用户贡献的注释 1 条注释

    23
    mail at pascalhofmann dot de
    7 年前
    当循环遍历 DatePeriod 对象时，返回的对象始终实现 DateTimeInterface。返回的确切类型取决于 DatePeriod 的创建方式。如果 $start 是 DateTimeImmutable，则返回的对象将是 DateTimeImmutable 类型。如果使用了 DateTime 对象，则返回的对象将是 DateTime 类型。
    ＋添加注释
    To Top