【PHP8.x】UnhandledMatchError::lineプロパティの使い方

Copy
1<?php
2
3/**
4 * プログラミング言語: PHP
5 * バージョン: 8
6 *
7 * このコードは、PHP 8 の `match` 式で `UnhandledMatchError` が発生した際に、
8 * そのエラーの発生行番号 (`line`) を取得する方法を示します。
9 */
10function demonstrateUnhandledMatchErrorLine(): void
11{
12    try {
13        echo "値をチェックします...\n";
14
15        // PHP 8 の `match` 式を使用。
16        // `default` ケースがなく、どの条件にも一致しない値を渡すことで
17        // `UnhandledMatchError` を意図的に発生させます。
18        // この `match` 式の開始行がエラーの発生箇所として報告されます。
19        $result = match (3) { // ← この行番号が UnhandledMatchError の「line」として報告されます。
20            1 => 'One',
21            2 => 'Two',
22        };
23
24        echo "結果: " . $result . "\n"; // この行は UnhandledMatchError が発生するため実行されません。
25
26    } catch (UnhandledMatchError $e) {
27        // `UnhandledMatchError` をキャッチした場合の処理です。
28        // エラーが発生した行番号は、`getLine()` メソッドを通じて取得します。
29        // これは PHP のすべての Throwable オブジェクトに共通の標準的な方法です。
30        $errorLine = $e->getLine();
31        $errorMessage = $e->getMessage();
32        $errorFile = $e->getFile();
33
34        echo "--- UnhandledMatchError を検知しました ---\n";
35        echo "メッセージ: " . $errorMessage . "\n";
36        echo "エラーが発生したファイル: " . $errorFile . "\n";
37        echo "エラーが発生した行番号: " . $errorLine . "\n"; // キーワード「line」に対応。
38        // エラーの発生行番号を画面に出力することで、キーワード「送信」の意図を満たします。
39
40    } catch (Throwable $e) {
41        // UnhandledMatchError 以外の予期せぬエラーを包括的に処理する場合の例です。
42        echo "--- 予期せぬエラーを検知しました ---\n";
43        echo "メッセージ: " . $e->getMessage() . "\n";
44        echo "エラーが発生したファイル: " . $e->getFile() . "\n";
45        echo "エラーが発生した行番号: " . $e->getLine() . "\n";
46    } finally {
47        // エラーの有無にかかわらず最終的に実行される処理です。
48        echo "処理を終了します。\n";
49    }
50}
51
52// 関数を実行して、UnhandledMatchError の発生と処理を確認します。
53demonstrateUnhandledMatchErrorLine();

このPHPコードは、PHP 8で導入されたmatch式が意図しない状況でエラーを起こした際の処理方法を示します。match式は、与えられた値がどの条件にも一致せず、かつdefaultケースが定義されていない場合にUnhandledMatchErrorというエラーを発生させます。

サンプルコードでは、match (3)に対して1と2のケースのみ定義し、意図的にUnhandledMatchErrorを発生させています。プログラムはtry-catchブロックによってこのエラーを捕捉し、停止することなく処理を続けます。

エラーが捕捉された際、UnhandledMatchErrorオブジェクトからエラーの発生状況を詳しく取得できます。特に、リファレンスにある「line」はエラーが発生したソースコードの行番号を指し、$e->getLine()メソッドを通じて取得します。このgetLine()メソッドは引数を必要とせず、エラーが発生した正確な行番号を整数値（int）として返します。取得された行番号はecho文によって画面に「送信」表示され、開発者がエラー箇所を迅速に特定し、問題を解決するのに役立ちます。

Copy
1<?php
2
3/**
4 * PHP 8 の UnhandledMatchError::line プロパティの使用例を示します。
5 * UnhandledMatchError は、match 式が網羅的でない場合に発生する例外です。
6 * その line プロパティは、エラーが発生した行番号を返します。
7 *
8 * @param int $value テスト用の整数値
9 */
10function demonstrateUnhandledMatchErrorLine(int $value): void
11{
12    try {
13        // この match 式は、$value が 1 または 2 のケースのみを処理します。
14        // $value が他の値（例: 3）の場合、UnhandledMatchError が発生します。
15        $result = match ($value) {
16            1 => "One is handled.",
17            2 => "Two is handled.",
18            // default ケースがないため、$valueが3の時に UnhandledMatchError が発生する
19        };
20        echo "Result: " . $result . PHP_EOL;
21    } catch (UnhandledMatchError $e) {
22        echo "UnhandledMatchError が捕捉されました！" . PHP_EOL;
23        echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
24        // UnhandledMatchError::line プロパティは、エラーが発生した行番号（int型）を返します。
25        echo "エラー発生行: " . $e->line . PHP_EOL;
26    } catch (Throwable $e) {
27        // その他の予期せぬ例外を捕捉します。
28        echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
29    }
30}
31
32// UnhandledMatchError を意図的に発生させる値 (この行ではなく、match式のある行がエラーとして報告されます)
33demonstrateUnhandledMatchErrorLine(3);
34
35// エラーが発生しないケース (参考)
36// demonstrateUnhandledMatchErrorLine(1);
37?>

