【PHP8.x】fgetc()関数の使い方

Copy
1<?php
2
3/**
4 * CSVファイルを1行ずつ読み込み、配列として処理するサンプルコード
5 */
6
7// CSVファイルを開く
8$file = fopen("sample.csv", "r");
9
10if ($file) {
11    // ヘッダー行を読み飛ばす (必要に応じて)
12    fgetcsv($file);
13
14    // ファイルの終端に達するまで1行ずつ読み込む
15    while (($data = fgetcsv($file)) !== false) {
16        // データの処理 (例: 各要素を出力)
17        echo "Column 1: " . $data[0] . ", Column 2: " . $data[1] . ", Column 3: " . $data[2] . "\n";
18    }
19
20    // ファイルを閉じる
21    fclose($file);
22} else {
23    echo "ファイルを開けませんでした。\n";
24}
25
26?>

このPHPのサンプルコードは、fgetcsv関数を使ってCSVファイルを読み込み、各行を配列として処理する方法を示しています。

まず、fopen関数でCSVファイルを開き、ファイルポインタを変数$fileに格納します。fopen関数の第二引数 "r" は、ファイルを読み込み専用で開くことを意味します。

fgetcsv関数は、ファイルポインタ（$file）を引数に取り、CSVファイルから1行を読み込んで、その内容を配列として返します。区切り文字や囲み文字は、デフォルトではそれぞれカンマ(,)とダブルクォート(")が使用されます。必要に応じて、fgetcsv関数の第三引数、第四引数でこれらを変更できます。

サンプルコードでは、whileループを使ってファイルの終端に達するまでfgetcsv関数で1行ずつ読み込み、取得したデータを$data配列に格納しています。ループ内では、配列の各要素（例: $data[0], $data[1], $data[2])にアクセスして、それぞれのカラムの値を表示しています。

fgetcsv関数は、ファイルの終端に達した場合やエラーが発生した場合にfalseを返します。whileループはこのfalseが返されるまで処理を繰り返します。

最後に、fclose関数を使ってファイルを閉じます。fclose関数は、引数にファイルポインタを取り、ファイルを閉じます。ファイルを閉じることで、ファイルへのアクセスを終了し、リソースを解放します。

Copy
1<?php
2
3/**
4 * Reads a file, specifically checking for and skipping a UTF-8 Byte Order Mark (BOM)
5 * at the beginning, then demonstrates reading the file's content using fgetcsv.
6 * This addresses a common "bug" where BOMs can interfere with fgetcsv parsing,
7 * causing the first field to contain unexpected characters.
8 *
9 * @param string $filePath The path to the file to read.
10 * @return void
11 */
12function readFileSkippingBOM(string $filePath): void
13{
14    echo "--- Processing file: " . basename($filePath) . " ---\n";
15
16    // Open the file in binary read mode ('rb') to ensure exact byte reading.
17    $handle = fopen($filePath, 'rb');
18    if ($handle === false) {
19        echo "Error: Could not open file '{$filePath}'.\n\n";
20        return;
21    }
22
23    // Define the UTF-8 BOM sequence (EF BB BF in hexadecimal).
24    $utf8Bom = chr(0xEF) . chr(0xBB) . chr(0xBF);
25    $readBytes = '';
26
27    // Read the first three bytes using fgetc to check for the BOM.
28    for ($i = 0; $i < 3; $i++) {
29        $char = fgetc($handle);
30        if ($char === false) {
31            // End of file or error before reading 3 bytes.
32            break;
33        }
34        $readBytes .= $char;
35    }
36
37    // Compare the read bytes with the expected BOM.
38    if ($readBytes === $utf8Bom) {
39        echo "Detected and skipped UTF-8 BOM.\n";
40        // If BOM is found, the file pointer is already past it.
41    } else {
42        // If no BOM, or file is too short, rewind the file pointer to the beginning.
43        fseek($handle, 0);
44        echo "No UTF-8 BOM detected. Reading from the start.\n";
45    }
46
47    // Now, demonstrate reading the file content using fgetcsv.
48    echo "Content (first 3 lines via fgetcsv):\n";
49    $lineNumber = 0;
50    while (($data = fgetcsv($handle)) !== false && $lineNumber < 3) {
51        echo "  " . implode(", ", $data) . "\n";
52        $lineNumber++;
53    }
54    if ($lineNumber === 0) {
55        echo "  (No content or empty file after BOM check)\n";
56    }
57
58    // Close the file handle.
59    fclose($handle);
60    echo "\n";
61}
62
63// --- Demonstration ---
64
65// 1. Create a dummy CSV file with a UTF-8 BOM for testing.
66$fileWithBom = sys_get_temp_dir() . '/example_bom.csv';
67$bomContent = chr(0xEF) . chr(0xBB) . chr(0xBF) . "Header1,Header2\nValue1,Value2\nValue3,Value4";
68file_put_contents($fileWithBom, $bomContent);
69
70// 2. Create another dummy CSV file without a UTF-8 BOM for comparison.
71$fileWithoutBom = sys_get_temp_dir() . '/example_no_bom.csv';
72$noBomContent = "HeaderA,HeaderB\nValueA,ValueB\nValueC,ValueD";
73file_put_contents($fileWithoutBom, $noBomContent);
74
75// Process both files to show the effect of BOM handling.
76readFileSkippingBOM($fileWithBom);
77readFileSkippingBOM($fileWithoutBom);
78
79// Clean up the temporary files.
80unlink($fileWithBom);
81unlink($fileWithoutBom);

