【PHP8.x】getMessageメソッドの使い方

Copy
1<?php
2
3/**
4 * PHP 8 の UnhandledMatchError::getMessage() の使用例を示します。
5 *
6 * match 式がすべての可能なケースをカバーしていない場合に発生する
7 * UnhandledMatchError を捕捉し、そのエラーメッセージを取得する方法を示します。
8 */
9function demonstrateUnhandledMatchErrorHandling(): void
10{
11    $testValue = 3; // match式で定義されていない値
12
13    try {
14        // $testValue がどのケースにも一致しないため、UnhandledMatchError が発生します。
15        $result = match ($testValue) {
16            1 => "値は1です。",
17            2 => "値は2です。",
18            // $testValue が 3 の場合、UnhandledMatchError がここで発生します。
19            // default ケースが定義されていないためです。
20        };
21        echo "処理結果: " . $result . PHP_EOL; // この行は実行されません
22    } catch (UnhandledMatchError $e) {
23        // UnhandledMatchError を捕捉します。
24        // getMessage() メソッドを使用して、エラーの詳細メッセージを取得します。
25        echo "エラーを捕捉しました: " . $e->getMessage() . PHP_EOL;
26    }
27}
28
29// 関数を実行して、UnhandledMatchError の発生と捕捉、メッセージ取得を確認します。
30demonstrateUnhandledMatchErrorHandling();

PHP 8から導入されたmatch式は、複数の条件分岐を簡潔に記述するための機能です。しかし、このmatch式が取り得る全ての値に対する処理（ケース）を定義していない場合、UnhandledMatchErrorというエラーが発生します。これは、どのケースにも一致しない値が与えられた際に、プログラムが予期せぬ動作をするのを防ぐために設計されたエラーです。

提示されたサンプルコードは、このUnhandledMatchErrorが実際にどのように発生し、それを適切に処理する方法を示しています。コードの中では、$testValueに3が設定されていますが、match式には1と2のケースしか定義されていません。そのため、$testValueが3の場合、UnhandledMatchErrorが発生します。

プログラムはtry-catchブロックを使用することで、発生したUnhandledMatchErrorを捕捉し、処理を中断せずに継続できます。捕捉されたエラーオブジェクト$eに対して、getMessage()メソッドを呼び出すことで、エラーの詳細な内容を文字列として取得しています。getMessage()メソッドは引数を一切必要とせず、発生したエラーに関する具体的な説明を文字列（string）型で返します。この機能により、開発者はエラーの原因を特定しやすくなり、ユーザーに対して分かりやすいエラーメッセージを表示することが可能になります。このサンプルコードを実行すると、「エラーを捕捉しました: Match expression does not handle value 3」のようなメッセージが出力されます。

Copy
1<?php
2
3/**
4 * UnhandledMatchError の発生と getMessage() メソッドの使用例を示します。
5 *
6 * PHP 8 の match 式がすべての可能な値をカバーしていない場合に発生する
7 * UnhandledMatchError を意図的に生成し、そのエラーを捕捉して
8 * getMessage() メソッドでエラーメッセージを取得します。
9 */
10function demonstrateUnhandledMatchError(): void
11{
12    // UnhandledMatchError を発生させるための値
13    // この値は、以下の match 式のどのケースにも一致しません。
14    $value = 'grape';
15
16    try {
17        // match 式が $value ('grape') のケースを処理しないため、
18        // UnhandledMatchError がスローされます。
19        $result = match ($value) {
20            'apple'  => 'リンゴです',
21            'banana' => 'バナナです',
22            // 'grape' のケースがないため、ここで UnhandledMatchError が発生します。
23        };
24        // この行は UnhandledMatchError が発生した場合、実行されません。
25        echo "結果: " . $result . "\n";
26    } catch (UnhandledMatchError $e) {
27        // UnhandledMatchError を捕捉します。
28        // getMessage() メソッドは、エラーの詳細な説明を文字列として返します。
29        $errorMessage = $e->getMessage();
30
31        echo "捕捉されたエラーのクラス: " . get_class($e) . "\n";
32        echo "エラーメッセージ: " . $errorMessage . "\n";
33    }
34}
35
36// 関数を実行します。
37demonstrateUnhandledMatchError();
38

このPHPコードは、PHP 8のmatch式が全ての可能な値を網羅的に処理しきれない場合に発生するUnhandledMatchErrorと、そのエラーオブジェクトから詳細なメッセージを取得するgetMessage()メソッドの使用例です。

match式は、指定された値と厳密に一致するケースを評価する制御構造です。サンプルコードでは、$valueが'grape'であるにもかかわらず、match式内に'grape'に対応するケースが存在しないため、UnhandledMatchErrorが発生します。

プログラムがエラーで停止しないよう、try-catchブロックでこのエラーを捕捉しています。catch (UnhandledMatchError $e)により、発生したエラーオブジェクトが$e変数に格納されます。

$e->getMessage()は、捕捉したUnhandledMatchErrorオブジェクトに組み込まれているメソッドです。このメソッドは引数を取らず、エラーの具体的な状況や原因を説明するstring型のメッセージを返します。このコードは、getMessage()で取得されたエラーメッセージを画面に出力することで、開発者がエラーの原因を特定し、デバッグやエラーハンドリングに役立てる方法を示しています。