【PHP8.x】ErrorException::getSeverity()メソッドの使い方

Copy
1<?php
2
3/**
4 * PHPのエラーをErrorExceptionに変換するカスタムエラーハンドラ。
5 *
6 * PHPが通常発行する警告や注意（E_WARNING, E_NOTICEなど）を、
7 * 例外として捕捉できるようにするために使用します。
8 * error_reporting() の設定によって抑制されているエラーは処理しません。
9 *
10 * @param int    $severity エラーの深刻度（E_WARNING, E_NOTICE など）
11 * @param string $message  エラーメッセージ
12 * @param string $file     エラーが発生したファイル名
13 * @param int    $line     エラーが発生した行番号
14 * @throws ErrorException 発生したPHPエラーをErrorExceptionとしてスローする
15 */
16function customErrorHandler(int $severity, string $message, string $file, int $line): void
17{
18    // 現在の error_reporting 設定で、この $severity のエラーが報告対象外であれば何もしない
19    if (!(error_reporting() & $severity)) {
20        return;
21    }
22
23    // 捕捉可能なPHPエラーをErrorExceptionに変換してスロー
24    // これにより、try-catchブロックでPHPエラーを捕捉できるようになります
25    throw new ErrorException($message, 0, $severity, $file, $line);
26}
27
28/**
29 * ErrorException::getSeverity メソッドの動作と、セキュリティへの関連性を示す関数。
30 *
31 * システムエンジニアを目指す初心者が理解しやすいように、具体的なエラーシナリオを通して説明します。
32 */
33function demonstrateErrorSeverityHandling(): void
34{
35    // 既存のエラーハンドラを保存し、カスタムエラーハンドラを設定します。
36    // これにより、以降のPHPエラーはcustomErrorHandler()で処理され、ErrorExceptionに変換されます。
37    $oldErrorHandler = set_error_handler('customErrorHandler');
38
39    echo "--- ErrorException::getSeverity メソッドのデモンストレーション ---\n";
40
41    // シナリオ1: 未定義変数へのアクセス（E_NOTICE を発生）
42    try {
43        echo "\nシナリオ1: 未定義変数へのアクセス（E_NOTICE を発生させます）\n";
44        // 未定義変数にアクセスしようとすると、PHPはE_NOTICEを発行します。
45        // customErrorHandler() がこれを捕捉し、ErrorExceptionとしてスローします。
46        $undefinedVariable;
47        echo "  " . $undefinedVariable; // この行でE_NOTICEが発生し、例外がスローされます
48    } catch (ErrorException $e) {
49        // ErrorException を捕捉し、getSeverity() メソッドを呼び出します
50        $severity = $e->getSeverity();
51        echo "  ErrorException を捕捉しました！\n";
52        echo "  メッセージ: " . $e->getMessage() . "\n";
53        echo "  深刻度 (int): " . $severity . "\n";
54        echo "  深刻度 (PHP定数): ";
55        // 取得した深刻度（int）をPHPのエラー定数と比較して、人間が理解しやすい形で表示します。
56        switch ($severity) {
57            case E_ERROR:
58                echo "E_ERROR (致命的な実行時エラー)"; break;
59            case E_WARNING:
60                echo "E_WARNING (実行時警告)"; break;
61            case E_NOTICE:
62                echo "E_NOTICE (実行時注意)"; break;
63            case E_USER_ERROR:
64                echo "E_USER_ERROR (ユーザー定義の致命的なエラー)"; break;
65            case E_USER_WARNING:
66                echo "E_USER_WARNING (ユーザー定義の警告)"; break;
67            case E_USER_NOTICE:
68                echo "E_USER_NOTICE (ユーザー定義の注意)"; break;
69            default:
70                echo "UNKNOWN_SEVERITY (" . $severity . ")"; break;
71        }
72        echo "\n";
73        // 【セキュリティに関するコメント】
74        // E_NOTICE のようなエラーが本番環境でユーザーに直接表示されると、
75        // アプリケーションの内部構造（変数名、ファイルパスなど）が露呈し、
76        // 攻撃者にとって脆弱性を探る手がかりとなる可能性があります。
77        // getSeverity() を利用してエラーの深刻度を判断し、本番環境では
78        // ユーザーには詳細なエラーメッセージを表示せず、一般的なエラーメッセージに
79        // 留める、またはエラーログにのみ記録するといった対策が有効です。
80        // これにより、情報漏洩のリスクを低減し、システムのセキュリティを向上させることができます。
81    }
82
83    // シナリオ2: ユーザー定義の警告の発生（E_USER_WARNING を発生）
84    try {
85        echo "\nシナリオ2: ユーザー定義の警告の発生（E_USER_WARNING を発生させます）\n";
86        // trigger_error 関数を使って意図的にユーザー定義の警告を発生させます。
87        // これは、特定の条件が満たされた場合に開発者に警告を促す用途などに使われます。
88        trigger_error("想定外のデータ型が検出されました。", E_USER_WARNING);
89    } catch (ErrorException $e) {
90        $severity = $e->getSeverity();
91        echo "  ErrorException を捕捉しました！\n";
92        echo "  メッセージ: " . $e->getMessage() . "\n";
93        echo "  深刻度 (int): " . $severity . "\n";
94        echo "  深刻度 (PHP定数): ";
95        switch ($severity) {
96            case E_ERROR: echo "E_ERROR"; break;
97            case E_WARNING: echo "E_WARNING"; break;
98            case E_NOTICE: echo "E_NOTICE"; break;
99            case E_USER_ERROR: echo "E_USER_ERROR"; break;
100            case E_USER_WARNING: echo "E_USER_WARNING"; break;
101            case E_USER_NOTICE: echo "E_USER_NOTICE"; break;
102            default: echo "UNKNOWN_SEVERITY (" . $severity . ")"; break;
103        }
104        echo "\n";
105        // 【セキュリティに関するコメント】
106        // E_USER_WARNING のような警告も、アプリケーションのビジネスロジックや
107        // 内部処理に関する情報を含んでいる場合があります。
108        // getSeverity() でこれらの警告を識別し、本番環境では適切なロギングのみを行い、
109        // ユーザーにはセキュリティ上無害な情報のみを表示することで、
110        // 攻撃者がシステムに関する情報を収集するのを防ぎます。
111        // エラーの種類と深刻度を正確に把握することは、適切なセキュリティ対策を講じる上で不可欠です。
112    }
113
114    // デモンストレーション終了後、元のエラーハンドラに戻します。
115    // これにより、この関数が他のコードに影響を与えることを防ぎます。
116    if ($oldErrorHandler) {
117        set_error_handler($oldErrorHandler);
118    } else {
119        restore_error_handler();
120    }
121
122    echo "\n--- デモンストレーション終了 ---\n";
123}
124
125// 関数を実行してデモンストレーションを開始します。
126demonstrateErrorSeverityHandling();

