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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたファイルパスが存在するかどうかを確認します。
7 *
8 * この関数は、PHPの組み込み関数 `file_exists()` を使用して、
9 * ファイルやディレクトリの存在をチェックする基本的な方法を示します。
10 *
11 * @return void
12 */
13function checkFileAndDirectoryExistence(): void
14{
15    // 確認対象のファイル名とディレクトリ名
16    $fileName = 'my_test_file.txt';
17    $directoryName = 'my_test_dir';
18
19    // --- ファイルの存在確認 ---
20
21    // 1. 存在しないことを確認
22    echo "ステップ1: ファイル '{$fileName}' の存在を確認します。" . PHP_EOL;
23    if (file_exists($fileName)) {
24        echo "結果: ファイルは既に存在します。" . PHP_EOL;
25    } else {
26        echo "結果: ファイルは存在しません。" . PHP_EOL;
27    }
28    echo PHP_EOL;
29
30    // 2. ファイルを作成して、存在することを確認
31    echo "ステップ2: ファイル '{$fileName}' を作成します。" . PHP_EOL;
32    // touch() は、ファイルの最終アクセス時刻と最終更新時刻を変更する関数ですが、
33    // ファイルが存在しない場合は空のファイルを作成します。
34    touch($fileName);
35
36    echo "ステップ3: 再度ファイル '{$fileName}' の存在を確認します。" . PHP_EOL;
37    if (file_exists($fileName)) {
38        echo "結果: ファイルは存在します。" . PHP_EOL;
39    } else {
40        echo "結果: ファイルは存在しません。（エラー）" . PHP_EOL;
41    }
42    echo PHP_EOL;
43
44    // 3. 作成したファイルを削除（後片付け）
45    echo "ステップ4: ファイル '{$fileName}' を削除します。" . PHP_EOL;
46    unlink($fileName);
47    echo PHP_EOL;
48
49
50    // --- ディレクトリの存在確認 ---
51    // file_exists() はディレクトリに対しても使用できます。
52    echo "ステップ5: ディレクトリ '{$directoryName}' の存在を確認します。" . PHP_EOL;
53    if (file_exists($directoryName)) {
54        echo "結果: ディレクトリは存在します。" . PHP_EOL;
55    } else {
56        echo "結果: ディレクトリは存在しません。" . PHP_EOL;
57    }
58}
59
60// 作成した関数を実行します
61checkFileAndDirectoryExistence();

このPHPサンプルコードは、file_exists()関数を使用して、指定したファイルやディレクトリが実際に存在するかどうかを確認する方法を示しています。file_exists()は、PHPに標準で用意されている基本的な関数です。

この関数の引数には、確認したいファイル名やディレクトリ名を文字列で渡します。関数は、指定されたパスにファイルまたはディレクトリが存在する場合には true を、存在しない場合には false を返します。この戻り値を利用して、if文などで処理を分岐させることが一般的です。

サンプルコードでは、まず存在しないファイル名を指定してfile_exists()を呼び出し、falseが返されることを確認しています。次に、touch()関数で空のファイルを作成してから再度file_exists()を実行すると、今度はtrueが返され、ファイルの存在が正しく認識されていることがわかります。

また、この関数はファイルだけでなく、ディレクトリの存在確認にも利用できる点が特徴です。コードの後半では、ディレクトリ名を指定してその存在を確認する例も示されています。このように、プログラムがファイルを読み書きする前に、対象の有無を安全にチェックする際などに広く使われます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * このサンプルコードは、意図的に例外を発生させ、
7 * 捕捉した例外オブジェクトの 'file' プロパティを利用して、
8 * エラーが発生したファイル自身のソースコードを file_get_contents() で読み込む方法を示します。
9 */
10function demonstrate_exception_and_file_read(): void
11{
12    try {
13        // 存在しないメソッドを呼び出すことで、BadMethodCallException を意図的に発生させます。
14        // このような呼び出しは、PHPの組み込みエラーではなく、
15        // フレームワークなどが __call マジックメソッド内でスローすることが一般的です。
16        // ここではその状況をシミュレートします。
17        throw new BadMethodCallException('存在しないメソッドが呼び出されました。');
18    } catch (BadMethodCallException $e) {
19        // 発生した例外を捕捉します。
20        echo "例外がキャッチされました！\n\n";
21
22        // BadMethodCallException オブジェクトが持つプロパティから情報を取得します。
23        // $e->getFile() は、例外が発生したファイルのフルパスを返します。
24        $errorFile = $e->getFile();
25        $errorLine = $e->getLine();
26        $errorMessage = $e->getMessage();
27
28        echo "メッセージ: {$errorMessage}\n";
29        echo "ファイル: {$errorFile}\n";
30        echo "行番号: {$errorLine}\n\n";
31        echo "--- file_get_contents() でエラー発生ファイルのソースを読み込みます ---\n\n";
32
33        // file_get_contents() を使って、エラーが発生したファイルの内容を文字列として読み込みます。
34        // ファイルの読み込みに失敗した場合は false が返るため、チェックを行います。
35        $fileContent = file_get_contents($errorFile);
36
37        if ($fileContent === false) {
38            echo "ファイルの読み込みに失敗しました。\n";
39        } else {
40            // 読み込んだファイルの内容（このスクリプト自身のソースコード）を出力します。
41            echo $fileContent;
42        }
43    }
44}
45
46// 関数を実行します。
47demonstrate_exception_and_file_read();

このPHPサンプルコードは、BadMethodCallExceptionを意図的に発生させ、捕捉した例外オブジェクトからエラー情報を取得する方法を示します。

BadMethodCallExceptionオブジェクトは、例外が発生した場所に関する情報を保持しています。その一つであるfileプロパティには、例外がスローされたファイルのフルパスが文字列として格納されています。この値は、getFile()メソッドを呼び出すことで取得できます。このメソッドは引数を取らず、戻り値としてファイルパスの文字列を返します。

サンプルコードでは、まずtryブロック内でBadMethodCallExceptionを意図的に発生させます。次にcatchブロックでその例外を捕捉し、例外オブジェクト（$e）のgetFile()メソッドを呼び出して、エラーが発生したファイルパスを取得しています。

そして、取得したファイルパスをfile_get_contents()関数の引数に渡しています。file_get_contents()は、指定されたファイルの内容全体を一つの文字列として読み込むための関数です。この機能を利用することで、エラーが発生したファイル（このサンプルコード自身）のソースコードを動的に読み込み、その内容を画面に出力しています。このように、例外オブジェクトのプロパティはデバッグ情報の収集などに活用できます。