[函数]DateTimeInterface::diff()函数—用法及示例

PHP函数: DateTimeInterface::diff()

函数描述: DateTimeInterface::diff() 函数用于计算两个日期之间的差异，并返回一个 DateInterval 对象。

用法: 该函数需要一个 DateTimeInterface 对象作为参数，并返回一个 DateInterval 对象。

语法: DateTimeInterface::diff(DateTimeInterface $datetime2, bool $absolute = false): DateInterval

参数:

• $datetime2: 一个 DateTimeInterface 对象，表示与当前日期进行比较的日期。
• $absolute: 可选参数，用于确定返回的 DateInterval 对象是否包含负号。如果设为 true，返回的对象将总是正数。

返回值: 返回一个 DateInterval 对象，表示两个日期之间的差异。

示例:

$datetime1 = new DateTime('2022-01-01 00:00:00');
$datetime2 = new DateTime('2022-01-02 12:00:00');

$interval = $datetime1->diff($datetime2);

echo $interval->format('%R%a days %H hours'); // 输出: +1 days 12 hours

在上面的示例中，我们创建了两个 DateTime 对象，并计算了它们之间的日期差异。然后，我们使用 format() 方法来以指定的格式输出差异。其中 %R 表示正号或负号，%a 表示天数，%H 表示小时数。

注意:

• DateTime::diff() 方法是在 PHP 5.3.0 版本中引入的，因此需要 PHP 5.3.0 或更高版本才能使用该函数。
• DateTimeInterface 接口是在 PHP 5.5.0 版本中引入的，因此需要 PHP 5.5.0 或更高版本才能使用该接口。
• 如果将 $absolute 参数设为 true，则返回的 DateInterval 对象的值总是为正数。如果设为 false 或不传递该参数，默认情况下计算的差异将反映在 DateInterval 对象中的正负号上。