【PHP8.x】str_getcsv()関数の使い方

Copy
1<?php
2
3/**
4 * 複数行のCSV文字列を解析し、行と列を表すネストされた配列に変換します。
5 * array_map関数とstr_getcsv関数を組み合わせて、各CSV行を処理します。
6 *
7 * @param string $csvString 解析するCSVデータを含む文字列。各行は改行文字で区切られている必要があります。
8 * @param string $separator フィールドを区切る文字（デフォルトはカンマ ', '）。
9 * @param string $enclosure フィールド値を囲む文字（デフォルトはダブルクォート '"'）。
10 * @param string $escape 特殊文字をエスケープするために使用される文字（デフォルトはバックスラッシュ '\'）。
11 * @return array CSVデータを行ごとにパースしたネストされた配列。各内部配列は1つのCSV行を表します。
12 */
13function parseCsvStringToArray(
14    string $csvString,
15    string $separator = ',',
16    string $enclosure = '"',
17    string $escape = '\\'
18): array {
19    // 1. 入力されたCSV文字列を改行文字 (\n) で分割し、各行を配列の要素とします。
20    //    explode関数は、指定された区切り文字で文字列を分割し、その結果を配列として返します。
21    $lines = explode("\n", $csvString);
22
23    // 2. array_map関数を使用して、分割された各行にstr_getcsv関数を適用します。
24    //    array_mapは、配列 ($lines) の各要素に対して指定されたコールバック関数を実行し、
25    //    その結果を新しい配列として返します。
26    //    str_getcsvは、1つのCSV文字列（行）を解析し、フィールドの配列として返します。
27    //    ここでは、匿名関数 (クロージャ) を使用して、str_getcsvに追加の引数（区切り文字など）を渡しています。
28    $parsedData = array_map(function (string $line) use ($separator, $enclosure, $escape): array {
29        return str_getcsv($line, $separator, $enclosure, $escape);
30    }, $lines);
31
32    // 必要に応じて、空の行（str_getcsvが['']を返す場合など）を結果から除外する処理をここに追加できます。
33    // 例: return array_filter($parsedData, fn($row) => !empty(array_filter($row)));
34
35    return $parsedData;
36}
37
38// --- サンプルコードの実行 ---
39
40// 解析するCSVデータをヒアドキュメント形式で定義します。
41// ヒアドキュメントは、複数行の文字列をPHPコード内で記述する際に便利です。
42$csvData = <<<CSV
43"Name","Age","City"
44"Alice",30,"New York"
45"Bob",24,"London"
46"Charlie",35,"Paris, France"
47"David",28,"Tokyo"
48CSV;
49
50echo "--- 元のCSVデータ ---\n";
51echo $csvData . "\n\n";
52
53// parseCsvStringToArray関数を呼び出し、CSV文字列を配列に変換します。
54$parsedArray = parseCsvStringToArray($csvData);
55
56echo "--- 解析された配列データ ---\n";
57// print_r関数は、配列の内容を人間が読みやすい形式で表示するために使用されます。
58print_r($parsedArray);
59
60echo "\n--- 特定のデータへのアクセス例 ---\n";
61// 解析された配列から特定のデータにアクセスする方法の例です。
62// 配列は0から始まるインデックスを持ちます。
63echo "ヘッダー行: " . implode(', ', $parsedArray[0]) . "\n"; // 最初の行（インデックス0）はヘッダー
64echo "2番目のユーザーの名前: " . $parsedArray[2][0] . "\n"; // 3行目（インデックス2）の最初の要素（インデックス0）
65echo "Aliceの年齢: " . $parsedArray[1][1] . "\n";     // 2行目（インデックス1）の2番目の要素（インデックス1）
66
67?>

このPHPコードは、複数行のCSV（Comma Separated Values）形式の文字列を、行と列を表すネストされた配列に変換するparseCsvStringToArray関数を提供します。CSVデータは通常、カンマなどで区切られた値が並び、改行で次の行に移る形式です。

関数parseCsvStringToArrayは、第一引数$csvStringで与えられたCSV文字列を処理します。まず、explode関数を用いて、CSV文字列を改行コード（\n）で分割し、各行を配列の要素として取得します。次に、array_map関数を利用して、分割された各行の文字列に対してstr_getcsv関数を適用します。array_mapは、配列の各要素に関数を適用し、その結果を新しい配列として返す便利な関数です。

