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

Copy
1<?php
2
3/**
4 * date_get_last_errors 関数を用いた日付エラー検出の例
5 *
6 * 不正な日付文字列を date_create などの日付/時刻関数に渡した場合に発生するエラーを検出し、
7 * その詳細情報を date_get_last_errors で取得する方法を示します。
8 * システムエンジニアを目指す初心者向けに、簡潔に記述されています。
9 *
10 * @param string $dateString 解析を試みる日付文字列
11 */
12function demonstrateDateErrorHandling(string $dateString): void
13{
14    echo "--- 日付文字列 '{$dateString}' の解析を試みます ---\n";
15
16    // date_create は、日付文字列の解析に失敗した場合に false を返します
17    $date = date_create($dateString);
18
19    if ($date === false) {
20        echo "  -> date_create() が日付の解析に失敗しました。\n";
21        
22        // date_get_last_errors() を呼び出して、最後の日付/時刻エラー情報を取得します。
23        // この関数は、エラー情報を含む配列か、エラーがない場合は false を返します。
24        $errors = date_get_last_errors();
25
26        // 戻り値が false でないこと、およびエラー情報が含まれていることを確認します
27        if ($errors !== false && (isset($errors['errors']) && !empty($errors['errors']))) {
28            echo "  検出されたエラー:\n";
29            foreach ($errors['errors'] as $code => $message) {
30                echo "    - コード: {$code}, メッセージ: '{$message}'\n";
31            }
32        } elseif ($errors !== false && (isset($errors['warnings']) && !empty($errors['warnings']))) {
33            echo "  検出された警告:\n";
34            foreach ($errors['warnings'] as $code => $message) {
35                echo "    - コード: {$code}, メッセージ: '{$message}'\n";
36            }
37        } else {
38            echo "  -> date_get_last_errors() から特定のエラー情報が得られませんでした。\n";
39        }
40    } else {
41        echo "  -> date_create() は成功しました。解析された日付: " . $date->format('Y-m-d') . "\n";
42        
43        // 成功した場合でも、以前のエラー情報が残っていないことを確認する
44        $errors = date_get_last_errors();
45        if ($errors !== false && (isset($errors['errors']) && !empty($errors['errors']))) {
46             echo "  注意: date_create() は成功しましたが、以前のエラー情報が残っていました。\n";
47             foreach ($errors['errors'] as $code => $message) {
48                 echo "    - コード: {$code}, メッセージ: '{$message}'\n";
49             }
50        }
51    }
52    echo "\n";
53}
54
55// 1. 存在しない日付（2月30日）をテスト
56demonstrateDateErrorHandling('2023-02-30');
57
58// 2. 無効な形式の文字列をテスト
59demonstrateDateErrorHandling('not a valid date string');
60
61// 3. 正しい日付文字列をテスト
62demonstrateDateErrorHandling('2023-03-15');
63
64?>

PHPのdate_get_last_errors関数は、日付や時刻を操作する関数（例えばdate_createなど）が実行された後に発生したエラーや警告の詳細情報を取得するために使用されます。この関数は引数を持ちません。戻り値は、エラー情報を含む連想配列か、エラーが全く発生していない場合はfalseとなります。

サンプルコードでは、まず無効な日付文字列をdate_create関数に渡し、日付オブジェクトの生成が失敗した場合にdate_get_last_errorsを呼び出しています。date_createがfalseを返した場合、それは日付文字列の解析に失敗したことを意味します。この時、date_get_last_errorsを実行すると、失敗の原因となったエラーや警告の具体的な内容（エラーコードとメッセージ）を連想配列形式で取得できます。

戻り値の配列には、errorsキーとwarningsキーが含まれることがあり、それぞれに複数のエラーや警告が格納されます。コードでは、これらのキーが存在し、内容が空でない場合に詳細情報を表示しています。このように、date_get_last_errorsを利用することで、ユーザー入力や外部データに起因する日付関連の問題をプログラムで効果的に検出し、適切なエラーハンドリングを行うことでシステムの堅牢性を高めることができます。

