【PHP8.x】fgetc関数の使い方
fgetc関数の使い方について、初心者にもわかりやすく解説します。
基本的な使い方
fgetc関数は、指定されたファイルポインタから1文字を読み込む関数です。この関数は、開いているファイルからデータをバイト単位ではなく文字単位で処理したい場合に非常に役立ちます。例えば、テキストファイルを文字コードに関わらず確実に1文字ずつ読み込みたいときや、バイナリファイルをバイト単位で処理したい場合などに利用されます。
fgetc関数を実行すると、引数として渡されたファイルポインタが指す現在位置から1バイトを読み込み、その1バイトを文字列として返します。読み込みが成功すると、ファイルポインタは自動的に次の文字の先頭に移動します。これにより、繰り返しfgetc関数を呼び出すことで、ファイルの先頭から順に全文字を読み進めることが可能です。
戻り値としては、正常に1文字を読み込めた場合はその文字が1文字の文字列として返されます。しかし、ファイルの終端（EOF: End Of File）に達した場合や、ファイルの読み込み中に何らかのエラーが発生した場合には、ブール値のfalseが返されます。このため、関数の呼び出し元では、返された値がfalseではないことを厳密に確認し、正確な処理を行う必要があります。特にバイナリデータの場合、NULLバイト（"\0"）も有効な文字として返されるため、falseとの比較は型を考慮した厳密な比較（===）が推奨されます。エラーの詳細を確認するには、feof()やferror()といった関連関数と組み合わせて使用することをお勧めします。
構文(syntax)
1<?php 2$file = 'example.txt'; 3file_put_contents($file, 'ABCDE'); 4 5$handle = fopen($file, 'r'); 6if ($handle) { 7 while (($char = fgetc($handle)) !== false) { 8 echo $char . "\n"; 9 } 10 fclose($handle); 11} 12 13unlink($file); 14?>
引数(parameters)
resource $stream
- resource $stream: 読み込み対象のファイルポインタ（リソース）を指定します。
戻り値(return)
string|false
ファイルポインタから1文字を読み込み、その文字を文字列として返します。ファイルの終端に達した場合やエラーが発生した場合はfalseを返します。
サンプルコード
PHPでCSVファイルを1行ずつ読み込む
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関数は、引数にファイルポインタを取り、ファイルを閉じます。ファイルを閉じることで、ファイルへのアクセスを終了し、リソースを解放します。
fgetcsv関数を使う際の注意点です。まず、ファイルを開くfopen関数でファイルポインタを取得する必要があります。fgetcsvは、ファイルポインタを引数に取り、CSV形式の1行を配列として返します。ファイルの終端に達するとfalseを返すため、!== falseで厳密に比較してください。また、CSVファイルにヘッダー行が含まれている場合は、最初のfgetcsvで読み飛ばす処理を追加すると良いでしょう。fclose関数でファイルを閉じるのを忘れないようにしてください。ファイルが開けない場合のエラー処理も重要です。
PHP fgetcでCSV文字化けを防ぐ
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関数を使用すれば、文字コードを自動で判別することも可能です。
fgetc関数を使ったCSV読み込み処理の注意点です。このサンプルコードは、CSVファイルを文字コードを考慮して読み込むためのものですが、いくつかの注意点があります。まず、fgetcは1文字ずつ読み込むため、大きなファイルを処理する場合は処理速度が遅くなる可能性があります。また、区切り文字がコンマと改行のみに対応しているため、CSVファイルの形式によっては正しく動作しない場合があります。mb_convert_encoding関数で文字コード変換を行っていますが、$encoding引数をCSVファイルの文字コードに合わせてください。文字コードが不明な場合は、mb_detect_encoding関数で自動判別を試みることもできますが、100%正確ではありません。さらに、エラー処理はファイルオープン失敗のみなので、より堅牢なコードにするためには、fgetc関数の返り値がfalseの場合のエラー処理を追加することを推奨します。最後に、このサンプルコードは基本的なCSVの構造を想定しており、引用符で囲まれたフィールドやエスケープ処理には対応していません。