ここで核となるstr_getcsv関数は、与えられた1行のCSV文字列を解析し、各フィールドを要素とする配列を返します。この関数は、カンマ以外の区切り文字（$separator）、ダブルクォートなどの囲み文字（$enclosure）、エスケープ文字（$escape）を引数で指定できるため、多様なCSVフォーマットに対応可能です。最終的に、parseCsvStringToArray関数は、各行がさらに配列として格納されたネストされた配列を戻り値として返します。これにより、CSVデータが行と列の構造を持つ多次元配列として扱えるようになります。サンプルコードの実行部分では、print_rで解析結果を表示し、特定の行や列のデータにアクセスする方法を示しています。

Copy
1<?php
2
3/**
4 * str_getcsv() を使って、デフォルトのカンマ(,)以外の区切り文字(delimiter)を
5 * 指定してCSV文字列を配列に変換するサンプル関数
6 *
7 * @return void
8 */
9function parseCsvWithCustomDelimiter(): void
10{
11    // セミコロン(;)を区切り文字(delimiter)として使用するCSV形式の文字列
12    $csvString = '101;Taro Yamada;Tokyo';
13
14    // str_getcsv() の第2引数に、区切り文字としてセミコロン ';' を指定します。
15    // この引数を指定しない場合、デフォルトでカンマ ',' が使われます。
16    $data = str_getcsv($csvString, ';');
17
18    // パース結果の配列を出力します
19    print_r($data);
20}
21
22// 関数を実行
23parseCsvWithCustomDelimiter();
24
25/*
26実行結果:
27
28Array
29(
30    [0] => 101
31    [1] => Taro Yamada
32    [2] => Tokyo
33)
34
35*/

str_getcsv関数は、CSV（Comma-Separated Values）形式の文字列を解析し、各フィールドを要素とする配列に変換するためのPHP関数です。

このサンプルコードでは、str_getcsv関数を使って、デフォルトの区切り文字であるカンマ(,)以外の文字で区切られたCSV文字列を処理する方法を示しています。変数 $csvString には、一般的なカンマではなくセミコロン(;)を区切り文字（デリミタ）として使用した文字列 '101;Taro Yamada;Tokyo' が格納されています。

str_getcsv関数を呼び出す際、第1引数には解析対象の文字列 $csvString を渡します。そして、重要なのが第2引数 $separator です。ここに区切り文字としてセミコロン(;)を指定することで、関数はセミコロンを基準に文字列を分割します。もしこの第2引数を省略すると、デフォルトのカンマ(,)が区切り文字として扱われます。

この関数の戻り値は、解析結果が格納された配列です。実行結果を見ると、元の文字列がセミコロンで正しく分割され、'101'、'Taro Yamada'、'Tokyo' の3つの要素を持つ配列が生成されていることが確認できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * str_getcsv 関数を使用して、CSVフィールド内に改行文字を含む文字列をパースするサンプル。
7 *
8 * str_getcsv は、ダブルクォートなどのエンクロージャーで囲まれたフィールド内の
9 * 改行文字を正しくデータの一部として扱います。
10 */
11function demonstrateStrGetCsvWithLineBreaks(): void
12{
13    // CSVフィールド内に改行文字 (\n) が含まれる文字列を定義します。
14    // この改行文字はダブルクォートで囲まれたフィールド内にあるため、
15    // str_getcsvによってデータの一部として認識されます。
16    $csvString = '"ID","商品名","複数行の説明文","価格"' . PHP_EOL .
17                 '1,"PHP入門","PHP言語の基礎から' . "\n" .
18                 '応用までを学べる\n書籍です。",1500';
19
20    // str_getcsv は一度に1行のCSV文字列しか処理できません。
21    // したがって、入力文字列をまず改行で分割する必要があります。
22    $lines = explode(PHP_EOL, $csvString);
23
24    echo "--- 入力CSV文字列 ---" . PHP_EOL;
25    echo $csvString . PHP_EOL . PHP_EOL;
26
27    echo "--- パース結果 ---" . PHP_EOL;
28    foreach ($lines as $index => $line) {
29        if (trim($line) === '') {
30            continue; // 空行はスキップ
31        }
32        echo "行 " . ($index + 1) . ": ";
33        // str_getcsv を使用して各行のCSV文字列を配列にパースします。
34        // デフォルトのセパレータ (,)、エンクロージャー (")、エスケープ文字 (\) が使用されます。
35        $parsedArray = str_getcsv($line);
36
37        print_r($parsedArray);
38
39        // 複数行の説明文フィールド（インデックス2）の内容を確認します。
40        // 改行文字が正しく保持されていることがわかります。
41        if (isset($parsedArray[2])) {
42            echo "  詳細: 3番目のフィールド（インデックス2）:" . PHP_EOL;
43            echo "    " . str_replace("\n", "\n    ", $parsedArray[2]) . PHP_EOL;
44        }
45    }
46}
47
48// 関数を実行して、サンプルコードの動作を確認します。
49demonstrateStrGetCsvWithLineBreaks();

