【PHP8.x】date_diff()関数の使い方

Copy
1<?php
2
3// 日付の差を計算する例です。
4// DateTimeオブジェクトを作成します。
5$datetime1 = new DateTime('2023-01-01'); // 最初のDateTimeオブジェクト
6$datetime2 = new DateTime('2024-03-15'); // 2番目のDateTimeオブジェクト
7
8// date_diff() 関数を使用して、2つの日付の差を計算します。
9// この関数はDateIntervalオブジェクトを返します。
10// 第3引数 $absolute はデフォルトで false ですが、true に設定すると常に正の差を返します。
11$interval = date_diff($datetime1, $datetime2);
12
13// 計算結果であるDateIntervalオブジェクトから日付の差を表示します。
14// format() メソッドは、指定された書式で期間を表現するのに便利です。
15// %y: 年, %m: 月, %d: 日
16echo "日付1: " . $datetime1->format('Y-m-d') . "\n";
17echo "日付2: " . $datetime2->format('Y-m-d') . "\n";
18echo "日付の差: " . $interval->format('%y 年 %m ヶ月 %d 日') . "\n";
19
20// 別の例: 日付の順序が逆の場合
21$datetimeA = new DateTime('2024-03-15');
22$datetimeB = new DateTime('2023-01-01');
23
24// $absolute を true に設定して、常に正の差を取得します。
25$intervalAbsolute = date_diff($datetimeA, $datetimeB, true);
26
27echo "\n--- $absolute パラメータが true の場合 ---\n";
28echo "日付A: " . $datetimeA->format('Y-m-d') . "\n";
29echo "日付B: " . $datetimeB->format('Y-m-d') . "\n";
30echo "日付の差 (絶対値): " . $intervalAbsolute->format('%y 年 %m ヶ月 %d 日') . "\n";
31
32?>

date_diff()関数は、2つの日付の差を精密に計算するためのPHP関数です。この関数は、比較したい2つの日付を表すDateTimeオブジェクトを引数として受け取ります。最初の2つの引数に、new DateTime('2023-01-01')のようにして作成したオブジェクトを渡します。第3引数である$absoluteにtrueを指定すると、日付の前後関係にかかわらず、常に正の値（絶対値）として差が計算されます。指定しない場合のデフォルトはfalseです。

この関数の戻り値は、計算結果を保持するDateIntervalオブジェクトです。このオブジェクトには、年、月、日、時、分、秒といった単位で2つの日付の差が格納されています。

結果を表示するには、DateIntervalオブジェクトが持つformat()メソッドが便利です。$interval->format('%y 年 %m ヶ月 %d 日')のように書式を指定することで、「1年 2ヶ月 14日」といった人間が読みやすい形式の文字列として差を取り出すことができます。

Copy
1<?php
2
3/**
4 * 現在の日付から指定された日付までの日数差を計算します。
5 *
6 * この関数は、現在の日付を基準として、与えられた日付文字列が現在より何日未来または過去であるかを計算します。
7 * 結果は整数で返され、未来の日付であれば正の値、過去の日付であれば負の値となります。
8 *
9 * @param string $targetDateString 比較対象の日付文字列 (例: '2024-12-31', 'tomorrow', 'last week')
10 * @return int 日数差。指定された日付が現在より未来なら正、過去なら負の値。
11 *             日付文字列の解析に失敗した場合は0を返します。
12 */
13function calculateDaysDifferenceFromNow(string $targetDateString): int
14{
15    try {
16        // 現在の日付と時刻のDateTimeオブジェクトを作成します。
17        // これは比較の基準点となります。
18        $now = new DateTime();
19        
20        // 比較対象の日付文字列からDateTimeオブジェクトを作成します。
21        // 無効な日付文字列の場合、DateTimeExceptionをスローする可能性があります。
22        $targetDate = new DateTime($targetDateString);
23
24        // 2つのDateTimeオブジェクト間の差を計算し、DateIntervalオブジェクトを取得します。
25        // DateIntervalオブジェクトは、年、月、日、時間などの差を保持します。
26        $interval = date_diff($now, $targetDate);
27
28        // DateIntervalオブジェクトから総日数を取得します。
29        // '%r' は、差が負の場合にマイナス記号を付加します (例: -10)。
30        // '%a' は、期間の総日数を絶対値で取得します。
31        // これにより、未来の日付には正、過去の日付には負の日数が得られます。
32        return (int) $interval->format('%r%a');
33
34    } catch (Exception $e) {
35        // DateTimeオブジェクトの作成や日付解析に失敗した場合のエラーハンドリングです。
36        // 初心者にも分かりやすいように、エラーログを出力し、デフォルト値として0を返します。
37        error_log("日付解析エラー: " . $e->getMessage());
38        return 0;
39    }
40}
41
42// --- サンプル使用例 ---
43
44// 今日の日付から、未来の特定の日付までの日数を計算し、結果を表示します。
45$futureDateString = '2024-12-31';
46$daysToFuture = calculateDaysDifferenceFromNow($futureDateString);
47echo "日付 '{$futureDateString}' までの残り日数: " . $daysToFuture . "日\n";
48
49// 今日の日付から、過去の特定の日付までの日数を計算し、結果を表示します。
50$pastDateString = '2023-01-01';
51$daysFromPast = calculateDaysDifferenceFromNow($pastDateString);
52echo "日付 '{$pastDateString}' からの経過日数: " . $daysFromPast . "日\n";
53
54// 今日の日付と現在の日付の差を計算します（通常は0になるはずです）。
55$todayString = 'now';
56$daysToday = calculateDaysDifferenceFromNow($todayString);
57echo "今日 ('{$todayString}') との日数差: " . $daysToday . "日\n";
58
59// 無効な日付文字列を与えた場合の動作を確認します（エラーハンドリングの例）。
60$invalidDateString = 'not a valid date string';
61$daysFromInvalid = calculateDaysDifferenceFromNow($invalidDateString);
62echo "日付 '{$invalidDateString}' との日数差 (エラー時): " . $daysFromInvalid . "日\n";

