(PHP 5 >= 5.2.0, PHP 7, PHP 8)
SplFileObject::setCsvControl — CSV の区切り文字、囲み文字、エスケープ文字をセットする
$separator = ",", string $enclosure = "\"", string $escape = "\\"): voidCSV フィールド処理用の区切り文字と囲み文字とエスケープ文字をセットします。
separatorフィールドの区切り文字 (シングルバイト文字 1 文字のみ)。
enclosureフィールドの囲み文字 (シングルバイト文字 1 文字のみ)。
escape
フィールドのエスケープ文字 (シングルバイト文字 最大で1文字)。
空文字列("")を指定すると、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。
escape
が空の文字列("")以外に設定されているとき、
» RFC 4180
に準拠しない CSV が生成されたり、PHP の CSV
関数を介してラウンドトリップ(往復変換)でデータが壊れる可能性があります。
escapeのデフォルト値は"\\"
なので、明示的に空の文字列を指定することを推奨します。デフォルト値は、PHP 9.0
以降の将来のバージョンで変更予定です。
値を返しません。
| バージョン | 説明 |
|---|---|
| 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 ?>