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

Copy
1<?php
2
3/**
4 * UnhandledMatchError::getFile() メソッドのサンプルコード。
5 *
6 * この関数は、PHP 8 で導入された match 式において、
7 * 網羅されていないケースが発生した場合にスローされる UnhandledMatchError を意図的に発生させ、
8 * そのエラーオブジェクトから getFile() メソッドを使って
9 * エラーが発生したスクリプトのファイルパスを取得する方法を示します。
10 *
11 * @param string $input 評価する値。'apple' または 'banana' 以外の値でエラーが発生します。
12 * @return string エラー発生時のファイルパス、または match 式の正常な結果を示す文字列。
13 */
14function demonstrateUnhandledMatchErrorGetFile(string $input): string
15{
16    try {
17        // match 式は厳密で、全ての可能な値に対してケースが定義されている必要があります。
18        // ここでは 'grape' という値が入力された場合、どのケースにも一致しないため
19        // UnhandledMatchError がスローされるように意図的に記述されています。
20        $result = match ($input) {
21            'apple' => '選択されたのはリンゴです。',
22            'banana' => '選択されたのはバナナです。',
23            // 'grape' など、上記のどれにも当てはまらない値が来た場合に
24            // UnhandledMatchError が発生するように、他のケースを意図的に省略しています。
25        };
26
27        return "match 式は正常に処理されました: " . $result;
28
29    } catch (UnhandledMatchError $e) {
30        // UnhandledMatchError を捕捉した場合
31        // Throwable インターフェースを実装するクラス（UnhandledMatchError も含む）は
32        // getFile() メソッドを持ち、エラーが発生したソースファイルのパスを返します。
33        $filePath = $e->getFile();
34        $message = $e->getMessage();
35
36        return "UnhandledMatchError が発生しました。\n"
37             . "エラーメッセージ: " . $message . "\n"
38             . "エラーが発生したファイルパス: " . $filePath;
39
40    } catch (Throwable $e) {
41        // その他の予期しないエラーを捕捉する一般的なケース
42        return "予期せぬエラーが発生しました: " . $e->getMessage();
43    }
44}
45
46// --- サンプル実行 ---
47
48// 1. match 式が正常に処理されるケース
49echo "--- 正常な入力の場合 ---\n";
50echo demonstrateUnhandledMatchErrorGetFile('apple') . "\n\n";
51
52// 2. UnhandledMatchError が発生するケース
53// 'grape' は match 式のどのケースにも対応していないため、UnhandledMatchError がスローされます。
54echo "--- UnhandledMatchError が発生する入力の場合 ---\n";
55echo demonstrateUnhandledMatchErrorGetFile('grape') . "\n";
56
57?>

PHP 8で導入されたmatch式は、複数の条件に対する厳密な分岐処理を行うための機能です。switch文と異なり、match式では全ての可能な値に対してケースを定義する必要があります。もし、入力値が定義されているどのケースにも一致しない場合、PHPはUnhandledMatchErrorをスローし、プログラムの実行を中断します。

UnhandledMatchErrorクラスのgetFile()メソッドは、このUnhandledMatchErrorが発生した際に、具体的にどのファイルでエラーが起きたのかを特定するためのファイルパス（文字列）を返します。このメソッドは引数を必要としません。

サンプルコードでは、demonstrateUnhandledMatchErrorGetFile関数内でmatch式を使用し、意図的に'grape'のような未定義の値を入力することでUnhandledMatchErrorを発生させています。try-catchブロックでこのエラーを捕捉し、捕捉したエラーオブジェクト$eに対して$e->getFile()を呼び出すことで、エラーが発生したスクリプトのファイルパスを取得し表示しています。'apple'のような定義済みの値が入力された場合はエラーは発生せず、match式が正常に処理される様子も示されています。これにより、エラー発生時のファイルパス取得の仕組みが明確に理解できます。