fgetc関数は、ファイルポインタから1文字（厳密には1バイト）を読み込むためのPHPの関数です。引数にはfopen関数などで開いたファイルのリソース（resource $stream）を指定します。成功すると読み込んだ1文字を文字列として返し、ファイルの終端に達した場合やエラーが発生した場合はfalseを返します。

このサンプルコードは、特にCSVファイルなどで問題となるUTF-8のBOM（Byte Order Mark）を安全に処理し、fgetcsv関数がBOMを誤ってデータの一部として認識してしまうという一般的な「バグ」を回避する方法を示しています。まず、fopen($filePath, 'rb')でファイルをバイナリモードで開き、BOMを正確に読み取れるようにします。次に、fgetcを3回呼び出してファイルの最初の3バイトを読み込み、それがUTF-8のBOM（chr(0xEF) . chr(0xBB) . chr(0xBF)）と一致するかどうかを判定します。

BOMが検出された場合、ファイルポインタは既にBOMの直後に位置しているため、その後のfgetcsvはデータ本体から処理を開始できます。BOMが検出されなかった、またはファイルがBOMより短い場合は、fseek($handle, 0)を使ってファイルポインタをファイルの先頭に戻し、fgetcsvが最初から正しく読み始められるようにします。このようにfgetcを活用することで、ファイル先頭の特殊なバイト列を事前に処理し、後続のファイル解析処理が意図しない挙動をするのを防ぐことができます。

Copy
1<?php
2
3/**
4 * fgetc関数を使用してファイルから1文字ずつ読み込み、改行コードを検出するサンプル。
5 *
6 * この例では、簡易的なCSVファイルの内容を1文字ずつ読み込み、
7 * その途中で改行コード ('\n' または '\r') を検出します。
8 * fgetcsv関数が内部で行うファイル読み込みの基本的な動きを理解する一助となります。
9 * 特に、様々な改行コード（LF, CR, CRLF）がどのようにファイル内で表現されているかを
10 * 1文字単位で確認できます。
11 */
12function read_file_char_by_char_and_detect_newline(): void
13{
14    // 処理対象となる一時的なCSVファイルを作成します。
15    // LF (Unix/Linux), CRLF (Windows), CR (古いMac) の改行コードを混在させます。
16    $file_path = 'temp_csv_for_fgetc.csv';
17    $file_content = "ID,Name,Value\n1,Apple,100\r\n2,Banana,200\r3,Orange,300";
18    file_put_contents($file_path, $file_content);
19
20    // ファイルを読み取りモードで開きます。
21    $handle = fopen($file_path, 'r');
22
23    if ($handle === false) {
24        // ファイルが開けない場合のエラーハンドリング
25        echo "エラー: ファイルを開けませんでした。\n";
26        return;
27    }
28
29    echo "ファイル内容を1文字ずつ読み込み、改行コードを検出します:\n";
30    $char_count = 0;
31    $detected_newline_chars_count = 0; // 検出された改行文字 ('\n' または '\r') の総数
32
33    // ファイルの終端に達するまで1文字ずつ読み込みます。
34    while (($char = fgetc($handle)) !== false) {
35        $char_count++;
36        
37        // 読み込んだ文字が改行コード ('\n' または '\r') であるかチェックします。
38        if ($char === "\n") {
39            echo "  [LF (ラインフィード) 改行文字検出]\n";
40            $detected_newline_chars_count++;
41        } elseif ($char === "\r") {
42            echo "  [CR (キャリッジリターン) 改行文字検出]\n";
43            $detected_newline_chars_count++;
44        } else {
45            // 通常の文字はそのまま出力
46            echo $char;
47        }
48    }
49
50    // ファイルを閉じます。
51    fclose($handle);
52
53    // 一時ファイルを削除します。
54    unlink($file_path);
55
56    echo "\n";
57    echo "--- 処理結果 ---\n";
58    echo "総文字数: " . $char_count . "\n";
59    echo "検出された改行文字の総数 (LF および CR): " . $detected_newline_chars_count . "\n";
60    echo "※ CRLF (Windows形式の改行コード) はCRとLFの2文字としてそれぞれ検出されます。\n";
61}
62
63// 関数の実行
64read_file_char_by_char_and_detect_newline();
65
66?>

