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

Copy
1<?php
2
3/**
4 * 年齢を検証し、無効な場合はDomainExceptionをスローします。
5 *
6 * @param int $age 検証する年齢
7 * @return void
8 * @throws DomainException 年齢が18歳未満の場合
9 */
10function validateAge(int $age): void
11{
12    // ドメインルール: 年齢は18歳以上でなければならない
13    if ($age < 18) {
14        // 条件を満たさない場合にDomainExceptionをスローする
15        throw new DomainException("年齢は18歳以上である必要があります。");
16    }
17
18    echo "年齢は有効です: {$age}" . PHP_EOL;
19}
20
21try {
22    // 例外が発生する可能性のあるコードをtryブロックで囲む
23    // わざと無効な年齢を渡して例外を発生させる
24    validateAge(15);
25} catch (DomainException $e) {
26    // DomainExceptionがスローされた場合にcatchブロックで捕捉する
27    echo "エラーが発生しました。" . PHP_EOL;
28
29    // DomainException::getFile() を使用して、例外がスローされたファイル名を取得・表示する
30    // このメソッドは、どのファイルで問題が起きたかを特定するのに役立つ
31    echo "ファイル: " . $e->getFile() . PHP_EOL;
32
33    // 参考: 例外が発生した行番号とメッセージも取得できる
34    echo "行番号: " . $e->getLine() . PHP_EOL;
35    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
36}

DomainException::getFile()は、例外（プログラムの実行中に発生するエラー）がどのファイルで発生したかを知るためのメソッドです。このメソッドは引数を必要とせず、戻り値として例外がスロー（発生）されたファイルのフルパスを文字列（string型）で返します。

サンプルコードでは、まずvalidateAgeという関数を定義しています。この関数は、年齢が18歳未満の場合に、プログラムのルールに合わない値が渡されたことを示すDomainExceptionという種類の例外をスローします。

tryブロックの中で、わざと15という無効な年齢を渡してこの関数を呼び出し、例外を発生させています。発生した例外はcatchブロックで捕捉されます。そして、捕捉した例外オブジェクト$eに対して$e->getFile()を実行することで、例外がスローされたファイル名を取得し、画面に出力しています。

このように、getFile()メソッドは、getLine()（行番号）やgetMessage()（エラーメッセージ）といった他のメソッドと組み合わせて使うことで、エラー発生箇所の特定を容易にし、デバッグ作業を効率化するために役立ちます。

Copy
1<?php
2
3/**
4 * ユーザーの年齢を検証し、無効な場合に DomainException をスローする関数
5 *
6 * @param int $age 検証する年齢
7 * @return void
8 * @throws DomainException 年齢が 0 未満または 120 を超える場合
9 */
10function validateUserAge(int $age): void
11{
12    // 年齢が有効なドメイン（範囲）にない場合は例外をスローする
13    if ($age < 0 || $age > 120) {
14        throw new DomainException("年齢の値が不正です。0から120の間でなければなりません。");
15    }
16}
17
18try {
19    // 無効な年齢 (-1) を渡して関数を呼び出し、意図的に例外を発生させる
20    validateUserAge(-1);
21} catch (DomainException $e) {
22    // DomainException をキャッチし、例外情報を表示する
23    echo "エラーが発生しました。" . PHP_EOL;
24    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
25
26    // getFile() メソッドを使用して、例外がスローされたファイル名を取得して表示する
27    echo "ファイル: " . $e->getFile() . PHP_EOL;
28
29    echo "行番号: " . $e->getLine() . PHP_EOL;
30}
31

PHPのDomainException::getFile()メソッドは、例外がスローされた（発生した）ファイルの名前を、フルパスの文字列として取得するためのものです。このメソッドは引数を必要とせず、戻り値としてファイル名の文字列を返します。

サンプルコードでは、まずvalidateUserAgeという、年齢を検証する関数を定義しています。この関数は、引数の年齢が0未満または120を超えるという不正な値であった場合に、DomainExceptionという種類の例外を発生させます。

次にtry...catchブロックで、この関数に意図的に不正な値である-1を渡して実行しています。これによりDomainExceptionがスローされ、続くcatchブロックでその例外オブジェクトが捕捉されます。

catchブロックの中では、捕捉した例外オブジェクト（変数$e）に対して$e->getFile()を呼び出しています。これにより、例外がスローされたファイル（このサンプルコードが保存されているファイル自身）の絶対パスが取得され、画面に表示されます。このようにgetFile()は、getMessage()（エラーメッセージ）やgetLine()（行番号）と合わせて使用することで、エラー発生箇所を特定するデバッグ作業で非常に役立ちます。