［PHP］ファイルから1行ずつ読み込む: fgets()関数の使い方と重要性

PHP

ファイル操作は、多くの場面で必要とされる基本的なタスクです。その中でも、ファイルから1行ずつデータを読み込む際に使用される fgets() 関数について解説します。この記事では、fgets() 関数の使い方とその重要性について紹介します。

fgets() 関数とは

fgets() 関数は、指定されたファイルから1行ずつデータを読み込むためのPHPの組み込み関数です。ファイルポインタから次の行を読み取り、文字列として返します。この関数を使用することで、大きなファイルでもメモリを効率的に利用してデータを処理することができます。

使い方

<?php
$file = fopen("example.txt", "r") or die("ファイルを開けませんでした。");
while(!feof($file)) {
  echo fgets($file) . "<br>";
}
fclose($file);
?>

上記の例では、”example.txt”というファイルからデータを1行ずつ読み込み、fgets() 関数を使って画面に表示しています。feof() 関数を使ってファイルの終端に達したかどうかを確認し、ループを繰り返します。

実践的な活用例

例1：CSVファイルを読み込んで表形式で表示

phpCopy<?php
// CSVファイルを開く
$file = fopen("data.csv", "r");

if ($file) {
    echo "<table border='1'>";
    
    // 行番号をカウント（ヘッダー行の特別処理用）
    $row_number = 0;
    
    // 1行ずつ読み込む
    while (($line = fgets($file)) !== false) {
        // 行を整形（改行文字を削除）
        $line = trim($line);
        
        // カンマで分割してセルに表示
        $cells = explode(",", $line);
        
        // 最初の行はヘッダーとして処理
        if ($row_number == 0) {
            echo "<tr>";
            foreach ($cells as $cell) {
                echo "<th>" . htmlspecialchars($cell) . "</th>";
            }
            echo "</tr>";
        } else {
            echo "<tr>";
            foreach ($cells as $cell) {
                echo "<td>" . htmlspecialchars($cell) . "</td>";
            }
            echo "</tr>";
        }
        
        $row_number++;
    }
    
    echo "</table>";
    
    // ファイルを閉じる
    fclose($file);
} else {
    echo "CSVファイルを開けませんでした。";
}
?>

例2：ログファイルから特定のパターンを検索

phpCopy<?php
// 検索パターン
$search_term = "error";

// 検索するログファイル
$log_file = "application.log";

// ファイルを開く
$file = fopen($log_file, "r");

if ($file) {
    echo "<h2>「{$search_term}」を含む行：</h2>";
    echo "<pre>";
    
    $line_number = 0;
    $matches_found = 0;
    
    // 1行ずつ読み込む
    while (($line = fgets($file)) !== false) {
        $line_number++;
        
        // 指定したパターンを含む行を検索
        if (stripos($line, $search_term) !== false) {
            echo "<strong>行 {$line_number}:</strong> " . htmlspecialchars($line);
            $matches_found++;
        }
    }
    
    echo "</pre>";
    
    if ($matches_found == 0) {
        echo "該当する行は見つかりませんでした。";
    } else {
        echo "合計 {$matches_found} 件の一致が見つかりました。";
    }
    
    // ファイルを閉じる
    fclose($file);
} else {
    echo "ログファイルを開けませんでした。";
}
?>

例3：巨大ファイルを効率的に処理する

phpCopy<?php
// 処理する巨大ファイル
$large_file = "very_large_file.txt";

// 統計情報を初期化
$line_count = 0;
$word_count = 0;
$char_count = 0;

// ファイルを開く
$file = fopen($large_file, "r");

if ($file) {
    // メモリ使用量を表示
    echo "処理前のメモリ使用量: " . memory_get_usage() . " バイト<br>";
    
    // 開始時間を記録
    $start_time = microtime(true);
    
    // 1行ずつ読み込む
    while (($line = fgets($file)) !== false) {
        // 行数をカウント
        $line_count++;
        
        // 単語数をカウント（空白で分割）
        $words = preg_split('/\s+/', $line, -1, PREG_SPLIT_NO_EMPTY);
        $word_count += count($words);
        
        // 文字数をカウント（改行を含まない）
        $char_count += strlen(trim($line));
        
        // 途中経過を100,000行ごとに表示
        if ($line_count % 100000 == 0) {
            echo "{$line_count} 行処理しました...<br>";
            flush(); // 出力バッファをフラッシュ
        }
    }
    
    // 処理時間を計算
    $end_time = microtime(true);
    $processing_time = $end_time - $start_time;
    
    echo "<h2>ファイル統計情報</h2>";
    echo "行数: {$line_count}<br>";
    echo "単語数: {$word_count}<br>";
    echo "文字数: {$char_count}<br>";
    echo "処理時間: {$processing_time} 秒<br>";
    echo "処理後のメモリ使用量: " . memory_get_usage() . " バイト<br>";
    
    // ファイルを閉じる
    fclose($file);
} else {
    echo "ファイルを開けませんでした。";
}
?>

fgets関数の注意点

1. 改行文字の扱い

fgets()は行末の改行文字（\n, \r\n）を含めて返します。改行文字を除去したい場合は、trim()やrtrim()を使う必要があります。

phpCopy<?php
$file = fopen("example.txt", "r");

if ($file) {
    while (($line = fgets($file)) !== false) {
        // 改行文字を除去
        $line = rtrim($line);
        echo $line . "<br>"; // HTMLの改行タグで表示
    }
    fclose($file);
}
?>

2. バイナリファイルの扱い

fgets()はテキストファイル向けの関数です。バイナリファイルを読み込む場合は、代わりにfread()を使用してください。

3. 大きなファイルとメモリ使用量

fgets()の最大の利点は、ファイル全体をメモリに読み込む必要がなく、1行ずつ処理できることです。これにより、非常に大きなファイルでもメモリを効率的に使用できます。

phpCopy<?php
// 悪い例：ファイル全体をメモリに読み込む
$contents = file_get_contents("large_file.txt"); // メモリを大量消費する可能性あり

// 良い例：1行ずつ読み込む
$file = fopen("large_file.txt", "r");
if ($file) {
    while (($line = fgets($file)) !== false) {
        // 1行ずつ処理
    }
    fclose($file);
}
?>

4. エラー処理とファイル終端の判定

fgets()はファイル終端に達した場合や読み込みエラーが発生した場合にfalseを返します。これらの状況を区別するには、feof()関数を併用します。

phpCopy<?php
$file = fopen("example.txt", "r");

if ($file) {
    while (($line = fgets($file)) !== false) {
        // 行を処理
    }
    
    if (!feof($file)) {
        echo "ファイルの読み込み中にエラーが発生しました。";
    }
    
    fclose($file);
}
?>

重要性

  • 大容量ファイルの処理: fgets() 関数を使用することで、大きなファイルをメモリに全て読み込むことなく、1行ずつ処理することができます。
  • 行指向の処理: ファイルを行単位で処理する必要がある場合に便利です。ログファイルの解析やデータの加工などに活用されます。

まとめ

fgets() 関数は、ファイルから1行ずつデータを読み込むための便利な関数です。大容量のファイルや行指向の処理を行う際に、効率的なファイル操作を実現するのに役立ちます。

以上、fgets() 関数についての解説でした。次回の記事もお楽しみに！

タイトルとURLをコピーしました