ErrorException::getSeverityは、PHPが内部で発生させるエラーを例外として扱えるようにするErrorExceptionクラスのメソッドです。このメソッドは引数を受け取らず、発生したエラーの「深刻度」を示す整数値を返します。戻り値の整数値は、E_ERRORやE_WARNING、E_NOTICEといったPHPのエラー定数に対応しており、エラーの種類をプログラムで正確に特定する際に利用されます。

サンプルコードでは、PHPの未定義変数アクセスによるE_NOTICEや、trigger_error()で発生させたE_USER_WARNINGといったエラーを、カスタムエラーハンドラでErrorExceptionに変換し捕捉しています。捕捉されたErrorExceptionからgetSeverity()を呼び出すことで、そのエラーがどの程度の深刻度を持つものだったかを数値で取得できます。

この深刻度の把握は、システムのセキュリティを考える上で非常に重要です。例えば、E_NOTICEのようなエラーでも、本番環境でユーザーに詳細なメッセージが表示されると、アプリケーションの内部情報（ファイルパスや変数名など）が攻撃者に露呈し、脆弱性を探る手がかりとなる可能性があります。getSeverity()でエラーの深刻度を判断し、開発環境では詳細な情報を、本番環境ではユーザーには一般的なエラーメッセージのみを表示し、詳細な情報はログに記録するといった適切な対策を講じることで、情報漏洩のリスクを低減し、セキュリティを向上させることができます。エラーの性質に応じた適切な処理は、堅牢なシステム構築に不可欠です。

