(PHP 5 >= 5.3.0, PHP 7, PHP 8)
str_getcsv — CSV 文字列をパースして配列に格納する
$string
,$separator
= ",",$enclosure
= "\"",$escape
= "\\"CSV 形式の文字列入力のフィールドをパースして、 読み込んだフィールドの内容を配列で返します。
注意: この関数はロケール設定を考慮します。 例えば、
LC_CTYPE
がen_US.UTF-8
の場合、 1 バイトエンコーディングでエンコードされたデータが 間違って処理されるかもしれません。
string
パースする文字列。
separator
separator
パラメータで、フィールドのデリミタを設定します。
シングルバイト文字 1 文字のみでなければなりません。
enclosure
オプションの enclosure
パラメータで、フィールド囲いこみ文字を設定します。
シングルバイト文字 1 文字のみでなければなりません。
escape
オプションの escape
パラメータで、エスケープ文字を設定します。
シングルバイト文字 1 文字のみ、または空文字列でなければなりません。
空文字列(""
) を指定すると、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構が無効になります。
注意:
enclosure
の文字は、フィールド内で2回出力される ことでエスケープされます。しかし、escape
文字はその代替として使えます。 デフォルトのパラメータの値""
と\"
は同じ意味を持ちます。enclosure
の文字をescape
文字でエスケープすることには、 特別な意味はありません。それ自身をエスケープする意味ですらありません。
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 のデフォルト値に依存することは、
非推奨になりました。
|
8.4.0 |
separator 、enclosure 、
または escape が不正な場合、
ValueError をスローするようになりました。
これは、fgetcsv() と fputcsv()
の動作に倣ったものとなります。
|
8.3.0 | 最後のフィールドが、 閉じられていないフィールド囲いこみ文字だけの場合、 null バイト 1 つの文字列ではなく、空文字列を返すようになりました。 |
7.4.0 |
escape 引数は、
空文字列を、(RFC 4180 に準拠していない) 独自仕様のエスケープ機構を無効にするシグナルとして解釈するようになりました。
これより前のバージョンでは、空文字列はデフォルト値のように扱われていました。
|
例1 str_getcsv() の例
<?php
$string = 'PHP,Java,Python,Kotlin,Swift';
$data = str_getcsv($string);
var_dump($data);
?>
上の例の出力は以下となります。
array(5) { [0]=> string(3) "PHP" [1]=> string(4) "Java" [2]=> string(6) "Python" [3]=> string(6) "Kotlin" [4]=> string(5) "Swift" }
例2 str_getcsv() に空文字列を指定した例
この関数に空文字列を指定すると、
空の配列ではなく 値 [null]
を返します。
<?php
$string = '';
$data = str_getcsv($string);
var_dump($data);
?>
上の例の出力は以下となります。
array(1) { [0]=> NULL }