PHP マニュアル: CSV の区切り文字、囲み文字、エスケープ文字をセットする

説明

public void SplFileObject::setCsvControl(string $separator = ",", string $enclosure = "\"", string $escape = "\\")

CSV フィールド処理用の区切り文字と囲み文字とエスケープ文字をセットします。

パラメータ

separator: separator パラメータで、フィールドのデリミタを設定します。シングルバイト文字 1 文字のみでなければなりません。
enclosure: オプションの enclosure パラメータで、フィールド囲いこみ文字を設定します。シングルバイト文字 1 文字のみでなければなりません。
escape: オプションの escape パラメータで、エスケープ文字を設定します。シングルバイト文字 1 文字のみ、または空文字列でなければなりません。空文字列("") を指定すると、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。

警告
入力ストリームにおいて、enclosure 文字はクォートされた文字列の中で2回連続させることで常にエスケープでき、パース結果では単一の enclosure 文字になります。 escape 文字の動作は異なります: 入力中に escape と enclosure 文字の並びが出現した場合、パース結果には両方の文字がそのまま残ります。よって、デフォルトのパラメータの場合、 "a""b","c\"d" のような CSV の行はそれぞれ a"b と c\"d にパースされます。

警告
PHP 8.4.0 以降では、escape のデフォルト値に依存することは非推奨となりました。位置指定の引数か、名前付き引数を使用して明示的に指定する必要があります。

警告

escape が空の文字列("")以外に設定されているとき、 » RFC 4180 に準拠しない CSV が生成されたり、PHP の CSV 関数を介してラウンドトリップ(往復変換)でデータが壊れる可能性があります。 escapeのデフォルト値は"\\" なので、明示的に空の文字列を指定することを推奨します。デフォルト値は、PHP 9.0 以降の将来のバージョンで変更予定です。

戻り値

値を返しません。

エラー / 例外

separator または enclosure が 1 バイト長ではない場合、ValueError をスローします。

escape が 1 バイト長、または空文字列ではない場合、 ValueError をスローします。

変更履歴

バージョン	説明
8.4.0	`escape` のデフォルト値に依存することは、非推奨になりました。
7.4.0	`escape` パラメータは空文字列を受け入れるようになりました。この場合、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。

例

例1 SplFileObject::setCsvControl の例

<?php
$file = new SplFileObject("data.csv");
$file->setFlags(SplFileObject::READ_CSV);
$file->setCsvControl('|');
foreach ($file as $row) {
    list ($fruit, $quantity) = $row;
    // Do something with values
}
?>

data.csv の内容

<?php
apples|20
bananas|14
cherries|87
?>

参考

SplFileObject::getCsvControl
SplFileObject::fgetcsv
SplFileObject::fputcsv
fputcsv
fgetcsv
str_getcsv