PHP 8のUnhandledMatchError::lineプロパティは、match式がすべての可能なケースを網羅していない場合に発生するUnhandledMatchError例外から、エラーが発生した行番号を取得するためのものです。このプロパティは引数を取らず、エラーが発生したソースコードの具体的な行番号を整数値（int型）で返します。

提供されたサンプルコードでは、demonstrateUnhandledMatchErrorLine関数内でmatch式が定義されています。このmatch式は、引数$valueが1または2の場合のみを処理するように記述されており、その他の値に対するdefaultケースが意図的に省略されています。そのため、demonstrateUnhandledMatchErrorLine(3)のように、match式で処理されない値3が渡されると、UnhandledMatchErrorが発生します。

try-catchブロックでこの例外を捕捉した後、$e->lineプロパティにアクセスすることで、エラーが実際に発生したmatch式の行番号を取得し、出力しています。これにより、プログラマーはmatch式のどの箇所で網羅性の問題が発生したのかを正確に把握でき、デバッグやエラーハンドリングを効率的に行うことが可能になります。このプロパティは、match式関連のエラーの原因特定に非常に役立つ情報を提供します。

Copy
1<?php
2
3/**
4 * match式でUnhandledMatchErrorを発生させる可能性がある関数。
5 *
6 * この関数は、PHP 8 の match 式の網羅性チェックを例示するために使用します。
7 * 意図的にすべてのケースをカバーしないことで、UnhandledMatchErrorを発生させます。
8 *
9 * @param mixed $value match式に渡す値
10 * @return string 特定の文字列がマッチした場合の結果
11 */
12function executeMatchStatement(mixed $value): string
13{
14    // このmatch式は、'apple'と'banana'のみをケースとして定義しています。
15    // PHP 8 の match 式は網羅的である必要があるため、
16    // ここで定義されていない値（例: 'orange'）が渡された場合、
17    // UnhandledMatchError が発生します。
18    return match ($value) {
19        'apple' => 'これはリンゴです',
20        'banana' => 'これはバナナです',
21        // 'orange'のような他の値に対するケースが定義されていないため、
22        // UnhandledMatchError が発生する可能性があります。
23    };
24}
25
26// UnhandledMatchError を捕捉し、エラー発生行番号を取得するメイン処理
27try {
28    echo "不正な値を渡して UnhandledMatchError を意図的に発生させます。\n";
29    // ここで 'orange' を渡すことで、executeMatchStatement 関数内で
30    // UnhandledMatchError が発生します。
31    $result = executeMatchStatement('orange');
32    echo "処理結果: " . $result . "\n"; // この行はエラー発生のため実行されません
33} catch (UnhandledMatchError $e) {
34    // UnhandledMatchError を捕捉した場合の処理
35    echo "UnhandledMatchError が捕捉されました！\n";
36    echo "エラーメッセージ: " . $e->getMessage() . "\n";
37
38    // リファレンス情報に基づき、UnhandledMatchError の 'line' プロパティから
39    // エラーが発生した正確な行番号を取得します。
40    echo "エラー発生行番号: " . $e->line . "\n";
41
42    // 注: $e->getLine() メソッドも同様にエラー発生行番号を返しますが、
43    // リファレンス情報に「プロパティ: line」とあるため、ここでは $e->line を直接使用しています。
44    echo "エラー発生ファイル: " . $e->getFile() . "\n";
45} catch (Throwable $e) {
46    // その他の予期せぬエラー（UnhandledMatchError 以外のThrowable）を捕捉
47    echo "予期せぬエラーが捕捉されました！\n";
48    echo "エラータイプ: " . get_class($e) . "\n";
49    echo "エラーメッセージ: " . $e->getMessage() . "\n";
50    echo "エラー発生行番号: " . $e->getLine() . "\n";
51}
52

