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

fileプロパティは、例外がスローされたソースコードのファイル名を保持するプロパティです。このプロパティは、UnderflowExceptionクラスに属しています。UnderflowExceptionは、例えば空の配列から要素を削除しようとするなど、空のデータ構造に対して無効な操作が行われた場合に発生する実行時エラーを表す例外です。fileプロパティには、この例外がどのPHPファイルで発生したかを示すフルパスが文字列として格納されます。この情報は、エラーの原因箇所を特定するデバッグ作業において非常に重要です。このプロパティは、PHPのすべての例外の基本となるExceptionクラスから継承されたものであり、直接アクセスすることはできません。値を取得するには、Exceptionクラスが提供するgetFile()メソッドを使用します。try...catch構文で例外を捕捉した際に、その例外オブジェクトのgetFile()メソッドを呼び出すことで、エラーが発生したファイル名を取得できます。

Copy
1<?php
2
3$stack = new SplStack();
4
5try {
6    $stack->pop();
7} catch (UnderflowException $e) {
8    echo $e->file;
9}

引数なし

引数はありません

string

この file プロパティは、例外が発生したファイル名を表す文字列を返します。