DateInterval クラス

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

はじめに

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

格納方式は、固定値 (年、月、日、時など) あるいは相対時刻 (DateTimeImmutable と DateTime のコンストラクタがサポートしている書式) となります。

さらに厳密に言うと、 DateInterval オブジェクトが保持している情報は、ある date/time オブジェクトから別の date/time オブジェクトに情報を移す手順です。この過程は必ずしも可逆ではありません。

DateInterval オブジェクトを生成する一般的なやり方は、 2つの date/time オブジェクトの差分を DateTimeInterface::diff() 経由で計算することです。

日付の間隔を比較する良い方法は定義されていません。よって、DateInterval のインスタンスは比較できません。

class DateInterval {

/* プロパティ */

public int $y;

public int $m;

public int $d;

public int $h;

public int $i;

public int $s;

public float $f;

public int $invert;

public mixed $days;

public bool $from_string;

public string $date_string;

/* メソッド */

public __construct(string $duration)

public static createFromDateString(string $datetime): DateInterval|false

public format(string $format): string

}

y: 年。
m: 月。
d: 日。
h: 時間。
i: 分。
s: 秒。
f: マイクロ秒。1秒の100万分の1です。
invert: 間隔が負の数になっている場合は 1、そうでない場合は 0。 DateInterval::format() を参照ください。
days: DateTimeImmutable::diff() や DateTime::diff() で作られた DateInterval オブジェクトの場合は、開始日と終了日の間の日数。それ以外の場合は days は false となります。
from_string: DateInterval::createFromDateString() で作られた DateInterval オブジェクトの場合は、このプロパティの値は true になり、 date_string の値が収集されます。そうでない場合、この値は false になり、 y, f, invert, days の値が収集されます。
date_string: DateInterval::createFromDateString() の引数として使われる文字列。

バージョン	説明
8.2.0	DateInterval::createFromDateString() で作られた DateInterval のインスタンスのために、プロパティ `from_string` と `date_string` が追加されました。
7.4.0	DateInterval インスタンスは、比較できなくなりました。これより前のバージョンでは、全ての DateInterval のインスタンスが等しいとみなされていました。
7.1.0	`f` プロパティが追加されました