【PHP8.x】fclose関数の使い方

Copy
1<?php
2
3/**
4 * ファイルへの書き込みとクローズ処理を行う関数。
5 *
6 * この関数はファイルを開き、データを書き込み、そしてリソースを安全に閉じます。
7 * `fclose()` を適切に呼び出さないと、ファイルロックが解除されなかったり、
8 * システムリソースが枯渇したりする可能性があるため、注意が必要です。
9 *
10 * @param string $filePath 操作対象のファイルパス
11 * @return bool ファイル操作が成功した場合は true、失敗した場合は false
12 */
13function safeFileWriteAndClose(string $filePath): bool
14{
15    // ファイルを書き込みモード ('w') で開く
16    // 'w' モードはファイルを空にして書き込み用に開きます。
17    // ファイルが存在しない場合は作成されます。
18    $stream = fopen($filePath, 'w');
19
20    // ファイルオープンに失敗した場合のエラーハンドリング
21    if ($stream === false) {
22        echo "エラー: ファイル '{$filePath}' を開けませんでした。\n";
23        return false;
24    }
25
26    echo "ファイル '{$filePath}' を開きました。\n";
27
28    // ファイルに書き込むデータ
29    $dataToWrite = "これは fclose 関数のテストデータです。\n";
30
31    // ファイルへのデータ書き込み
32    $bytesWritten = fwrite($stream, $dataToWrite);
33
34    // 書き込みに失敗した場合のエラーハンドリング
35    if ($bytesWritten === false) {
36        echo "エラー: ファイルへの書き込みに失敗しました。\n";
37        // 書き込み失敗時でも、開いたリソースは必ず閉じるべきです。
38        fclose($stream);
39        return false;
40    }
41
42    echo "ファイルに {$bytesWritten} バイトを書き込みました。\n";
43
44    // ファイルリソースを閉じる
45    // これを忘れると、ファイルがロックされたままになったり、
46    // システムリソースが解放されずにメモリリークやリソース枯渇を引き起こす可能性があります。
47    // （「php fclose しない」ことの問題点です）
48    if (fclose($stream)) {
49        echo "ファイル '{$filePath}' を正常に閉じました。\n";
50        // テスト用に作成したファイルを削除する（オプション）
51        if (file_exists($filePath)) {
52            if (unlink($filePath)) {
53                echo "テストファイル '{$filePath}' を削除しました。\n";
54            } else {
55                echo "警告: テストファイル '{$filePath}' を削除できませんでした。\n";
56            }
57        }
58        return true;
59    } else {
60        echo "警告: ファイル '{$filePath}' を閉じられませんでした。\n";
61        return false;
62    }
63}
64
65// サンプルコードを実行
66$fileName = 'sample_output_for_fclose.txt';
67safeFileWriteAndClose($fileName);
68

PHPのfclose関数は、fopenなどで開かれたファイルやネットワーク接続といったリソースを閉じるために使用されます。引数には、閉じたいリソース（resource型）を指定します。この関数が成功するとtrueが、失敗するとfalseが戻り値として返されます。

サンプルコードのsafeFileWriteAndClose関数では、まずfopenでファイルを書き込みモードで開いた後、データ書き込み処理を行っています。そして、すべてのファイル操作が完了した後にfclose($stream)を呼び出しています。これは、プログラムが占有していたファイルリソースを解放し、ファイルロックを解除するために不可欠な処理です。

fcloseを適切に呼び出さない（「php fclose しない」）場合、開いたファイルがロックされたままになり、他のプログラムがそのファイルにアクセスできなくなったり、ファイルハンドルやメモリといったシステムリソースが解放されずに残り続けたりする問題が発生します。特に、多数のファイルを開閉する処理や、長時間稼働するアプリケーションでは、このようなリソースの枯渇がシステム全体のパフォーマンス低下や不安定化に繋がりかねません。したがって、開いたリソースは必ずfcloseで閉じる習慣を身につけることが、安定したシステム開発において非常に重要です。

