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

}

プロパティ

警告

以下に示すプロパティが使えるかどうかは、 PHP のバージョンに依存します。そして、readonly と見なすべきです。

y: 年。
m: 月。
d: 日。
h: 時間。
i: 分。
s: 秒。
f: マイクロ秒。1秒の100万分の1です。
invert: 間隔が負の数になっている場合は 1、そうでない場合は 0。 DateInterval::format() を参照ください。
days: DateTimeImmutable::diff() や DateTime::diff() で作られた DateInterval オブジェクトの場合は、開始日と終了日の間の(丸一日、つまり0時から24時までの一日全体という意味での)日の数。それ以外の場合は 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` が追加されました。
8.2.0	プロパティ `y` から `f`, `invert`, `days` のみがアクセス可能になりました。
7.4.0	DateInterval インスタンスは、比較できなくなりました。これより前のバージョンでは、全ての DateInterval のインスタンスが等しいとみなされていました。
7.1.0	`f` プロパティが追加されました

If you want to reverse a date interval use array_reverse and iterator_to_array. I've found using invert to be unreliable.

<?php
$start_date = date_create("2021-01-01");
$end_date   = date_create("2021-01-05"); // If you want to include this date, add 1 day

$interval = DateInterval::createFromDateString('1 day');
$daterange = new DatePeriod($start_date, $interval ,$end_date);

function show_dates ($dr) {
    foreach($dr as $date1){
        echo $date1->format('Y-m-d').'<br>';
    }
}
 
show_dates ($daterange);
   
echo '<br>';

// reverse the array

$daterange = array_reverse(iterator_to_array($daterange));

show_dates ($daterange);
           
?>

Gives 
 2021-01-01
 2021-01-02
 2021-01-03
 2021-01-04

 2021-01-04
 2021-01-03
 2021-01-02
 2021-01-01

down

edgaras at levinson dot lt ¶

6 months ago

There is a handy way to compare intervals by adding them to 0 dates and comparing dates instead

<?php

function compare(DateInterval $first, DateInterval $second): int
{
    $firstDate = (new DateTime())->setTimestamp(0)->add($first);
    $secondDate = (new DateTime())->setTimestamp(0)->add($second);

    return $firstDate <=> $secondDate;
}

echo compare(new DateInterval('P2D'), new DateInterval('PT48H')) . PHP_EOL;
echo compare(DateInterval::createFromDateString('2 days'), DateInterval::createFromDateString('48 hours')) . PHP_EOL;
echo compare(DateInterval::createFromDateString('2 days'), DateInterval::createFromDateString('49 hours')) . PHP_EOL;
echo compare(DateInterval::createFromDateString('2 days'), DateInterval::createFromDateString('47 hours')) . PHP_EOL;

?>

Outputs:
0
0
-1
1

down

julio dot necronomicon at gmail dot com ¶

1 year ago

More simple example i use to add or subtract.

<?php
$Datetime = new Datetime('NOW', new DateTimeZone('America/Bahia'));
$Datetime->add(DateInterval::createFromDateString('2 day'));

echo $Datetime->format("Y-m-d H:i:s");
?>

down

anonymous at nospam dot com ¶

17 days ago

Subtracting months may not work as you might expect. 
Code shows how subtracting 2 months from consecutive days produces potentially unexpected results. 

<?php
$origin = date_create('2025-01-31T00:00:00');
$target = date_create('2024-11-26T00:00:00');

$interval = date_diff($origin, $target);
echo "interval total days: ".$interval->format('%a days');

echo "interval object years: ".$interval->format('%y years');
echo "interval object months: ".$interval->format('%m months');
echo "interval object days: ".$interval->format('%d days');

// create 3 dates that are consecutive, but in two months
$d1 = date_create('2025-01-31T00:00:00');
$d2 = date_create('2025-02-01T00:00:00');
$d3 = date_create('2025-02-02T00:00:00');

// add (negative) interval object to each date
$d1->add($interval);
$d2->add($interval);
$d3->add($interval);

echo "Add (negative) interval object to each date. Non-consecutive results: ";
echo($d1->format("Y-m-d\TH:i:s"));
echo($d2->format("Y-m-d\TH:i:s"));
echo($d3->format("Y-m-d\TH:i:s"));

// reset dates
$d1 = date_create('2025-01-31T00:00:00');
$d2 = date_create('2025-02-01T00:00:00');
$d3 = date_create('2025-02-02T00:00:00');

// Use same dates, but subtract total number of days instead of adding interval object: ";
$d1->sub(new DateInterval('P'.$interval->format('%a').'D'));
$d2->sub(new DateInterval('P'.$interval->format('%a').'D'));
$d3->sub(new DateInterval('P'.$interval->format('%a').'D'));

echo "Use same dates, but subtract total number of days instead of adding interval object. Results (consecutive): ";
echo($d1->format("Y-m-d\TH:i:s"));
echo($d2->format("Y-m-d\TH:i:s"));
echo($d3->format("Y-m-d\TH:i:s"));

$d1 = date_create('2025-01-31T00:00:00');
$d2 = date_create('2025-02-01T00:00:00');
$d3 = date_create('2025-02-02T00:00:00');

// do month separately for 2025-02-01T00:00:00
echo "Do month separately (interesting): ";

echo ('Subtract '. $interval->format('%m').' months (might not expect this):');
echo ('Jan 31 - 2 months (61 days = Dec, 31 days + Nov, 30 days) ==> Dec 1');
echo ('Feb 1  - 2 months (62 days = Dec, 31 days + Jan, 31 days) ==> Dec 1');
$d1->sub(new DateInterval('P'.$interval->format('%m').'M'));
echo $d1->format("Y-m-d\TH:i:s");
$d2->sub(new DateInterval('P'.$interval->format('%m').'M'));
echo $d2->format("Y-m-d\TH:i:s");
$d3->sub(new DateInterval('P'.$interval->format('%m').'M'));
echo $d3->format("Y-m-d\TH:i:s");
?>

Output: 

interval total days: 66 days
interval object years: 0 years
interval object months: 2 months
interval object days: 5 days

create 3 dates that are consecutive, but in two months:
$d1 = 2025-01-31T00:00:00
$d2 = 2025-02-01T00:00:00
$d3 = 2025-02-02T00:00:00

Add (negative) interval object to each date. Non-consecutive results:
2024-11-26T00:00:00
2024-11-26T00:00:00
2024-11-27T00:00:00

Use same dates, but subtract total number of days instead of adding interval object. Results (consecutive):
2024-11-26T00:00:00
2024-11-27T00:00:00
2024-11-28T00:00:00

Do month separately (interesting):

Subtract 2 months (might not expect this):
Jan 31 - 2 months (61 days = Dec, 31 days + Nov, 30 days) ==> Dec 1
Feb 1 - 2 months (62 days = Dec, 31 days + Jan, 31 days) ==> Dec 1
2024-12-01T00:00:00
2024-12-01T00:00:00
2024-12-02T00:00:00

＋add a note

DateInterval クラス

はじめに

クラス概要

プロパティ

変更履歴

目次

Found A Problem?

User Contributed Notes 4 notes