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

『fileプロパティは、例外が発生したソースファイルのフルパスを文字列として保持するプロパティです。このプロパティはLengthExceptionクラスが、その親クラスであるExceptionクラスから継承したものです。そのため、LengthExceptionだけでなく、PHPにおけるほとんどの例外オブジェクトで共通して利用することができます。fileプロパティの値は、プログラム中でthrowキーワードを用いて例外がスローされた際に、PHPエンジンによって自動的に設定されます。これにより、どのファイルでエラーが生じたかを正確に知ることが可能になります。この情報は、主にデバッグの過程で非常に役立ちます。例えば、try-catchブロックで例外を捕捉した際に、エラーログに発生ファイル名を記録することで、問題の原因調査を効率的に進めることができます。なお、このプロパティはprotectedスコープで宣言されているため、オブジェクトの外部から直接アクセスすることはできません。値を取得したい場合は、公開されているgetFile()メソッドを呼び出す必要があります。

Copy
1<?php
2
3try {
4    // LengthExceptionを意図的にスローします。
5    throw new LengthException("長さに関するエラーが発生しました。");
6} catch (LengthException $e) {
7    // 例外オブジェクトのgetFile()メソッドを通じて、
8    // protectedな$fileプロパティの値（例外がスローされたファイル名）を取得します。
9    echo $e->getFile();
10}
11
12?>

引数なし

引数はありません

string

LengthException クラスの file プロパティは、例外が発生したファイルの名前を文字列として返します。