このサンプルコードは、PHP 8 を用いて、現在の日付から指定された日付までの日数差を計算する方法を示しています。calculateDaysDifferenceFromNow関数は、比較対象となる日付を表す文字列を引数として受け取り、現在の日付からの日数差を整数で返します。戻り値が正の数の場合は未来の日付、負の数の場合は過去の日付を示し、その絶対値が日数を表します。

関数の内部では、まずnew DateTime()を使って現在の日付と時刻を表すオブジェクトを作成し、これを比較の基準とします。次に、引数として渡された日付文字列から、同様にDateTimeオブジェクトを作成します。PHPの組み込み関数であるdate_diffは、この二つのDateTimeオブジェクト（より正確にはDateTimeInterface）を引数にとり、その間の期間をDateIntervalオブジェクトとして計算します。DateIntervalオブジェクトは、年、月、日などの差を保持しています。

このDateIntervalオブジェクトのformat('%r%a')メソッドを利用することで、総日数と、未来か過去かを示す符号（正または負）を合わせた整数値として取得できます。これにより、「20日後」なら20、「10日前」なら-10といった具体的な日数差が得られます。もし引数に解析できない無効な日付文字列が渡された場合は、DateTimeオブジェクトの作成時に例外が発生する可能性がありますが、このコードではエラーを捕捉し、エラーログを出力しつつデフォルト値として0を返すことで、プログラムの堅牢性を高めています。サンプル使用例では、様々な日付文字列を渡し、計算結果が正しく表示されることを確認できます。

Copy
1<?php
2
3/**
4 * Calculates the total difference in minutes between two DateTimeInterface objects.
5 *
6 * This function uses date_diff to get a DateInterval object, then extracts
7 * the total days, hours, and minutes from it to compute the total duration in minutes.
8 * The difference is always returned as a positive integer (absolute difference).
9 *
10 * @param DateTimeInterface $datetime1 The first date/time object.
11 * @param DateTimeInterface $datetime2 The second date/time object.
12 * @return int The absolute total difference in minutes.
13 */
14function calculateDateDifferenceInMinutes(DateTimeInterface $datetime1, DateTimeInterface $datetime2): int
15{
16    // date_diff関数を使用して2つの日付時刻オブジェクト間の差を計算します。
17    // 第3引数にtrueを渡すことで、常に正の期間（絶対差）が返されます。
18    $interval = date_diff($datetime1, $datetime2, true);
19
20    $totalMinutes = 0;
21
22    // DateIntervalオブジェクトの'days'プロパティは、2つの日付間の合計日数を提供します。
23    // これは、正確な合計分数計算のために不可欠です。
24    if ($interval->days !== false) {
25        $totalMinutes += $interval->days * 24 * 60; // 合計日数を分に変換して加算
26    }
27
28    $totalMinutes += $interval->h * 60; // 時間コンポーネントを分に変換して加算
29    $totalMinutes += $interval->i;      // 分コンポーネントを直接加算
30
31    return $totalMinutes;
32}
33
34// --- 単体で動作可能なサンプルコードの例 ---
35// CLI環境で実行された場合のみ、以下のコードが実行されます。
36if (php_sapi_name() === 'cli') {
37    // 例1: 異なる日付と時間の差を計算
38    $date1 = new DateTime('2023-10-26 10:00:00');
39    $date2 = new DateTime('2023-10-27 11:30:00'); // date1から1日1時間30分後
40
41    $minutesDifference1 = calculateDateDifferenceInMinutes($date1, $date2);
42    echo "差: {$date1->format('Y-m-d H:i:s')} と {$date2->format('Y-m-d H:i:s')} は {$minutesDifference1} 分です。\n"; // 出力: 1530分
43
44    // 例2: 同じ日付内で時間が逆順の差を計算
45    $date3 = new DateTime('2023-10-28 09:15:00');
46    $date4 = new DateTime('2023-10-28 08:00:00'); // date3から1時間15分前
47
48    $minutesDifference2 = calculateDateDifferenceInMinutes($date3, $date4);
49    echo "差: {$date3->format('Y-m-d H:i:s')} と {$date4->format('Y-m-d H:i:s')} は {$minutesDifference2} 分です。\n"; // 出力: 75分
50
51    // 例3: ちょうど1年の差を計算 (うるう年ではない期間を想定)
52    $date5 = new DateTime('2023-01-01 00:00:00');
53    $date6 = new DateTime('2024-01-01 00:00:00'); // date5からちょうど1年後 (365日)
54
55    $minutesDifference3 = calculateDateDifferenceInMinutes($date5, $date6);
56    echo "差: {$date5->format('Y-m-d H:i:s')} と {$date6->format('Y-m-d H:i:s')} は {$minutesDifference3} 分です。\n"; // 出力: 525600分 (365日 * 24時間 * 60分)
57}

