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

Copy
1<?php
2
3/**
4 * ClosedGeneratorException の 'file' プロパティと file_get_contents の使用例を示します。
5 * このコードは意図的に閉じられたジェネレータにアクセスすることで ClosedGeneratorException を発生させ、
6 * その例外からファイル名を取得し、ファイルの内容を読み込みます。
7 */
8function demonstrateClosedGeneratorExceptionFileProperty(): void
9{
10    // ジェネレータ関数を定義します。一度 yield すると終了します。
11    function simpleGenerator(): Generator
12    {
13        yield 'これはジェネレータからの最初の値です。';
14        // このジェネレータは一度しか値を生成しないため、次に current() や next() が呼ばれると終了状態になります。
15    }
16
17    $generator = simpleGenerator();
18
19    try {
20        // ジェネレータの最初の値を取得し、その後ジェネレータを進めます。
21        // これによりジェネレータは終了状態になります。
22        echo "ジェネレータの実行: " . $generator->current() . PHP_EOL;
23        $generator->next(); // ジェネレータを次の状態に進めます（このジェネレータはここで終了します）。
24
25        echo "閉じられたジェネレータにアクセスを試みます..." . PHP_EOL;
26        // 閉じられたジェネレータに対して current() を呼び出すと ClosedGeneratorException がスローされます。
27        $generator->current(); // ここで例外が発生します
28    } catch (ClosedGeneratorException $e) {
29        echo "ClosedGeneratorException を捕捉しました！" . PHP_EOL;
30
31        // 例外が発生したソースコードファイル名を取得します。
32        $exceptionFile = $e->getFile();
33        echo "例外が発生したファイル: " . $exceptionFile . PHP_EOL;
34
35        // キーワードである file_get_contents を使用して、例外が発生したファイルの内容の一部を読み込みます。
36        // このコード自身が例外を発生させているため、$exceptionFile はこのスクリプトのファイルパスを指します。
37        if (file_exists($exceptionFile) && is_readable($exceptionFile)) {
38            echo "--- 例外発生ファイルの最初の3行 ---" . PHP_EOL;
39            // ファイルの内容全体を表示すると長くなるため、最初の数行のみを読み込み・表示します。
40            $fileContents = file_get_contents($exceptionFile);
41            if ($fileContents !== false) {
42                $lines = explode(PHP_EOL, $fileContents);
43                for ($i = 0; $i < min(3, count($lines)); $i++) {
44                    echo ($i + 1) . ": " . $lines[$i] . PHP_EOL;
45                }
46            } else {
47                echo "ファイルの読み込みに失敗しました。" . PHP_EOL;
48            }
49            echo "------------------------------------" . PHP_EOL;
50        } else {
51            echo "例外発生ファイルが存在しないか、読み取りができません: " . $exceptionFile . PHP_EOL;
52        }
53    } catch (Throwable $e) {
54        // その他の予期せぬ例外を捕捉します。
55        echo "予期せぬ例外を捕捉しました: " . get_class($e) . " - " . $e->getMessage() . PHP_EOL;
56    }
57}
58
59// 定義した関数を実行します。
60demonstrateClosedGeneratorExceptionFileProperty();

このPHPサンプルコードは、ClosedGeneratorExceptionクラスのfileプロパティと、file_get_contents関数の利用方法をシステムエンジニアを目指す初心者向けに解説します。

まず、ジェネレータ関数を定義し、一度だけ値を生成した後に意図的にジェネレータを閉じます。閉じられたジェネレータに対し、再度値を取得しようとするとClosedGeneratorExceptionがスローされます。

この例外をtry-catchブロックで捕捉した後、$e->getFile()を呼び出します。ClosedGeneratorExceptionクラスのfileプロパティは、引数を必要とせず、例外が発生したソースコードのファイルパスを文字列（string）として返します。この例では、現在のスクリプトファイル自身のパスが返されます。

取得したファイルパスを使用して、php file_get_contents関数でそのファイルの内容を読み込み、最初の数行を表示しています。file_get_contentsは指定されたファイルの全内容を文字列として取得する関数です。このように、fileプロパティは例外発生箇所の特定に役立ち、file_get_contentsと組み合わせることで、デバッグ時に周辺のコード情報を確認するのに有効です。