PHPのfgetc関数は、指定されたファイルリソースから1文字ずつ読み込むための関数です。引数には、fopen関数などで開かれたファイルリソース（ファイルポインタ）を指定します。戻り値は読み込んだ1文字をstring型で返しますが、ファイルの終端に達したり読み込みに失敗した場合はfalseを返します。

このサンプルコードでは、fgetc関数を使って一時的に作成したCSVファイルの内容を1文字ずつ読み込み、その途中で様々な種類の改行コードを検出する例を示しています。具体的には、LF（ラインフィード、\n）とCR（キャリッジリターン、\r）の各文字を個別に検出することで、改行コードがファイル内でどのように表現されているかを確認できます。Windows環境でよく使われるCRLF形式の改行コードは、\rと\nの2文字として順に検出されることがわかります。

このように1文字ずつファイルを読み込むことで、fgetcsv関数が内部的にどのようにファイルの内容を解析し、行の区切りを判断しているかの基本的な動きを理解する助けとなります。fgetcは、特定の文字パターンをファイルから検索したり、文字エンコーディングの処理を行う際など、ファイルの低レベルな読み込みが必要な場面で活用できます。

Copy
1<?php
2
3/**
4 * CSVファイルを文字化けせずに読み込むサンプルコード
5 *
6 * fgetc関数を利用して1文字ずつ読み込み、文字コード変換を行うことで文字化けを防ぎます。
7 * 必要に応じて、mb_detect_encoding関数で文字コードを自動判別することも可能です。
8 *
9 * @param string $filename CSVファイルのパス
10 * @param string $encoding ファイルの文字コード (例: SJIS-win, UTF-8)
11 * @return array|false CSVデータ (配列) またはエラー時にfalse
12 */
13function readCsvWithoutEncodingIssue(string $filename, string $encoding = 'SJIS-win'): array|false
14{
15    $rows = [];
16    $row = [];
17    $field = '';
18
19    $handle = fopen($filename, 'r');
20    if ($handle === false) {
21        return false; // ファイルオープン失敗
22    }
23
24    while (($char = fgetc($handle)) !== false) {
25        if ($char === "," || $char === "\n") {
26            // フィールドの終端または行の終端
27            $row[] = mb_convert_encoding($field, 'UTF-8', $encoding);
28            $field = '';
29
30            if ($char === "\n") {
31                // 行の終端
32                $rows[] = $row;
33                $row = [];
34            }
35        } else {
36            // フィールドの文字を追加
37            $field .= $char;
38        }
39    }
40
41    // 最後の行を追加
42    if (!empty($field) || !empty($row)) {
43        $row[] = mb_convert_encoding($field, 'UTF-8', $encoding);
44        $rows[] = $row;
45    }
46
47    fclose($handle);
48
49    return $rows;
50}
51
52// 使用例:
53$filename = 'sample.csv'; // 読み込むCSVファイルのパス
54$data = readCsvWithoutEncodingIssue($filename, 'SJIS-win');
55
56if ($data === false) {
57    echo "ファイルの読み込みに失敗しました。\n";
58} else {
59    echo "<pre>";
60    print_r($data);
61    echo "</pre>";
62}
63
64?>

fgetc関数は、ファイルポインタ（$stream）から1文字読み込み、その文字を文字列として返します。ファイルの終端に達した場合やエラーが発生した場合はfalseを返します。

このサンプルコードでは、fgetc関数を利用してCSVファイルを1文字ずつ読み込み、文字コード変換を行うことで、文字化けを防ぎながらCSVデータを配列として取得するreadCsvWithoutEncodingIssue関数を定義しています。

readCsvWithoutEncodingIssue関数は、CSVファイルのパス（$filename）と文字コード（$encoding、デフォルトは'SJIS-win'）を引数として受け取ります。ファイルを開き、fgetcで1文字ずつ読み込みます。カンマ,または改行\nを検出すると、それまでの文字を1つのフィールドとして、mb_convert_encoding関数で指定された文字コードからUTF-8に変換し、配列に追加します。

ファイルの読み込みに成功した場合はCSVデータを多次元配列として返し、失敗した場合はfalseを返します。使用例では、sample.csvファイルをSJIS-winとして読み込み、結果をprint_r関数で表示しています。mb_detect_encoding関数を使用すれば、文字コードを自動で判別することも可能です。