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

fileプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

『fileプロパティは、JsonExceptionがスローされたPHPスクリプトのファイル名を、フルパス形式の文字列で保持するプロパティです。このプロパティは、PHPの基本的な例外クラスであるExceptionクラスから継承されたものであり、JsonExceptionに限りません。json_decode()json_encode()といったJSON関連の関数で処理エラーが発生すると、PHPエンジンはJsonExceptionのインスタンスを生成します。その際、エラーが発生したファイルの名前が自動的にこのfileプロパティに格納されます。開発者は、try-catch構文で捕捉した例外オブジェクトを通じてこのプロパティの値にアクセスすることで、どのファイルでJSONエラーが起きたかを正確に特定できます。通常、この値を取得するにはgetFile()メソッドを使用します。この情報は、特にエラーログを出力する際やデバッグを行う場面で非常に重要です。エラーの発生源を迅速に突き止めるための不可欠な情報であり、アプリケーションの保守性や信頼性の向上に貢献します。』

構文(syntax)

1<?php
2
3$invalidJson = '{"key": "value",}'; // 不正なJSON(末尾にカンマ)
4
5try {
6    json_decode($invalidJson, flags: JSON_THROW_ON_ERROR);
7} catch (JsonException $e) {
8    // 例外がスローされたファイル名を取得します。
9    // このプロパティは Exception クラスから継承されています。
10    echo $e->getFile();
11}

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

JsonException クラスの file プロパティは、JSON のデコード中にエラーが発生したファイルの名前を文字列で返します。

関連コンテンツ