Copy
1<?php
2
3/**
4 * 指定されたファイルにコンテンツを書き込む関数です。
5 * file_put_contents関数を使用してファイルにデータを書き込みます。
6 * 成功した場合はファイルパスを表示し、失敗した場合はエラーメッセージを表示します。
7 *
8 * @param string $filePath 書き込むファイルのパス。
9 * @param string $content ファイルに書き込む内容。
10 * @return bool 書き込みが成功した場合はtrue、失敗した場合はfalse。
11 */
12function writeContentToFile(string $filePath, string $content): bool
13{
14    // file_put_contents関数でファイルにコンテンツを書き込みます。
15    // 第1引数にファイルパス、第2引数に書き込む内容を指定します。
16    // この関数はデフォルトでファイルを上書きします。
17    // 成功した場合は書き込まれたバイト数を返し、失敗した場合はfalseを返します。
18    if (file_put_contents($filePath, $content) !== false) {
19        echo "コンテンツをファイル '{$filePath}' に正常に書き込みました。" . PHP_EOL;
20        return true;
21    } else {
22        // ファイルへの書き込みに失敗した場合の処理です。
23        // 例えば、指定されたディレクトリが存在しない、または書き込み権限がない場合などに失敗します。
24        echo "エラー: ファイル '{$filePath}' へのコンテンツ書き込みに失敗しました。" . PHP_EOL;
25        return false;
26    }
27}
28
29// --- サンプル使用例 ---
30
31// 書き込むファイルの名前を定義します。
32$fileName = 'my_sample_file.txt';
33
34// ファイルに書き込む内容を定義します。
35$fileContent = "これはPHPのfile_put_contents関数を使ったサンプルです。\n";
36$fileContent .= "システムエンジニアを目指す初心者向けの簡単なコードです。\n";
37$fileContent .= "ファイル操作の基本を学びましょう！";
38
39// 定義したファイルパスとコンテンツを使って関数を実行します。
40writeContentToFile($fileName, $fileContent);
41
42echo PHP_EOL; // 見やすくするための改行
43
44// 追記モードでの書き込み例 (オプション)
45// 既存のファイルに内容を追加したい場合は、第三引数に FILE_APPEND フラグを指定します。
46// $appendFileName = 'my_sample_file_append.txt';
47// $appendContent = "\n\nこれは追記された内容です。\n";
48// if (file_put_contents($appendFileName, $appendContent, FILE_APPEND) !== false) {
49//     echo "コンテンツをファイル '{$appendFileName}' に正常に追記しました。" . PHP_EOL;
50// } else {
51//     echo "エラー: ファイル '{$appendFileName}' へのコンテンツ追記に失敗しました。" . PHP_EOL;
52// }
53
54// 存在しないディレクトリへの書き込み試行例 (失敗例)
55// $invalidPath = 'non_existent_directory/error_file.txt';
56// $errorContent = "このファイルは書き込みに失敗するはずです。";
57// writeContentToFile($invalidPath, $errorContent);
58
59?>

このPHPコードは、file_put_contents関数を使用してファイルに文字列を書き込む基本的な方法を示しています。まず、writeContentToFileという関数が定義されており、この関数は与えられたファイルパスに指定のコンテンツを書き込みます。

file_put_contents関数は、ファイル操作の中心となる機能です。この関数は、第一引数に書き込み対象のファイルパス、第二引数に書き込む内容の文字列を受け取ります。指定されたファイルが存在しない場合は新しく作成し、既に存在する場合はその内容を完全に上書きする挙動がデフォルトです。ファイルの書き込みが成功すると、書き込まれたバイト数を整数で返し、失敗した場合はブール値のfalseを返します。この戻り値を確認することで、ファイルへの書き込みが成功したか失敗したかを判断できます。

writeContentToFile関数の引数 $filePath は書き込むファイルのパスを文字列で指定し、$content はファイルに書き込む内容を文字列で指定します。この関数の戻り値は、ファイルへの書き込みが成功した場合は true、失敗した場合は false というブール値です。サンプルコードを実行すると、「my_sample_file.txt」というファイルが作成され、定義されたテキストがその中に書き込まれます。ファイルが存在しないディレクトリへの書き込みや、書き込み権限がない場合などには、エラーメッセージが表示されるようになっています。この例は、PHPでのファイル操作の基礎を理解するのに役立つでしょう。