SplFileObject::fputcsv
(PHP 5 >= 5.4.0, PHP 7, PHP 8)
SplFileObject::fputcsv — フィールドの配列を CSV の行として書き出す
説明
array
$fields,string
$separator = ",",string
$enclosure = "\"",string
$escape = "\\",string
$eol = "\n"): int|false
fields の配列を、CSV の行としてファイルに書き出します。
パラメータ
fields-
値の配列。
separator-
オプションで指定する、フィールドの区切り文字 (シングルバイト文字 一文字のみ)。
enclosure-
オプションで指定する。フィールドの囲み文字 (シングルバイト文字 一文字のみ)。
escape-
オプションの
escapeは、エスケープ文字 (シングルバイト文字 最大で一文字) を指定します。 空文字列 ("") を与えると、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構を無効にします。 eol-
eolは、 カスタムの行末シーケンスを設定するオプションの引数です。
escape
が空の文字列("")以外に設定されているとき、
» RFC 4180
に準拠しない CSV が生成されたり、PHP の CSV
関数を介してラウンドトリップ(往復変換)でデータが壊れる可能性があります。
escapeのデフォルト値は"\\"
なので、明示的に空の文字列を指定することを推奨します。デフォルト値は、PHP 9.0
以降の将来のバージョンで変更予定です。
注意:
enclosureがフィールド内に含まれる場合は、同じ文字を二度続けることでエスケープします。 ただし、その直前にescapeがある場合は別です。
escape
が空の文字列("")以外に設定されているとき、
» RFC 4180
に準拠しない CSV が生成されたり、PHP の CSV
関数を介してラウンドトリップ(往復変換)でデータが壊れる可能性があります。
escapeのデフォルト値は"\\"
なので、明示的に空の文字列を指定することを推奨します。デフォルト値は、PHP 9.0
以降の将来のバージョンで変更予定です。
戻り値
書き出した文字列の長さを返します。失敗した場合に false を返します。
separator や enclosure
が一文字でない場合は false を返し、何もファイルに書き出しません。
エラー / 例外
separator や enclosure
が一文字でない場合は E_WARNING レベルのエラーが発生します。
変更履歴
| バージョン | 説明 |
|---|---|
| 8.1.0 |
オプションの引数 eol が追加されました。
|
| 7.4.0 |
escape パラメータは空文字列を受け入れるようになりました。
この場合、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。
|
例
例1 SplFileObject::fputcsv() の例
<?php
$list = array (
array('aaa', 'bbb', 'ccc', 'dddd'),
array('123', '456', '789'),
array('"aaa"', '"bbb"')
);
$file = new SplFileObject('file.csv', 'w');
foreach ($list as $fields) {
$file->fputcsv($fields);
}
?>上の例は、次の内容をファイル file.csv に書き出します。
aaa,bbb,ccc,dddd 123,456,789 """aaa""","""bbb"""
参考
- fputcsv() - 行を CSV 形式にフォーマットし、ファイルポインタに書き込む
- SplFileObject::fgetcsv() - ファイルから行を取り出し CSV フィールドとして処理する
User Contributed Notes
