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

Copy
1<?php
2
3/**
4 * 存在しないメソッドを呼び出した際の例外処理を実演するクラス
5 */
6class MethodCaller
7{
8    /**
9     * 存在しないメソッドを呼び出し、例外メッセージを取得して表示します。
10     */
11    public function run(): void
12    {
13        try {
14            // このオブジェクトに存在しないメソッド 'undefinedMethod' を呼び出す
15            // これにより BadMethodCallException がスローされる
16            $this->__call('undefinedMethod', []);
17        } catch (BadMethodCallException $e) {
18            // catchブロックで BadMethodCallException を捕捉する
19            
20            // getMessage() メソッドを使って、例外オブジェクトからエラーメッセージを取得する
21            $errorMessage = $e->getMessage();
22
23            // 取得したエラーメッセージを出力する
24            // 出力例: "Call to undefined method MethodCaller::undefinedMethod()"
25            echo $errorMessage . PHP_EOL;
26        }
27    }
28}
29
30// クラスのインスタンスを作成して実行
31$caller = new MethodCaller();
32$caller->run();
33
34?>

このPHPコードは、存在しないメソッドを呼び出した際に発生する例外BadMethodCallExceptionから、具体的なエラーメッセージを取得する方法を示しています。

MethodCallerクラスのrunメソッド内では、try-catch構文が使われています。tryブロックの中で、意図的にundefinedMethodという定義されていないメソッドを呼び出しています。これにより、PHPはBadMethodCallExceptionという種類のエラー（例外）を発生させます。

プログラムの処理はcatchブロックに移り、発生した例外をBadMethodCallException型の変数$eとして捕捉します。ここでgetMessage()メソッドが使われます。このメソッドは、例外オブジェクト（この場合は$e）から、なぜ例外が発生したのかを説明するエラーメッセージを取得するためのものです。getMessage()メソッドは引数を必要とせず、戻り値としてエラーメッセージの文字列（string型）を返します。

サンプルコードでは、$e->getMessage()によって取得した「Call to undefined method MethodCaller::undefinedMethod()」のようなエラーメッセージを画面に出力しています。このようにgetMessage()メソッドを利用することで、プログラム実行中に発生したエラーの詳細な原因を把握し、デバッグやログ記録に役立てることができます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 存在しないメソッドを呼び出し、BadMethodCallExceptionを捕捉するデモクラス
7 */
8class ExceptionMessageDemo
9{
10    /**
11     * このメソッドはデモ用にprivateスコープになっています。
12     * @param string $data
13     * @return string
14     */
15    private function processInternalData(string $data): string
16    {
17        return "Processed: " . $data;
18    }
19
20    /**
21     * 例外を発生させ、そのメッセージを取得して表示します。
22     *
23     * BadMethodCallExceptionは、未定義のメソッドやアクセス不能なメソッドを
24     * 呼び出した場合にスローされます。
25     * この例では、長い文字列を連結して、意図的に長いメソッド名を生成し、
26     * ログやコンソールでメッセージが省略(truncated)される状況を再現しやすくしています。
27     */
28    public function run(): void
29    {
30        try {
31            // 非常に長い名前を持つ、存在しないメソッドを意図的に呼び出す
32            $longMethodName = 'this_is_an_intentionally_very_long_method_name_that_does_not_exist_to_demonstrate_a_truncated_message';
33            $this->{$longMethodName}('some data');
34        } catch (BadMethodCallException $e) {
35            // 例外がスローされた場合、それを捕捉する
36            
37            // getMessage() メソッドを使って、例外メッセージを取得する
38            $message = $e->getMessage();
39
40            echo "例外メッセージ:" . PHP_EOL;
41            echo $message . PHP_EOL;
42            
43            // getMessage()で取得した文字列が非常に長い場合、
44            // 表示環境（コンソール、ログファイル、IDEなど）によっては
45            // 末尾が "..." のように省略(truncated)されて表示されることがあります。
46        }
47    }
48}
49
50// クラスのインスタンスを作成して実行
51$demo = new ExceptionMessageDemo();
52$demo->run();

このPHPコードは、存在しない、またはアクセスできないメソッドを呼び出した際に発生するBadMethodCallExceptionという例外を処理する方法を示しています。サンプル内のrunメソッドでは、tryブロックの中で意図的に非常に長い名前を持つ未定義のメソッドを呼び出し、例外を発生させています。

catchブロックでは、発生したBadMethodCallExceptionオブジェクトを$eという変数で捕捉します。そして、$e->getMessage()を呼び出すことで、例外に関する詳細なエラーメッセージを取得しています。getMessageメソッドは引数を取らず、例外が発生した具体的な理由を説明する文字列（string型）を戻り値として返します。このメッセージには、通常「Call to undefined method...」といった情報が含まれます。

このコードの重要な点は、非常に長いメソッド名を使用していることです。getMessageで取得したエラーメッセージが長文になるため、コンソールやログファイルなどの表示環境によっては、メッセージの末尾が「...」のように省略（truncated）されて表示されることがあります。このサンプルは、エラーメッセージが常に全文表示されるとは限らないことを示しており、デバッグの際に注意すべき点を教えてくれます。