Copy
1<?php
2
3/**
4 * 日付/時刻操作を行い、その結果発生したエラーや警告を表示します。
5 *
6 * date_get_last_errors() は、直前のdate/time関数呼び出しで発生した
7 * パースエラーや警告に関する情報を提供します。これは、日付文字列の解析が
8 * 期待通りに行われなかった場合などに、その詳細を把握するのに役立ちます。
9 *
10 * @param string $dateString 処理する日付文字列。
11 * @return void
12 */
13function showDateOperationStatus(string $dateString): void
14{
15    echo "--- 日付文字列: '{$dateString}' の処理 ---\n";
16
17    // date_create() を使ってDateTimeオブジェクトを作成しようと試みます。
18    // 不正な日付文字列の場合、false を返すか、または警告を発生させます。
19    $dateTime = date_create($dateString);
20
21    // date_get_last_errors() を呼び出し、直前のdate/time関数操作で発生した
22    // エラーや警告の情報を取得します。
23    // PHP 8.0-8.1 では配列、PHP 8.2以降ではstdClassオブジェクトを返しますが、
24    // ここではリファレンス情報 (array|false) に従い配列として処理します。
25    $errors = date_get_last_errors();
26
27    // date_get_last_errors() が false を返すのは非常に稀なケースですが、
28    // リファレンスの戻り値型 (array|false) に従いチェックします。
29    if ($errors === false) {
30        echo "日付/時刻操作のエラー情報を取得できませんでした。\n";
31        if ($dateTime === false) {
32            echo "  (DateTimeオブジェクトの作成にも失敗しています。)\n";
33        }
34    } elseif ($errors['warning_count'] > 0 || $errors['error_count'] > 0) {
35        // エラー情報が存在し、かつ警告またはエラーが実際に発生しているかを確認します。
36        echo "日付/時刻操作中にエラーまたは警告が発生しました:\n";
37
38        if (!empty($errors['warnings'])) {
39            echo "  警告 ({$errors['warning_count']}):\n";
40            foreach ($errors['warnings'] as $warning) {
41                echo "    - " . $warning . "\n";
42            }
43        }
44
45        if (!empty($errors['errors'])) {
46            echo "  エラー ({$errors['error_count']}):\n";
47            foreach ($errors['errors'] as $error) {
48                echo "    - " . $error . "\n";
49            }
50        }
51        // DateTimeオブジェクトが false の場合、日付のパースに完全に失敗しています。
52        if ($dateTime === false) {
53            echo "  注意: DateTimeオブジェクトの作成に失敗しました。\n";
54        }
55    } else {
56        // エラーも警告も発生しなかった場合、操作は成功したと判断できます。
57        echo "日付/時刻操作はエラーなく成功しました。\n";
58        if ($dateTime !== false) {
59            echo "  結果: " . $dateTime->format('Y-m-d H:i:s') . "\n";
60        }
61    }
62    echo "\n";
63}
64
65// --- サンプルコードの実行 ---
66
67// 1. 意図的にエラーを発生させる例 (不正な月 'XX')
68//    'XX' は有効な月ではないため、パースエラーが発生します。
69showDateOperationStatus('2023-XX-01');
70
71// 2. 別のエラーを発生させる例 (存在しない日 '30' for February)
72//    2月30日は存在しないため、パースエラーが発生します。
73showDateOperationStatus('2023-02-30');
74
75// 3. 警告のみが発生する例 (非推奨の日付区切り文字 '/')
76//    '/' は日付区切り文字として推奨されませんが、date_create() は通常これを処理し、
77//    警告として報告する場合があります (PHPのバージョンや設定によります)。
78showDateOperationStatus('2023/10/26');
79
80// 4. エラーも警告も発生しない正常な例
81//    完全に有効な日付文字列であり、問題なく処理されます。
82showDateOperationStatus('2023-10-26 10:30:00');

PHPのdate_get_last_errors関数は、直前に実行された日付や時刻に関連する関数（例えばdate_create()など）の処理結果として、発生したエラーや警告の詳細情報を取得するために利用されます。この関数は引数を一切取らず、戻り値として、エラーや警告の情報を含む連想配列を返します。非常に稀なケースですが、情報が取得できない場合はfalseを返すこともあります。返される配列には、発生した警告の数やエラーの数、そして具体的な警告やエラーメッセージのリストなどが含まれており、日付文字列の解析が期待通りに行われなかった際に、その原因を特定するのに役立ちます。

サンプルコードでは、showDateOperationStatus関数の中で、不正な日付文字列や、存在しない日付、あるいは非推奨の形式で日付を処理する例を通じて、date_get_last_errors()がどのようにエラーや警告を報告するかを示しています。例えば、'2023-XX-01'のような無効な月を含む文字列の場合、date_get_last_errors()はエラーの発生を報告し、具体的なエラーメッセージを提供します。また、'2023/10/26'のように推奨されない区切り文字が使われた場合は、警告として報告されることがあります。一方で、'2023-10-26 10:30:00'のような完全に有効な日付文字列であれば、エラーも警告も報告されず、日付処理が正常に完了したことが確認できます。この関数は、プログラムが日付や時刻のデータを正しく扱えているかを検証し、問題発生時のデバッグを効率化するための重要なツールとなります。