Copy
1<?php
2
3/**
4 * 指定されたファイルにメッセージを書き込み、ファイルを閉じます。
5 * ファイル操作中に発生する可能性のあるエラーを処理します。
6 *
7 * @param string $filename 書き込むファイルの名前
8 * @param string $message 書き込む内容
9 * @return bool 処理が成功した場合はtrue、失敗した場合はfalse
10 */
11function writeMessageToFile(string $filename, string $message): bool
12{
13    $filePointer = null; // ファイルポインタを初期化します
14
15    try {
16        // ファイルを書き込みモード ('w') で開きます。
17        // 'w'モードは、ファイルが存在すれば内容を削除し、存在しなければ新規作成します。
18        // fopen()が失敗すると、falseを返します。
19        $filePointer = fopen($filename, 'w');
20
21        if ($filePointer === false) {
22            // ファイルオープンに失敗した場合のエラー処理
23            echo "エラー: ファイル '{$filename}' を開けませんでした。\n";
24            return false; // 処理失敗
25        }
26
27        // ファイルにメッセージを書き込みます。
28        // fwrite()が失敗すると、falseを返します。
29        $bytesWritten = fwrite($filePointer, $message);
30
31        if ($bytesWritten === false) {
32            // ファイル書き込みに失敗した場合のエラー処理
33            echo "エラー: ファイル '{$filename}' への書き込みに失敗しました。\n";
34            return false; // 処理失敗
35        }
36
37        echo "ファイル '{$filename}' に {$bytesWritten} バイトを書き込みました。\n";
38        return true; // ここまでのファイル操作は成功
39
40    } finally {
41        // finallyブロックは、tryブロックの実行結果（成功・失敗にかかわらず）に関わらず必ず実行されます。
42        // これにより、ファイルポインタが開いている場合は確実に閉じることができます。
43
44        // $filePointerが有効なリソースであることを確認してからfclose()を呼び出します。
45        // PHP 8ではfclose()の引数型ヒントがresourceであるため、
46        // fopen()が失敗して$filePointerがfalseの場合、そのまま呼び出すとTypeErrorが発生します。
47        // そのため、is_resource()でチェックすることが重要です。
48        if (is_resource($filePointer)) {
49            // fclose()は、成功するとtrue、失敗するとfalseを返します。
50            if (fclose($filePointer)) {
51                echo "ファイル '{$filename}' を正常に閉じました。\n";
52            } else {
53                // fclose()が失敗することは非常に稀ですが、発生した場合に備えてエラーを報告します。
54                echo "エラー: ファイル '{$filename}' を閉じられませんでした。\n";
55            }
56        }
57    }
58}

PHPのfclose関数は、fopen関数などで開かれたファイルリソースを閉じるために使用されます。ファイル操作の最後には、必ずこの関数を使って開いたファイルを閉じることが重要です。ファイルを閉じないと、リソースが解放されずに残り続け、システムの負荷やファイル破損の原因となる可能性があります。

fclose関数の引数には、fopen関数などが返したファイルポインタ（resource $stream）を指定します。このファイルポインタは、開かれたファイルへの接続を表すものです。戻り値は真偽値（bool）で、ファイルのクローズに成功した場合はtrue、何らかの理由で失敗した場合はfalseが返されます。

サンプルコードでは、writeMessageToFile関数の中で、ファイルへの書き込み処理を行った後、finallyブロック内でfcloseを呼び出しています。finallyブロックは、tryブロック内の処理が成功しても失敗しても必ず実行されるため、ファイルリソースを確実に閉じることができます。

特にPHP 8以降では、fcloseの引数にresource型が期待されるため、fopen関数が失敗してファイルポインタがfalseになっている状態でfcloseを呼び出すと、TypeErrorというエラーが発生します。そのため、サンプルコードのようにis_resource()関数を使って、ファイルポインタが有効なリソースであるかを必ずチェックしてからfcloseを呼び出すことが重要です。また、fclose自体がfalseを返すことは非常に稀ですが、万一に備えてその戻り値も確認し、適切にエラー処理を行うことが推奨されます。