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

getFileメソッドは、例外が発生したソースコードのファイル名をフルパスで取得するために実行するメソッドです。このメソッドは、OutOfRangeExceptionクラスが継承している基底のExceptionクラスで定義されています。PHPにおける全ての例外クラスはExceptionクラスを継承する階層構造を持っているため、OutOfRangeExceptionのインスタンスからもこのgetFileメソッドを呼び出すことが可能です。プログラム実行中に、配列の範囲外のインデックスにアクセスしようとするなどの理由でOutOfRangeExceptionがスローされた際、このメソッドを使用すると、問題がどのファイルで発生したのかを正確に特定できます。これは特に、開発時のデバッグや、システム運用時のエラーログを記録する場面で非常に有用です。例えば、try-catch構文で例外を捕捉し、その例外オブジェクトに対してgetFileメソッドを呼び出すことでファイルパスを取得し、getLineメソッドが返す行番号やgetMessageメソッドが返すエラーメッセージと組み合わせてログに出力することで、エラーの原因調査を迅速に進めることができます。このメソッドは、例外がスローされたファイルのフルパスを文字列として返します。

Copy
1<?php
2
3try {
4    // 固定サイズの配列で範囲外のインデックスにアクセスし、
5    // OutOfRangeExceptionを発生させます。
6    $array = new SplFixedArray(2);
7    $value = $array[5]; 
8
9} catch (OutOfRangeException $e) {
10    // 捕捉した例外インスタンスから、
11    // 例外が発生したファイル名を取得して出力します。
12    echo $e->getFile();
13}

引数なし

引数はありません

string

OutOfRangeException クラスの getFile メソッドは、例外が発生したファイル名を文字列で返します。