函式名稱:DateInterval::format()
適用版本:PHP 5 >= 5.3.0, PHP 7
函式概述:用於格式化日期間隔物件中的時間間隔。
用法:
DateInterval::format() 函式可以在 DateInterval 物件上呼叫來獲取格式化的時間間隔字串。
以下是函式的基本語法: string DateInterval::format ( string $format )
引數說明:
- format:指定時間間隔的格式字串。
返回值:返回格式化後的時間間隔字串,或者在失敗時返回 false。
示例:
$interval = new DateInterval('P2Y3M4DT6H8M');
echo $interval->format("%y years, %m months, %d days, %h hours, %i minutes");
上述示例中,我們建立了一個包含 2 年,3 個月,4 天,6 小時和 8 分鐘的 DateInterval 物件。然後使用 format() 函式將這個時間間隔格式化為字串,並傳入了一個格式字串:"%y years, %m months, %d days, %h hours, %i minutes"。最後輸出的結果將是:"2 years, 3 months, 4 days, 6 hours, 8 minutes"。
注意事項:
- format() 函式的引數是一個格式字串,其中特定的格式序列將被替換為對應的時間間隔部分。常用的格式序列包括:
- %y:代表年份部分(兩位數表示)。
- %Y:代表年份部分(四位數表示)。
- %m:代表月份部分。
- %d:代表天數部分。
- %h:代表小時部分。
- %i:代表分鐘部分。
- %s:代表秒數部分。
- 格式字串可以包含任意字元,比如逗號、空格或文字。
- 如果格式字串無效或無法解析,format() 函式將返回 false。
- 在 PHP 5.3.6 和更早的版本中,使用帶有 %e 格式序列的格式字串可能會導致異常退出。
- 在 PHP 7.3 和更早的版本中,使用帶有 %v 格式序列可以獲取不超過 3 位的秒數,直接獲取時分秒之間的差異。