【PHP8.x】fileプロパティの使い方

fileプロパティは、例外が発生したソースコードのファイル名を保持するプロパティです。このプロパティは、PHPの基本的な例外クラスであるExceptionクラスで定義されており、UnexpectedValueExceptionはこれを継承しているため利用できます。具体的には、例外オブジェクトが生成された時点でのファイルへのフルパスが文字列として格納されます。

プログラムの実行中に予期しない値が原因でUnexpectedValueExceptionが発生した場合、どのファイルのどの部分のコードが問題を引き起こしたのかを特定する必要があります。このfileプロパティが持つファイル名の情報は、エラーの原因調査、つまりデバッグ作業において極めて重要です。エラーログに出力したり、デバッガで値を確認したりすることで、開発者は迅速に問題箇所を突き止めることができます。

なお、このプロパティはprotectedとして宣言されているため、オブジェクトの外部から直接アクセスすることはできません。値を取得する際には、公開されているgetFile()メソッドを使用するのが一般的です。これにより、プログラムの安全性を保ちながら、必要な情報にアクセスすることが可能になります。

Copy
1<?php
2
3try {
4    // このファイル内で意図的に例外をスローします。
5    throw new UnexpectedValueException("予期しない値が検出されました。");
6} catch (UnexpectedValueException $e) {
7    // 例外オブジェクトから、エラーが発生したファイル名を取得して出力します。
8    // $file プロパティには getFile() メソッドでアクセスします。
9    echo $e->getFile();
10}

引数なし

引数はありません

string

UnexpectedValueExceptionクラスのfileプロパティは、例外が発生した際に、関連するファイル名を表す文字列を返します。