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

Copy
1<?php
2
3/**
4 * CompileError::$file の使用例を示す関数
5 *
6 * file_get_contents()で不正なPHPコードを含むファイルを読み込み、
7 * eval()で実行を試みることで意図的にCompileErrorを発生させます。
8 * その後、エラーオブジェクトからエラーが発生したファイル名を取得します。
9 */
10function demonstrateCompileErrorFileProperty(): void
11{
12    // エラーを発生させるための一時ファイル名
13    $filename = 'temporary_invalid_script.php';
14
15    // 意図的に構文エラー（セミコロンの欠落）を含むPHPコード
16    $invalidPhpCode = '<?php echo "This code has a syntax error"';
17
18    // 一時ファイルに不正なコードを書き込む
19    file_put_contents($filename, $invalidPhpCode);
20
21    try {
22        // キーワード: file_get_contents() を使用してファイルの内容を文字列として読み込む
23        $code = file_get_contents($filename);
24
25        // 読み込んだコードの実行を試みる
26        // 構文エラーがあるため、ここでParseError (CompileErrorのサブクラス) がスローされる
27        eval($code);
28
29    } catch (ParseError $e) {
30        // CompileErrorを継承したParseErrorをキャッチする
31        echo "エラーを捕捉しました。\n";
32        echo "------------------------\n";
33
34        // CompileError::$file プロパティは、エラーが発生したファイル名を取得します。
35        // $e->getFile() は内部的にこのプロパティの値にアクセスしています。
36        // eval()内のコードでエラーが発生した場合、eval()を呼び出したファイル名が返されます。
37        echo "エラーが発生したファイル: " . $e->getFile() . "\n";
38        echo "エラーが発生した行番号: " . $e->getLine() . "\n";
39        echo "エラーメッセージ: " . $e->getMessage() . "\n";
40
41    } finally {
42        // 後片付け: 実行後に作成した一時ファイルを削除する
43        if (file_exists($filename)) {
44            unlink($filename);
45        }
46    }
47}
48
49// 関数を実行して動作を確認する
50demonstrateCompileErrorFileProperty();

このPHPサンプルコードは、意図的にコンパイルエラーを発生させ、エラーがどのファイルで起きたかを知る方法を示します。CompileErrorクラスのfileプロパティは、コンパイルエラーが発生したファイルの名前を文字列として保持しています。

まず、プログラムは file_put_contents() を使い、わざと構文が間違っているPHPコード（この例ではセミコロンが欠けている）を一時ファイルに書き込みます。

次に try ブロックの中で、キーワードである file_get_contents() 関数を使い、先ほど作成したファイルの中身を文字列として読み込みます。そして eval() 関数がその文字列をPHPコードとして実行しようとしますが、構文エラーのため ParseError（CompileErrorの一種）が発生します。

catch ブロックでは、発生したエラーの情報を持つオブジェクト $e を捕捉します。$e->getFile() メソッドを呼び出すと、CompileErrorのfileプロパティの値、つまりエラーが発生したファイル名が文字列として返されます。このコードでは、eval() を実行したファイル自体の名前が取得されます。最後に、取得したファイル名、行番号、エラーメッセージを表示し、finally ブロックで後片付けとして一時ファイルを削除します。

Copy
1<?php
2
3/**
4 * 指定されたファイルにコンテンツを書き込みます。
5 *
6 * この関数は、`file_put_contents` 関数を使用してファイルにデータを書き込む基本的な方法を示します。
7 * リファレンス情報にある「file」はファイルパスを意味し、このサンプルコードでは書き込み先のファイルパスとして利用されます。
8 *
9 * @return void
10 */
11function writeContentToFile(): void
12{
13    // 書き込むファイル名を定義します。
14    // この変数 `$targetFile` は、PHPの内部エラーオブジェクト CompileError が保持する
15    // `file` プロパティ（エラーが発生したファイルパス）と同様に、ファイルパスの概念を表します。
16    $targetFile = 'example.txt';
17    
18    // ファイルに書き込むコンテンツを定義します。
19    $content = "これは `file_put_contents` 関数を使ってファイルに書き込まれた内容です。\n";
20    $content .= "PHP 8 での基本的なファイル書き込み操作の例です。";
21
22    // `file_put_contents` 関数は、指定されたファイルに文字列を書き込みます。
23    // ファイルが存在しない場合は作成され、存在する場合はデフォルトで上書きされます。
24    // 成功した場合は書き込まれたバイト数、失敗した場合は `false` を返します。
25    $bytesWritten = file_put_contents($targetFile, $content);
26
27    // 書き込みの成否を確認します。
28    if ($bytesWritten !== false) {
29        echo "ファイル '{$targetFile}' に {$bytesWritten} バイトを正常に書き込みました。\n";
30        echo "内容: \n{$content}\n";
31        echo "このファイルはスクリプトと同じディレクトリに作成されました。";
32    } else {
33        // ファイル書き込みに失敗した場合の処理です。
34        // 実際のアプリケーションでは、より詳細なエラーロギングが推奨されます。
35        error_log("ファイル '{$targetFile}' への書き込みに失敗しました。");
36        echo "エラー: ファイル '{$targetFile}' への書き込みに失敗しました。";
37    }
38}
39
40// 関数を実行してファイル書き込み処理を開始します。
41writeContentToFile();
42

このPHPサンプルコードは、file_put_contents 関数を用いて、指定したファイルに文字列を書き込む基本的な方法を示しています。

まず、$targetFile 変数に書き込み先のファイル名を、$content 変数に書き込む内容をそれぞれ文字列として定義します。リファレンス情報にある CompileError クラスの file プロパティは、エラーが発生したファイルへのパスを文字列として保持します。このコードの $targetFile も同様に、処理対象となるファイルパスを文字列で指定する役割を担っています。

中心となる file_put_contents 関数は、第一引数に指定されたファイルパスへ、第二引数の内容を書き込みます。このとき、指定したファイルが存在しない場合は新しく作成され、既に存在している場合はその内容が上書きされます。

この関数は、処理が成功すると書き込んだデータのバイト数を数値で返し、失敗した場合は false を返します。コードでは、この戻り値を利用して if 文で処理の成否を判定し、結果に応じたメッセージを画面に出力します。最後に writeContentToFile() 関数を呼び出すことで、この一連のファイル書き込み処理が実行されます。