【PHP8.x】sscanf関数の使い方

Copy
1<?php
2
3/**
4 * PHPのsscanf関数を使って文字列からデータをパースするサンプルです。
5 *
6 * sscanf関数は、指定されたフォーマット文字列に基づいて、入力文字列から値を抽出します。
7 * これは、構造化されたログデータや設定ファイルのような文字列から、
8 * 特定の情報を抽出する際に非常に役立ちます。
9 *
10 * @param string $inputString パース対象となる元の文字列。
11 * @param string $formatString 値を抽出するためのフォーマット文字列（printf/scanfスタイル）。
12 *                              例: `%d` (整数), `%s` (文字列), `%f` (浮動小数点数),
13 *                              `%[^,]` (カンマ以外の文字のシーケンス) など。
14 * @return array|null パースされた値を含む配列。パースに失敗した場合はnull。
15 */
16function demonstrateSscanfUsage(string $inputString, string $formatString): ?array
17{
18    echo "--- sscanf 実行例 ---\n";
19    echo "元の文字列: '" . $inputString . "'\n";
20    echo "フォーマット: '" . $formatString . "'\n";
21
22    // sscanf関数を使って文字列をパースします。
23    // 成功するとパースされた値の配列を返し、失敗するとnullを返します。
24    $parsedData = sscanf($inputString, $formatString);
25
26    if ($parsedData !== null) {
27        echo "パース結果:\n";
28        foreach ($parsedData as $key => $value) {
29            // 値が文字列の場合、引用符で囲んで表示し、その他の型はそのまま表示します。
30            $displayValue = is_string($value) ? "'" . $value . "'" : (string)$value;
31            echo "  [" . $key . "]: " . $displayValue . "\n";
32        }
33        return $parsedData;
34    } else {
35        echo "エラー: データパースに失敗しました。\n";
36        return null;
37    }
38}
39
40// --- sscanf の基本的な使い方 ---
41
42// 1. シンプルなログ行からのデータ抽出
43$logEntry = "USER:john_doe ID:101 STATUS:success TIME:2023-10-27_14:30:00";
44// `%s`: 文字列, `%d`: 整数
45$logFormat = "USER:%s ID:%d STATUS:%s TIME:%s";
46demonstrateSscanfUsage($logEntry, $logFormat);
47
48echo "\n"; // 区切りのための改行
49
50// 2. カンマ区切り（CSVライク）データからの抽出
51// `%[^,]`: カンマ以外のすべての文字を読み取ります。
52$csvData = "ProductA,15,9.99";
53$csvFormat = "%[^,],%d,%f"; // `%f`: 浮動小数点数
54demonstrateSscanfUsage($csvData, $csvFormat);
55
56echo "\n"; // 区切りのための改行
57
58// 3. パース失敗の例 (フォーマットと文字列が一致しない場合)
59$invalidData = "ITEM:WidgetA PRICE:100"; // 数量がない
60$invalidFormat = "ITEM:%s QUANTITY:%d PRICE:%f";
61demonstrateSscanfUsage($invalidData, $invalidFormat);
62
63?>

PHPのsscanf関数は、指定されたフォーマット文字列に基づいて、入力された文字列から特定のデータを抽出する際に使用します。これは、ログファイルや設定ファイルなど、構造化された文字列から必要な情報だけを効率的に取り出したい場合に非常に役立つ機能です。

この関数の最初の引数$stringには、解析したい元の文字列を指定します。次に$format引数には、抽出するデータのパターンを示すフォーマット文字列を渡します。このフォーマット文字列は、%d（整数）、%s（文字列）、%f（浮動小数点数）といったおなじみの形式の他に、%[^,]のように特定の文字セット以外を読み込むといった柔軟な指定も可能です。

sscanf関数は、データ抽出に成功した場合、フォーマットに従ってパースされた値を順番に格納した配列を戻り値として返します。もし、指定されたフォーマットと入力文字列が一致せず、データのパースに失敗した場合は、戻り値としてnullを返しますので、パースの成否を判断することができます。参照渡しで値を直接受け取ることもできますが、一般的には配列での取得がシンプルです。