【PHP8.x】date_interval_create_from_date_string関数の使い方

Copy
1<?php
2
3/**
4 * date_interval_create_from_date_string 関数の使用例を示します。
5 * この関数は、日付/時刻を表す文字列から DateInterval オブジェクトを生成します。
6 *
7 * DateInterval オブジェクトは、期間や時間の間隔（例: 1日、2時間30分など）を表すために使用されます。
8 *
9 * @param string $datetimeString strtotime() 関数が解釈できる形式の相対的な日付/時刻文字列
10 *                                (例: "+1 day", "next monday", "2 hours 30 minutes")
11 * @return void
12 */
13function demonstrateDateIntervalCreation(string $datetimeString): void
14{
15    echo "--- 入力文字列: '{$datetimeString}' ---\n";
16
17    // date_interval_create_from_date_string は DateInterval::createFromDateString() のエイリアスです。
18    // この関数は、指定された文字列を解析し、期間を表す DateInterval オブジェクトを返します。
19    // 文字列が不正な場合は false を返します。
20    $interval = date_interval_create_from_date_string($datetimeString);
21
22    if ($interval === false) {
23        // DateInterval オブジェクトの作成に失敗した場合
24        echo "エラー: '{$datetimeString}' から DateInterval を作成できませんでした。不正な文字列の可能性があります。\n";
25    } else {
26        // DateInterval オブジェクトが正常に作成された場合
27        echo "DateInterval オブジェクトが正常に作成されました。\n";
28
29        // DateInterval オブジェクトのプロパティを表示して、解析された間隔の詳細を確認します。
30        // y:年, m:月, d:日, h:時間, i:分, s:秒
31        echo "  解析された間隔:\n";
32        echo "    年: {$interval->y}\n";
33        echo "    月: {$interval->m}\n";
34        echo "    日: {$interval->d}\n";
35        echo "    時間: {$interval->h}\n";
36        echo "    分: {$interval->i}\n";
37        echo "    秒: {$interval->s}\n";
38
39        // DateInterval オブブジェクトを実際の DateTime オブジェクトと組み合わせて使用する例:
40        // 現在の時刻にこの間隔を加算してみます。
41        $now = new DateTime();
42        // 現在の時刻を変更しないよう、クローンを作成します。
43        $futureDate = clone $now;
44        $futureDate->add($interval); // クローンした DateTime オブジェクトに DateInterval を加算します。
45
46        echo "  現在の時刻: " . $now->format('Y-m-d H:i:s') . "\n";
47        echo "  間隔('{$datetimeString}')適用後の時刻: " . $futureDate->format('Y-m-d H:i:s') . "\n";
48    }
49    echo "\n";
50}
51
52// さまざまな有効な日付文字列で関数を実行して、動作を確認します。
53demonstrateDateIntervalCreation('+1 day');            // 1日後の間隔
54demonstrateDateIntervalCreation('next monday');       // 次の月曜日までの間隔
55demonstrateDateIntervalCreation('2 hours and 30 minutes'); // 2時間30分の間隔
56demonstrateDateIntervalCreation('-1 week');           // 1週間前の間隔
57
58// 無効な文字列を渡した場合の動作を確認します。
59demonstrateDateIntervalCreation('this is not a date string');
60?>

PHPのdate_interval_create_from_date_string関数は、日付や時刻の「期間」を表すDateIntervalオブジェクトを作成するために使用されます。この関数は、システムエンジニアが特定の時間の間隔（例えば「3日後」や「2時間30分」など）をプログラムで扱う際に役立ちます。

引数には、"+1 day"や"2 hours 30 minutes"のように、PHPのstrtotime()関数で解釈できる形式の相対的な日付/時刻を表す文字列を指定します。この文字列を解析し、期間を数値として表現します。

処理が成功すると、指定された文字列から解析された期間を持つDateIntervalオブジェクトが返されます。このオブジェクトは、年、月、日、時間、分、秒といった期間の詳細な情報をプロパティ（例: $interval->dで日数を取得）として保持しています。文字列が不正で期間を解析できなかった場合は、falseが返されるため、関数の呼び出し後は必ず戻り値を確認することが重要です。

作成されたDateIntervalオブジェクトは、DateTimeオブジェクトと組み合わせて使用することが一般的です。例えば、DateTimeオブジェクトのadd()メソッドにDateIntervalオブジェクトを渡すことで、現在の日付時刻に特定の期間を加算し、未来の時刻を計算することができます。このようにして、日付や時刻の複雑な計算を直感的かつ正確に行うことが可能です。