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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 指定されたファイルが存在するかどうかを確認し、存在しない場合は例外をスローします。
7 *
8 * この関数は、file_exists() を使用してファイルの存在をチェックします。
9 * ファイルが見つからない場合、論理的なエラーとして LogicException をスローします。
10 *
11 * @param string $filePath 確認するファイルのパス
12 * @return void
13 * @throws LogicException ファイルが存在しない場合
14 */
15function processFile(string $filePath): void
16{
17    // file_exists() を使ってファイルの存在を確認します。
18    if (!file_exists($filePath)) {
19        // ファイルが存在しないのは論理的な間違いであるため、LogicExceptionをスローします。
20        throw new LogicException("ファイル '{$filePath}' が見つかりませんでした。処理を続行できません。");
21    }
22
23    // 本来であれば、ここでファイル読み込みなどの処理が続きます。
24    echo "ファイル '{$filePath}' の処理が正常に完了しました。\n";
25}
26
27// 存在しないファイルパスを指定して、意図的に例外を発生させます。
28$nonExistentFile = 'this_file_does_not_exist.txt';
29
30try {
31    // 例外が発生する可能性のあるコードを try ブロックで囲みます。
32    processFile($nonExistentFile);
33} catch (LogicException $e) {
34    // LogicException がスローされた場合に、catch ブロックで捕捉します。
35    echo "エラーが発生しました。\n";
36    echo "----------------------------------------\n";
37    // getMessage() で例外メッセージを取得します。
38    echo "メッセージ: " . $e->getMessage() . "\n";
39    // getFile() で例外がスローされたファイル名 (このスクリプト自身の名前) を取得します。
40    // これは LogicException の 'file' プロパティに対応します。
41    echo "発生したファイル: " . $e->getFile() . "\n";
42    // getLine() で例外がスローされた行番号を取得します。
43    echo "発生した行番号: " . $e->getLine() . "\n";
44    echo "----------------------------------------\n";
45}

LogicExceptionクラスが持つfileプロパティは、プログラムの実行中に例外が発生したソースコードのファイルパスを文字列で保持します。このプロパティの値は、通常getFile()メソッドを呼び出すことで取得できます。引数はなく、戻り値としてファイルパスを示す文字列（string）を返します。

このサンプルコードでは、まずprocessFile関数がfile_exists()関数を使って、指定されたファイルの存在を確認します。ファイルが見つからない場合、これはプログラムの論理的な誤りであるとみなし、LogicExceptionを発生させます。tryブロック内でこの例外が発生すると、続くcatchブロックでその例外が捕捉されます。

catchブロック内では、捕捉したLogicExceptionオブジェクト（変数$e）に対して$e->getFile()を実行しています。これにより、fileプロパティに自動的に格納されている「例外がthrowされたファイル名（このサンプルコード自身のファイル名）」が文字列として返され、画面に出力されます。この情報は、エラーの原因がどのファイルで発生したのかを特定するデバッグ作業において非常に役立ちます。

Copy
1<?php
2
3/**
4 * ファイルパスを受け取り、その内容を文字列として返します。
5 *
6 * この関数は、`file_get_contents` を使ってファイル操作を行いますが、
7 * 引数に問題がある場合は `LogicException` をスローします。
8 *
9 * @param string|null $filePath 読み込むファイルのパス。
10 * @return string ファイルの内容。
11 * @throws LogicException ファイルパスが指定されていない場合にスローされます。
12 * @throws RuntimeException ファイルの読み込みに失敗した場合にスローされます。
13 */
14function getContentFromFile(?string $filePath): string
15{
16    // ファイルパスが null または空文字列の場合、プログラムのロジック上の誤りとして扱う
17    if (empty($filePath)) {
18        // LogicException をスローして、呼び出し元に設計上の問題を通知する
19        throw new LogicException('ファイルパスが指定されていません。');
20    }
21
22    // file_get_contents() は、ファイルが存在しない場合などに false を返す
23    // @ 演算子で、失敗時に発生するPHPの警告(Warning)を抑制する
24    $content = @file_get_contents($filePath);
25
26    // 読み込みに失敗した場合 (戻り値が false だった場合)
27    if ($content === false) {
28        // 実行時の予期せぬ問題として RuntimeException をスローする
29        throw new RuntimeException("ファイル '{$filePath}' の読み込みに失敗しました。");
30    }
31
32    return $content;
33}
34
35// --- メイン処理 ---
36// 例外が発生する可能性のある処理は try ブロックで囲む
37try {
38    // わざと null を渡して LogicException を発生させる
39    echo "不正な引数で関数を呼び出します..." . PHP_EOL;
40    getContentFromFile(null);
41} catch (LogicException $e) {
42    // catch ブロックで LogicException を捕捉する
43    echo "エラー: ロジック上の問題が発生しました。" . PHP_EOL;
44    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
45
46    // LogicExceptionが持つ `file` プロパティ（getFile()メソッドで取得）を使い、
47    // 例外がどのファイルで発生したかを表示する
48    echo "発生したファイル: " . $e->getFile() . PHP_EOL;
49    echo "発生した行番号: " . $e->getLine() . PHP_EOL;
50} catch (RuntimeException $e) {
51    // 読み込み失敗など、他の実行時エラーはこちらで捕捉する
52    echo "エラー: 実行時エラーが発生しました。" . PHP_EOL;
53    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
54}

このPHPサンプルコードは、プログラムの設計や論理的な誤りを通知するための例外処理、特に LogicException の使い方を解説するものです。

getContentFromFile関数は、引数として受け取ったファイルパスを元に、file_get_contents関数でファイルの内容を読み込み、文字列として返す設計です。しかし、引数にnullのような不正な値が渡された場合、これはプログラムの実行時エラーではなく、設計上の誤りであるためLogicExceptionをスロー（発生）させます。

メインの処理では、try...catch構文を用いて例外処理を行っています。tryブロック内で意図的にnullを引数として関数を呼び出すことでLogicExceptionを発生させ、続くcatchブロックでその例外を捕捉します。

捕捉したLogicExceptionのオブジェクト（変数$e）からは、エラーに関する詳細な情報を取得できます。$e->getFile()メソッドは、例外がスローされたファイルへのパスを文字列(string)として返します。このコードでは、このメソッドを使ってエラーが発生したファイル名を特定し、メッセージと共に出力しています。これにより、問題がどこで起きたのかを正確に把握でき、デバッグ作業を効率的に進めることが可能になります。