PHP 8 の str_getcsv 関数は、CSV (Comma Separated Values) 形式の文字列を配列に変換する際に使用します。この関数は、プログラムでCSVデータを扱いやすくするために非常に役立ちます。

特に、CSVフィールド内に改行文字が含まれている場合でも、ダブルクォートなどのエンクロージャー（囲み文字）でフィールドが囲まれていれば、str_getcsvは改行文字を正しくデータの一部として認識し、そのまま保持します。これにより、複数行にわたる商品説明文なども正確にパースできます。

ただし、str_getcsvは一度に1行のCSV文字列しか処理できません。そのため、複数行からなるCSVデータ全体を処理する際には、まず入力された文字列を改行コード（PHP_EOLなど）で各行に分割し、その後、分割された各行に対してstr_getcsv関数を適用する必要があります。

引数には、解析したいCSV形式の $string を指定します。また、区切り文字 ($separator) や囲み文字 ($enclosure)、エスケープ文字 ($escape) を任意で指定できますが、多くの場合、デフォルト値で問題なく動作します。戻り値は、解析された各フィールドが要素として格納された配列 array となります。

Copy
1<?php
2
3/**
4 * str_getcsv関数の基本的な使い方を示すサンプルコード。
5 * UTF-8文字列を含むCSV形式の行を配列に変換します。
6 * システムエンジニアを目指す初心者の方にも理解しやすいよう、
7 * デフォルトの引数とカスタムの引数を使った例を示します。
8 */
9function demonstrateStrGetCsvUsage(): void
10{
11    // 1. UTF-8文字を含む標準的なCSV文字列の例
12    //    商品名に日本語、備考欄にUTF-8文字を含んでいます。
13    $csvString1 = '"商品名 (日本語)","価格",250,"備考 (UTF-8の例)"';
14    echo "--- 例 1: デフォルトの区切り文字と囲み文字 ---\n";
15    echo "元のCSV文字列: " . $csvString1 . "\n\n";
16
17    // str_getcsv関数を使って、CSV文字列を配列に変換します。
18    // デフォルトでは、カンマ (',') を区切り文字、ダブルクォート ('"') を囲み文字として認識します。
19    // UTF-8文字は正しく処理されます。
20    $dataArray1 = str_getcsv($csvString1);
21
22    echo "str_getcsv() の結果 (デフォルト引数):\n";
23    print_r($dataArray1);
24    echo "\n";
25
26    // 2. 異なる区切り文字と囲み文字を使用するCSV文字列の例
27    //    セミコロン (';') で区切られ、シングルクォート ("'") で囲まれたデータです。
28    $csvString2 = "'Item ID';'商品名 (PHP8)';'数量';'解説 (UTF-8)'";
29    echo "--- 例 2: カスタムの区切り文字と囲み文字 ---\n";
30    echo "元のCSV文字列: " . $csvString2 . "\n\n";
31
32    // str_getcsv関数に、カスタムの区切り文字と囲み文字を指定します。
33    // 第2引数で区切り文字 (separator) を、第3引数で囲み文字 (enclosure) を設定します。
34    $dataArray2 = str_getcsv($csvString2, ';', "'");
35
36    echo "str_getcsv() の結果 (セミコロン区切り、シングルクォート囲み):\n";
37    print_r($dataArray2);
38    echo "\n";
39}
40
41// 上記の関数を実行し、結果を表示します。
42demonstrateStrGetCsvUsage();
43

このPHPコードは、CSV形式の文字列を解析して配列に変換するstr_getcsv関数の使い方を説明するものです。この関数は、文字列をCSVの1行として扱い、各フィールドを要素とする配列を返します。日本語のようなUTF-8文字も正しく処理できます。

最初の例では、str_getcsv関数を最も基本的な形で使用しています。第1引数にCSV文字列を渡すだけで、デフォルトの区切り文字であるカンマ（,）と、囲み文字であるダブルクォート（"）を自動的に認識し、文字列を配列に分割します。

2つ目の例では、より柔軟な使い方を示しています。第2引数に区切り文字としてセミコロン（;）を、第3引数に囲み文字としてシングルクォート（'）を明示的に指定しています。これにより、一般的なカンマ区切り以外のデータ形式にも対応できることがわかります。

このようにstr_getcsv関数は、引数を調整することで様々な形式のCSVデータを簡単に扱うことができるため、システム開発において非常に便利な関数です。