このサンプルコードは、PHP 8で導入されたmatch式で発生するUnhandledMatchErrorを捕捉し、エラー発生時の詳細情報を取得する方法を示しています。match式は、与えられた値に対してすべての可能性のあるケースを網羅的に記述する必要がありますが、もし網羅されていない値が渡された場合、UnhandledMatchErrorが発生します。

executeMatchStatement関数では、意図的に'apple'と'banana'のケースのみを定義しているため、'orange'のような値が渡されるとmatch式は対応するケースを見つけられず、UnhandledMatchErrorをスローします。

メイン処理では、try-catchブロックでこのエラーを捕捉し、エラーオブジェクト$eから各種情報を取得しています。特に、リファレンス情報にあるUnhandledMatchErrorクラスのlineプロパティを利用すると、エラーが発生したソースコードの正確な行番号を整数（int）として取得できます。このlineプロパティは引数を必要としません。これにより、システム内でエラーが発生した際に、その原因となった具体的なコード行を素早く特定し、開発者間でエラー情報を正確に連携して解決を進める上で重要な役割を果たします。

Copy
1<?php
2
3/**
4 * PHP 8 の match 式を使用して値の処理を試みる関数。
5 * 意図的に全てのケースを網羅せず、UnhandledMatchError の発生を促します。
6 *
7 * @param string $value 処理する文字列
8 * @return string 処理結果の文字列
9 */
10function processValueWithMatch(string $value): string
11{
12    // ここで UnhandledMatchError が発生する可能性があります。
13    // 'apple' と 'banana' 以外の値が渡された場合、
14    // 未処理のケースとなりエラーがスローされます。
15    return match ($value) {
16        'apple' => '処理結果: リンゴです。',
17        'banana' => '処理結果: バナナです。',
18        // 'orange' のような他の値が渡された場合に備えて、
19        // default ケースが意図的に省略されています。
20    };
21}
22
23// UnhandledMatchError を捕捉し、その情報を通知する例
24try {
25    // UnhandledMatchError を発生させるための値を渡します。
26    // この行を呼び出した際に、関数内部の match 式でエラーが発生します。
27    echo processValueWithMatch('orange') . "\n";
28} catch (UnhandledMatchError $e) {
29    // UnhandledMatchError が発生した場合、ここが実行されます。
30    echo "エラー通知:\n";
31    echo "----------------------------------------\n";
32    echo "エラーの種類: " . get_class($e) . "\n";
33    echo "エラーメッセージ: " . $e->getMessage() . "\n";
34
35    // UnhandledMatchError::line プロパティを使用して、
36    // エラーが実際に発生したソースコードの行番号を取得します。
37    // この値は、processValueWithMatch 関数内の match 式の開始行を示します。
38    echo "エラー発生行 (ファイル内): " . $e->line . "\n";
39    echo "この行は、未処理のケースで match 式が実行された箇所を示します。\n";
40    echo "----------------------------------------\n";
41} catch (Throwable $e) {
42    // その他の予期せぬエラーを捕捉する場合
43    echo "予期せぬ重大なエラーが発生しました: " . $e->getMessage() . "\n";
44}
45

PHP 8で導入されたmatch式は、複数の条件分岐を簡潔に記述するための構文です。しかし、match式に渡された値がどのケースにも一致せず、かつdefaultケースが定義されていない場合に、UnhandledMatchErrorというエラーが発生します。

UnhandledMatchErrorクラスが持つlineプロパティは、このエラーが実際に発生したソースコード上の行番号を整数値（int）で提供します。このプロパティに引数は不要です。これにより、エラーが具体的にコードのどの箇所で起きたのかを正確に特定できます。

サンプルコードでは、processValueWithMatch関数内のmatch式が、'apple'と'banana'のみを処理するように定義されており、意図的にdefaultケースが省略されています。'orange'のように未定義の値をこの関数に渡すと、UnhandledMatchErrorが発生します。try-catchブロックでこのエラーを捕捉した際、$e->lineと記述することで、エラーが発生したmatch式の開始行の番号を取得できます。この情報は、エラーの原因究明や修正において非常に役立つ通知となり、システムエンジニアを目指す方々にとってデバッグの効率化に繋がります。