このPHPのサンプルコードは、二つの日時（DateTimeInterfaceオブジェクト）の間の時間を合計何分であるかを計算する方法を解説しています。中心となるのはdate_diff関数で、この関数は二つの日時オブジェクト（$datetime1と$datetime2）を受け取り、それらの差をDateIntervalオブジェクトとして返します。引数$absoluteにtrueを指定することで、日時の前後関係に関わらず、常に差を正の期間として取得できます。戻り値であるDateIntervalオブジェクトには、差の日数（days）、時間（h）、分（i）などの情報が格納されています。サンプルコードでは、このDateIntervalオブジェクトから、合計の日数を分に、時間を分にそれぞれ変換し、さらに残りの分を加えて、最終的な合計分数を算出しています。これにより、何日も離れた日時であっても、時間や分のずれを含めて、正確な合計時間を分単位で把握することができます。コードの最後には、具体的な日時オブジェクトを作成し、計算結果を表示する例が示されており、関数の動作をわかりやすく理解できます。

Copy
1<?php
2
3/**
4 * 2つの日付間の年数の差を計算し、表示するサンプルコードです。
5 *
6 * PHPのdate_diff関数は、DateTimeInterfaceオブジェクト間の差を
7 * DateIntervalオブジェクトとして返します。
8 * DateIntervalオブジェクトには、年、月、日などの差分情報が格納されています。
9 */
10
11// 1. 比較する2つのDateTimeオブジェクトを作成します。
12//    DateTimeオブジェクトは特定の日時を表します。
13$datetime1 = new DateTime('2000-01-01'); // 最初の年月日
14$datetime2 = new DateTime('2023-05-15'); // 比較対象の年月日
15
16// 2. date_diff関数を使用して、これら2つの日付の差を計算します。
17//    結果はDateIntervalオブジェクトとして返されます。
18//    第3引数 $absolute はデフォルトで false なので、日付の前後関係を考慮した差を返します。
19//    年数の差を取得するだけなので、このまま使用します。
20$interval = date_diff($datetime1, $datetime2);
21
22// 3. DateIntervalオブジェクトから年数の差（'y'プロパティ）を取得し、表示します。
23//    'y'プロパティは、年の差分を表します。
24echo "日付1: " . $datetime1->format('Y-m-d') . PHP_EOL;
25echo "日付2: " . $datetime2->format('Y-m-d') . PHP_EOL;
26echo "年数の差: " . $interval->y . " 年" . PHP_EOL;
27
28// 参考: 日付の差が逆の場合も確認
29$datetime3 = new DateTime('2023-05-15');
30$datetime4 = new DateTime('2000-01-01');
31$intervalReversed = date_diff($datetime3, $datetime4);
32echo "年数の差 (逆順): " . $intervalReversed->y . " 年" . PHP_EOL; // 結果は同じ年数
33

PHPのdate_diff関数は、2つの日付オブジェクト間の差分を計算するために使用されます。この関数はPHP 8で利用可能で、日付の期間を正確に把握する際に非常に便利です。

date_diff関数は、比較したい2つのDateTimeInterface型のオブジェクトを引数として受け取ります。具体的には、$datetime1と$datetime2という引数で、それぞれ特定の日付と時刻を表すオブジェクトを指定します。オプションの第3引数$absoluteは、差分を常に正の値として扱うかどうかを制御する論理値で、デフォルトはfalseです。

この関数は、計算結果としてDateInterval型のオブジェクトを返します。DateIntervalオブジェクトには、年、月、日、時間、分、秒など、日付間の具体的な差分情報がプロパティとして格納されています。

サンプルコードでは、まず'2000-01-01'と'2023-05-15'という2つのDateTimeオブジェクトを作成しています。これらをdate_diff関数に渡すことで、2つの日付間の差が計算され、結果は$intervalというDateIntervalオブジェクトに代入されます。その後、$intervalオブジェクトのyプロパティにアクセスすることで、日付間の年数の差（この場合は23年）を取得し、画面に表示しています。これにより、特定の日付から特定の日付までの年数がいくつあるかを簡単に知ることができます。