Copy
1<?php
2
3/**
4 * PHPのエラーをErrorExceptionに変換するカスタムエラーハンドラを設定します。
5 * これにより、通常のPHPエラーもtry-catchブロックで捕捉できるようになります。
6 */
7set_error_handler(function (int $errno, string $errstr, string $errfile, int $errline): bool {
8    // エラー抑制演算子 (@) が使用されている場合は、カスタムハンドラをスキップします。
9    if (!(error_reporting() & $errno)) {
10        return false;
11    }
12    // PHPのエラーをErrorExceptionとしてスローします。
13    throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
14});
15
16/**
17 * セッション操作中に発生するエラーの重大度を取得するサンプル関数です。
18 * システムエンジニアを目指す初心者向けに、ErrorException::getSeverity() の使い方を示します。
19 *
20 * この関数では、意図的にセッション関連のエラーを発生させ、
21 * それをErrorExceptionとして捕捉し、重大度を出力します。
22 */
23function handleSessionErrorSeverityExample(): void
24{
25    echo "ErrorException::getSeverity() のデモンストレーション:\n";
26    echo "--------------------------------------------------\n";
27
28    try {
29        // 通常、session_start() はスクリプト実行中に一度だけ呼び出されます。
30        // ここでは、エラーハンドラをテストするために意図的に二度呼び出し、
31        // E_WARNING (PHP 8の場合) を発生させます。
32        // この警告は、上で設定したエラーハンドラによって ErrorException に変換されます。
33
34        // 最初の session_start() は成功します。
35        if (session_status() === PHP_SESSION_NONE) {
36            session_start();
37            echo "セッションを開始しました (1回目).\n";
38        }
39
40        // 2回目の session_start() は既にセッションが開始されているため、
41        // 警告 (E_WARNING) を発生させます。
42        // この警告が ErrorException に変換され、catchブロックで捕捉されます。
43        session_start();
44        echo "セッションを開始しました (2回目).\n"; // この行には通常到達しません
45    } catch (ErrorException $e) {
46        // ErrorException が捕捉された場合、その詳細を出力します。
47        echo "\n==== ErrorException が捕捉されました ====\n";
48        echo "  エラーメッセージ: " . $e->getMessage() . "\n";
49        echo "  発生ファイル: " . $e->getFile() . " (行: " . $e->getLine() . ")\n";
50
51        // ErrorException::getSeverity() メソッドを使って、エラーの重大度を整数値で取得します。
52        $severity = $e->getSeverity();
53        echo "  エラー重大度 (整数値): " . $severity . "\n";
54
55        // 取得した整数値とPHPのエラー定数を照合し、より分かりやすい形式で表示します。
56        echo "  重大度タイプ: ";
57        switch ($severity) {
58            case E_ERROR:
59                echo "E_ERROR (致命的な実行時エラー)\n";
60                break;
61            case E_WARNING:
62                echo "E_WARNING (実行時警告)\n";
63                break;
64            case E_NOTICE:
65                echo "E_NOTICE (実行時注意)\n";
66                break;
67            case E_USER_ERROR:
68                echo "E_USER_ERROR (ユーザー定義の致命的なエラー)\n";
69                break;
70            case E_USER_WARNING:
71                echo "E_USER_WARNING (ユーザー定義の警告)\n";
72                break;
73            case E_USER_NOTICE:
74                echo "E_USER_NOTICE (ユーザー定義の注意)\n";
75                break;
76            case E_RECOVERABLE_ERROR:
77                echo "E_RECOVERABLE_ERROR (キャッチ可能な致命的なエラー)\n";
78                break;
79            case E_DEPRECATED:
80                echo "E_DEPRECATED (非推奨機能の警告)\n";
81                break;
82            case E_USER_DEPRECATED:
83                echo "E_USER_DEPRECATED (ユーザー定義の非推奨機能の警告)\n";
84                break;
85            default:
86                echo "不明な重大度タイプ (値: " . $severity . ")\n";
87                break;
88        }
89    } finally {
90        // セッションがアクティブな場合は、クリーンアップのためにセッションを終了します。
91        if (session_status() === PHP_SESSION_ACTIVE) {
92            session_destroy();
93            echo "\nセッションを終了しました。\n";
94        }
95        // カスタムエラーハンドラを解除し、デフォルトのPHPエラー処理に戻します。
96        restore_error_handler();
97        echo "\n--------------------------------------------------\n";
98        echo "デモンストレーションが完了しました。\n";
99    }
100}
101
102// サンプル関数を実行します。
103handleSessionErrorSeverityExample();
104
105?>

このPHPコードは、ErrorExceptionクラスに属するgetSeverity()メソッドの利用方法を、システムエンジニアを目指す初心者向けに解説しています。getSeverity()メソッドは引数を取らず、捕捉されたエラーの重大度を整数値で返します。この戻り値は、E_WARNINGやE_NOTICEのようなPHPの定義済みエラー定数と比較することで、エラーの種類を識別できます。

サンプルでは、まずset_error_handler()関数を用いて、PHPの通常の警告や通知もtry-catchブロックで扱えるErrorExceptionとしてスローするようにカスタムエラーハンドラを設定しています。これにより、実行時のエラーをより柔軟に捕捉し処理することが可能になります。

handleSessionErrorSeverityExample()関数内では、意図的にsession_start()を二度呼び出すことで、セッションが既に開始されていることによる警告（E_WARNING）を発生させています。この警告は、設定したカスタムエラーハンドラによってErrorExceptionに変換され、catch (ErrorException $e)ブロックで捕捉されます。

捕捉されたErrorExceptionオブジェクトから$e->getSeverity()を呼び出すことで、元となったPHPエラーの重大度を示す整数値を取得し、それをswitch文で具体的なエラータイプ名に変換して表示しています。この仕組みは、セッション操作中に発生した問題など、プログラムのエラー発生時にその深刻度を正確に把握し、適切な対応をとるために役立ちます。