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

Copy
1<?php
2
3/**
4 * BadFunctionCallExceptionからエラーメッセージを取得するサンプル関数
5 */
6function demonstrateGetMessage(): void
7{
8    try {
9        // この例外は、コールバック関数が不正な場合などにスローされます。
10        // ここでは、getMessage()の動作を説明するために意図的に例外をスローします。
11        throw new BadFunctionCallException('不正な関数呼び出しが行われました。');
12    } catch (BadFunctionCallException $e) {
13        // catchブロックでBadFunctionCallExceptionを捕捉します。
14        // 変数 $e には、スローされた例外オブジェクトが格納されます。
15
16        // $e->getMessage() を使用して、例外オブジェクトに格納されている
17        // エラーメッセージ（文字列）を取得し、表示します。
18        echo 'キャッチした例外メッセージ: ' . $e->getMessage() . PHP_EOL;
19    } finally {
20        // このブロックは例外の有無にかかわらず、必ず実行されます。
21        echo '処理が終了しました。' . PHP_EOL;
22    }
23}
24
25// 関数を実行します
26demonstrateGetMessage();
27
28?>

このPHPコードは、BadFunctionCallExceptionクラスのgetMessage()メソッドの動作を示すサンプルです。getMessage()メソッドは、例外オブジェクトが保持しているエラーメッセージを取得するために使用されます。このメソッドは引数を必要とせず、戻り値としてエラーメッセージの文字列（string型）を返します。

サンプルコードのtryブロックでは、throwキーワードを使って意図的にBadFunctionCallExceptionを発生させています。このとき、コンストラクタの引数に渡された '不正な関数呼び出しが行われました。' という文字列が、この例外のエラーメッセージとして設定されます。

続くcatchブロックで、発生したBadFunctionCallExceptionを捕捉し、そのオブジェクトを変数$eに代入します。そして、$e->getMessage()を呼び出すことで、先ほど設定されたエラーメッセージの文字列を取得し、画面に出力しています。このようにgetMessage()を使うことで、プログラムの実行時に発生したエラーの具体的な内容を知ることができます。

Copy
1<?php
2
3/**
4 * BadFunctionCallExceptionから取得した長いメッセージが
5 * ログ出力などで切り捨てられる状況をシミュレートする関数です。
6 */
7function demonstrateTruncatedMessage(): void
8{
9    // ログや表示領域の制限を超える可能性のある、非常に長いエラーメッセージを定義します。
10    $longErrorMessage = "致命的なエラー: コールバック関数 'process_data' の呼び出しに失敗しました。"
11        . "この関数は、必須の第2引数として 'Configuration' オブジェクトを期待していますが、"
12        . "実際には NULL が渡されました。データ処理パイプラインのステップ 'validation' で"
13        . "この問題が発生しました。設定ファイル 'pipeline.json' を確認し、"
14        . "正しいオブジェクトが渡されていることを確認してください。";
15
16    try {
17        // 意図的にBadFunctionCallExceptionをスローします。
18        // 実際には、存在しない関数をcall_user_func()で呼び出した際などに発生します。
19        throw new BadFunctionCallException($longErrorMessage);
20
21    } catch (BadFunctionCallException $e) {
22        // 例外をキャッチし、getMessage()メソッドで例外メッセージを取得します。
23        $fullMessage = $e->getMessage();
24
25        echo "--- getMessage()で取得した完全なメッセージ ---" . PHP_EOL;
26        echo $fullMessage . PHP_EOL;
27        echo "文字数: " . mb_strlen($fullMessage) . PHP_EOL . PHP_EOL;
28
29
30        // キーワード「truncated」の状況を再現します。
31        // 例えば、ログファイルの1行あたりの最大文字数が150文字だと仮定します。
32        $logLimit = 150;
33        $truncatedMessage = mb_substr($fullMessage, 0, $logLimit);
34
35        echo "--- ログ出力用に切り捨てられたメッセージ (truncated) ---" . PHP_EOL;
36        echo $truncatedMessage . "..." . PHP_EOL;
37        echo "文字数: " . mb_strlen($truncatedMessage) . " (+ '...' の分)" . PHP_EOL;
38    }
39}
40
41// 関数を実行して結果を表示します。
42demonstrateTruncatedMessage();

BadFunctionCallExceptionクラスのgetMessage()メソッドは、例外が発生した際の詳細なエラーメッセージを文字列として取得するために使用します。このメソッドは引数を必要とせず、戻り値として、例外が生成されたときに設定されたエラーメッセージの文字列（string型）を返します。

サンプルコードでは、まずtryブロック内で意図的に長いエラーメッセージを持つBadFunctionCallExceptionを発生させています。次にcatchブロックでその例外オブジェクトを$eという変数で捕捉し、$e->getMessage()を呼び出すことで、設定された完全なエラーメッセージを取得して表示しています。

このコードは、キーワードである「truncated（切り捨てられた）」という状況も示しています。getMessage()で取得したメッセージ自体は完全なものですが、ログファイルへの出力や画面表示の際に、システムの制約によってメッセージが途中で切れてしまうことがあります。コードの後半では、mb_substr()関数を使い、取得した長いメッセージが150文字に切り捨てられる様子をシミュレートしています。このように、getMessage()は常に完全なメッセージを返しますが、その利用方法によっては情報が欠落する可能性があることを示しています。