【PHP8.x】SplFileObject::fputcsv()メソッドの使い方

fputcsvメソッドは、SplFileObjectクラスに属し、開いているファイルに配列の内容をCSV（Comma Separated Values）形式で書き込むためのメソッドです。このメソッドは、SplFileObjectインスタンスに対して呼び出され、引数として渡された配列の各要素をCSVのフィールドとして、ファイルに1行分のデータとして出力します。

具体的には、配列の要素は、指定された区切り文字（デフォルトはカンマ）で連結され、必要に応じて囲み文字（デフォルトはダブルクォーテーション）で囲んで出力されます。エスケープ文字や行末文字（改行コード）も引数で細かく指定でき、標準的なCSV形式から特定の要件に合わせた形式まで、幅広いCSVファイルの生成に対応可能です。

このメソッドは、プログラミングによって生成したデータをCSVファイルに出力したり、既存のCSVファイルにデータを追記したりする際に活用されます。正常に実行されると書き込まれたバイト数が整数値で返され、書き込みに失敗した場合はfalseが返されます。戻り値を確認することで処理の成功・失敗を正確に把握でき、データのエクスポート機能などの開発において、CSV形式のファイル出力処理を効率的に実装可能です。

Copy
1$splFileObject->fputcsv(array $fields, string $separator = ",", string $enclosure = "\"", string $escape = "\\", string $eol = "\n"): int|false;

array $fields, string $separator = ',', string $enclosure = '"', string $escape = '\', string $eol = ' '

• array $fields: CSVファイルに書き込むデータを含む配列
• string $separator = ',': フィールド間の区切り文字を指定する文字列。デフォルトはカンマ（,）。
• string $enclosure = '"': フィールドを囲む文字を指定する文字列。デフォルトはダブルクォーテーション（"）。
• string $escape = '\': $enclosure 文字をエスケープするために使用する文字列。デフォルトはバックスラッシュ（\）。
• string $eol = ' ': 行の終端文字を指定する文字列。デフォルトは改行コード。

int|false

SplFileObject::fputcsvは、CSV形式でファイルにデータを書き込んだバイト数を整数で返します。書き込みに失敗した場合はfalseを返します。