DateInterval 类

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

简介

表示时间间隔。

时间间隔表示固定量的时间(多少年,月,天,小时等),也可以表示一个字符串格式的相对时间,当表示相对时间的时候,字符串格式是 DateTimeImmutableDateTime 类的构造函数所支持的格式。

更具体的说,DateInterval 类的对象中的信息是从一个日期/时间到另一个日期/时间的指令。这个过程并不始终可逆。

创建 DateInterval 对象的常用方法是通过 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 __construct(string $duration)
public static createFromDateString(string $datetime): DateInterval|false
public format(string $format): string
}

属性

警告

下列列出的有效属性依赖 PHP 版本,应视为 readonly

y

多少年。

m

多少月。

d

多少天。

h

多少小时。

i

多少分钟。

s

多少秒。

f

多少微秒。

invert

如果是负的时间段,则为 1,否则为 0。请参见 DateInterval::format()

days

如果 DateInterval 对象是由 DateTimeImmutable::diff() 或者 DateTime::diff() 函数创建的,那么它表示开始日期和结束日期之间的完整天数。否则,days 属性为 false

from_string

如果 DateInterval 对象是通过 DateInterval::createFromDateString() 创建,则此属性值设为 true 并且 date_string 属性将填充数据。否则,此值设为 false 且为从 yfinvertdays 属性填充数据。

date_string

字符串,用作 DateInterval::createFromDateString() 的参数。

更新日志

版本 说明
8.2.0 为使用 DateInterval::createFromDateString() 方法创建的 DateInterval 实例添加了 from_stringdate_string 属性。
8.2.0 仅从 yfinvertdays 将可见。
7.4.0 现在 DateInterval 无法比较;之前所有的 DateInterval 实例都认为相等。
7.1.0 增加 f 属性。

目录

add a note

User Contributed Notes 4 notes

up
40
cb
1 year ago
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
up
5
julio dot necronomicon at gmail dot com
8 months 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");
?>
up
0
edgaras at levinson dot lt
2 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
up
-5
nateb at gurutechnologies dot net
4 years ago
Many people have commented on doing a reverse interval on a date time. I personally find a backwards year to be a little strange to think about and instead opt to work with just intervals. This is the easiest I have found.

<?php
$one_year
= new DateInterval('P1Y');
$one_year_ago = new DateTime();
$one_year_ago->sub($one_year);
?>

Instead of:

<?php
$one_year_ago
= new DateInterval( "P1Y" );
$one_year_ago->invert = 1;
$one_year_ago = new DateTime();
$one_year_ago->add($one_year);
?>
To Top