【PHP8.x】fputcsv関数の使い方
fputcsv関数は、CSV形式でフォーマットされた行をファイルポインタに書き込む関数です。この関数を使用することで、配列のデータをCSVファイルとして簡単に保存できます。ファイルポインタは、fopen関数などで事前に開いておく必要があります。
fputcsv関数は、必須の引数としてファイルポインタと、書き込むデータを含む配列を受け取ります。オプションの引数として、フィールドを囲む文字（通常はダブルクォーテーション）、フィールドを区切る文字（通常はカンマ）、および行末文字を指定できます。これらのオプション引数を省略した場合、デフォルト値が使用されます。
fputcsv関数は、書き込みに成功した場合は書き込んだ文字列の長さを返し、エラーが発生した場合はfalseを返します。エラーが発生した場合は、ファイルポインタが有効であること、および書き込み権限があることを確認してください。
fputcsv関数は、CSVファイルを生成する際に非常に便利です。例えば、データベースから取得したデータをCSV形式でエクスポートしたり、アプリケーションのログデータをCSV形式で保存したりする際に利用できます。この関数を使用することで、CSVファイルのフォーマットを自分で実装する必要がなくなり、開発効率が向上します。
基本的な使い方
構文(syntax)
fputcsv(resource $stream, array $fields, string $separator = ",", string $enclosure = "\"", string $escape = "\\", string $eol = "\n"): int|false
引数(parameters)
resource $stream, array $fields, string $separator = ",", string $enclosure = """, string $escape = "\", string $eol = "\n"
- resource $stream: 書き込み先のストリームリソースを指定します
- array $fields: CSVとして書き込むフィールドの配列を指定します
- string $separator = ",": フィールドの区切り文字を指定します。デフォルトはカンマです
- string $enclosure = """: フィールドを囲む文字を指定します。デフォルトはダブルクォーテーションです
- string $escape = "\": エスケープ文字を指定します。デフォルトはバックスラッシュです
- string $eol = "\n": 改行コードを指定します。デフォルトは改行文字です
戻り値(return)
int|false
fputcsv 関数は、CSV フォーマットでファイルにデータを書き込むために使用されます。成功した場合は書き込んだバイト数を、失敗した場合は false を返します。