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

Copy
1<?php
2
3/**
4 * クエリ文字列をパースし、特定の値をboolean型に変換して返します。
5 *
6 * 'true', '1', 'on', 'yes' などの文字列は true に、
7 * 'false', '0', 'off', 'no', '' (空文字列) などの文字列は false に変換されます。
8 * それ以外の文字列は元の値を保持します。
9 *
10 * @param string $queryString パースするクエリ文字列。例: "key1=value1&key2=true"
11 * @return array パースおよびboolean変換された連想配列。
12 */
13function parseQueryStringWithBooleans(string $queryString): array
14{
15    $parsedData = [];
16
17    // parse_str 関数を使用して、クエリ文字列を連想配列にパースします。
18    // 第2引数は参照渡しで、パース結果がこの配列に格納されます。
19    parse_str($queryString, $parsedData);
20
21    $processedData = [];
22    foreach ($parsedData as $key => $value) {
23        // filter_var 関数と FILTER_VALIDATE_BOOLEAN を使用して、
24        // 文字列をboolean型に変換します。
25        // FILTER_NULL_ON_FAILURE フラグは、booleanとして解釈できない場合に
26        // null を返すように指定します。
27        $filteredValue = filter_var($value, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
28
29        // filter_var が null を返した場合（booleanとして解釈できなかった場合）は、
30        // 元の文字列値を保持します。
31        if ($filteredValue === null) {
32            $processedData[$key] = $value;
33        } else {
34            // booleanとして解釈できた場合は、変換されたboolean値を格納します。
35            $processedData[$key] = $filteredValue;
36        }
37    }
38
39    return $processedData;
40}
41
42// --- 使用例 ---
43
44// サンプルクエリ文字列
45$sampleQueryString = 'name=Alice&isAdmin=true&isActive=1&hasBetaAccess=false&isTestUser=0&age=25&status=active';
46
47echo "--- 元のクエリ文字列 ---\n";
48echo $sampleQueryString . "\n\n";
49
50// 関数を呼び出してパースおよびboolean変換を実行
51$result = parseQueryStringWithBooleans($sampleQueryString);
52
53echo "--- パースおよびboolean変換後のデータ ---\n";
54print_r($result);
55
56// 別の使用例
57$anotherQueryString = 'debugMode=1&enableLogging=on&disableNotifications=off&isValid=true';
58echo "\n--- 別のクエリ文字列の例 ---\n";
59print_r(parseQueryStringWithBooleans($anotherQueryString));
60
61?>

このPHPコードは、ウェブアプリケーションでよく使われるクエリ文字列（例: key1=value1&key2=true）を扱いやすい連想配列に変換し、さらに特定の文字列値を自動的に真偽値（boolean）に変換するparseQueryStringWithBooleans関数を定義しています。

まず、parse_str関数について説明します。これはPHPの組み込み関数で、HTTPのクエリ文字列のようなフォーマットの文字列をパースし、指定された配列に格納します。引数は二つあり、一つ目はパース対象のstring型のクエリ文字列、二つ目はパース結果が代入される参照渡しのarray型の変数です。この関数自体はvoidを返すため、直接戻り値を受け取るのではなく、第二引数に渡した配列が更新されます。

サンプルコード内のparseQueryStringWithBooleans関数では、parse_strで文字列を連想配列に変換した後、各要素をループ処理しています。この際、filter_var関数とFILTER_VALIDATE_BOOLEANフラグを使用しています。これにより、'true', '1', 'on', 'yes'といった文字列はtrueに、'false', '0', 'off', 'no', '' (空文字列) はfalseに変換されます。FILTER_NULL_ON_FAILUREフラグを併用することで、booleanとして解釈できない文字列の場合はnullを返すようにしています。もしnullが返ってきた場合は元の文字列値をそのまま保持し、そうでない場合は変換されたboolean値を結果の配列に格納します。

この関数を利用することで、ユーザーからの入力など、文字列として渡される可能性のある真偽値データを自動的に適切なPHPのboolean型に変換できるため、データの扱いがより直感的になり、条件分岐などのコードを簡潔に記述できるようになります。

Copy
1<?php
2
3/**
4 * URLクエリ形式の文字列から日付と時刻を抽出し、DateTimeオブジェクトに変換します。
5 *
6 * parse_str関数を使用して文字列を連想配列にパースし、
7 * そこから日付と時刻の情報を結合してDateTimeオブジェクトを作成します。
8 *
9 * @param string $queryString パースするURLクエリ形式の文字列 (例: "date=2023-10-27&time=15:30:00")
10 * @param string $timezone    DateTimeオブジェクトに設定するタイムゾーン (デフォルトは 'UTC')
11 * @return DateTime|null 正常にパースおよび変換できた場合はDateTimeオブジェクト、失敗した場合はnull
12 */
13function parseQueryStringToDateTime(string $queryString, string $timezone = 'UTC'): ?DateTime
14{
15    // parse_str関数を使って、クエリ文字列を連想配列にパースします。
16    // 第2引数に&$result配列を渡すことで、パース結果がその配列に格納されます。
17    $params = [];
18    parse_str($queryString, $params);
19
20    // パースされた配列から日付と時刻の要素をチェックします。
21    // "date"と"time"キーが存在し、かつ文字列であることを期待します。
22    if (!isset($params['date']) || !is_string($params['date'])) {
23        // 日付情報が見つからない、または形式が不正な場合はnullを返します。
24        return null;
25    }
26    if (!isset($params['time']) || !is_string($params['time'])) {
27        // 時刻情報が見つからない、または形式が不正な場合はnullを返します。
28        return null;
29    }
30
31    // 日付と時刻の文字列を結合して、完全な日時文字列を作成します。
32    $dateTimeString = $params['date'] . ' ' . $params['time'];
33
34    try {
35        // 指定されたタイムゾーンでDateTimeZoneオブジェクトを作成します。
36        $dateTimeZone = new DateTimeZone($timezone);
37        // 日時文字列とタイムゾーンを使用してDateTimeオブジェクトを作成します。
38        $dateTime = new DateTime($dateTimeString, $dateTimeZone);
39        return $dateTime;
40    } catch (Exception $e) {
41        // DateTimeオブジェクトの作成中にエラーが発生した場合（例: 不正な日時文字列）、
42        // エラーを捕捉し、nullを返します。
43        return null;
44    }
45}
46
47// --- 使用例 ---
48
49// サンプルのクエリ文字列 (日付と時刻、その他の情報を含む)
50$query = "date=2023-10-27&time=15:30:00&event=php_meetup";
51
52// クエリ文字列から日付時刻をパースし、日本時間で取得します。
53$parsedDateTime = parseQueryStringToDateTime($query, 'Asia/Tokyo');
54
55if ($parsedDateTime) {
56    echo "成功: パースされた日時: " . $parsedDateTime->format('Y-m-d H:i:s T') . PHP_EOL;
57} else {
58    echo "失敗: 日付のパースに失敗しました (クエリ: {$query})" . PHP_EOL;
59}
60
61echo PHP_EOL; // 空行で区切り
62
63// 日付形式が不正な場合の例
64$invalidDateQuery = "date=invalid-date&time=10:00:00";
65$parsedInvalidDate = parseQueryStringToDateTime($invalidDateQuery);
66
67if ($parsedInvalidDate) {
68    echo "成功: パースされた日時: " . $parsedInvalidDate->format('Y-m-d H:i:s T') . PHP_EOL;
69} else {
70    echo "失敗: 日付のパースに失敗しました (クエリ: {$invalidDateQuery})" . PHP_EOL;
71}
72
73echo PHP_EOL; // 空行で区切り
74
75// タイムゾーンを指定しない場合の例 (デフォルトの 'UTC' が使用される)
76$utcQuery = "date=2024-01-01&time=09:00:00";
77$parsedUtcDateTime = parseQueryStringToDateTime($utcQuery);
78
79if ($parsedUtcDateTime) {
80    echo "成功: パースされた日時 (UTC): " . $parsedUtcDateTime->format('Y-m-d H:i:s T') . PHP_EOL;
81} else {
82    echo "失敗: 日付のパースに失敗しました (クエリ: {$utcQuery})" . PHP_EOL;
83}
84
85?>

PHPのparse_str関数は、URLのクエリ文字列のような形式で記述された文字列を、連想配列に変換するために使用されます。このサンプルコードでは、parse_str関数を活用し、"date=2023-10-27&time=15:30:00"のような文字列から日付と時刻の情報を抽出し、PHPのDateTimeオブジェクトに変換するparseQueryStringToDateTimeというカスタム関数を定義しています。

parse_str関数は、最初の引数$stringに解析したいクエリ文字列を渡します。そして、2番目の引数&$resultには、解析結果が格納される空の配列などを参照渡しで指定します。parse_str関数は値を直接返さず（戻り値はvoid）、指定された&$result配列にキーと値のペアをセットします。

parseQueryStringToDateTime関数内では、まずparse_strで入力文字列を$paramsという配列に変換し、そこから'date'と'time'のキーに対応する値を取り出します。これらの値が存在し、かつ有効な文字列であることを確認した後、結合して完全な日時文字列を作成します。その後、指定されたタイムゾーンでDateTimeオブジェクトの生成を試みます。もし日付や時刻の情報が不足していたり、DateTimeオブジェクトの生成中にエラーが発生したりした場合は、try-catchブロックで捕捉し、安全にnullを返すことで処理の失敗を示します。これにより、URLクエリ文字列から安全かつ柔軟に日付時刻情報を扱うことができます。

Copy
1<?php
2
3/**
4 * 文字列をパースして、float型に変換可能な場合は変換するサンプル
5 *
6 * @param string $str パースする文字列
7 * @return array パース結果の配列
8 */
9function parseStringAndConvertToFloat(string $str): array
10{
11  $result = [];
12  parse_str($str, $result);
13
14  foreach ($result as $key => $value) {
15    if (is_numeric($value)) {
16      $floatValue = floatval($value);
17      if (strval($floatValue) === $value) { // floatに変換しても値が変わらないか確認
18        $result[$key] = $floatValue;
19      }
20    }
21  }
22
23  return $result;
24}
25
26// テスト
27$string = "a=1.23&b=456&c=hello&d=7.89e2";
28$parsedArray = parseStringAndConvertToFloat($string);
29
30print_r($parsedArray);
31
32?>

parse_str関数は、PHPでURLエンコードされたクエリ文字列をパースし、変数とその値を配列に格納するために使用されます。このサンプルコードでは、parseStringAndConvertToFloat関数を定義し、入力された文字列をparse_strでパースした後、配列内の値をチェックし、数値として解釈できる場合はfloat型に変換しています。

parse_str関数の第一引数$stringは、パース対象の文字列です。第二引数$resultは、パース結果を格納する配列への参照渡しです。parse_str関数自体は戻り値を持ちません。

サンプルコードでは、is_numeric関数で数値かどうかを判定し、floatval関数でfloat型に変換しています。さらに、変換後の値を文字列に戻し、元の値と比較することで、本当にfloat型として適切に表現できるかを確認しています。例えば、整数や小数点を含む文字列がfloat型に変換されます。変換できない文字列（"hello"など）はそのまま文字列として配列に残ります。

この処理により、parse_strでパースされた配列内の数値文字列が、必要に応じてfloat型に変換された配列を得ることができます。print_r関数で結果を表示すると、キーと値のペアが出力されます。aは1.23、bは456、cはhello、dは789というように、文字列がパースされ、数値として解釈可能なものはfloat型に変換されていることが確認できます。

Copy
1<?php
2
3/**
4 * parse_str() を使用して、文字列を数値に変換して配列に格納する例
5 */
6
7$str = "a=1&b=2&c=3";
8
9// 結果を格納する配列
10$result = [];
11
12// parse_str() を使用して文字列を解析し、結果を配列に格納
13parse_str($str, $result);
14
15// 結果を出力
16print_r($result);
17
18// 各要素が数値として扱えるか確認
19foreach ($result as $key => $value) {
20  if (is_numeric($value)) {
21    $result[$key] = (int)$value; // または (float)$value で浮動小数点数に変換
22  }
23}
24
25// 数値に変換された配列を出力
26print_r($result);
27
28?>

PHPのparse_str()関数は、URLエンコードされたクエリ文字列を解析し、その結果を変数に格納するために使用されます。この関数はstring型の引数 $string を受け取り、解析対象の文字列を指定します。また、オプションで array 型の引数 $result を参照渡しで指定することで、解析結果を格納する配列を指定できます。parse_str()関数自体の戻り値は void で、直接値を返すのではなく、$result に指定された配列の内容を更新します。

サンプルコードでは、まずURLエンコードされた文字列 $str = "a=1&b=2&c=3"; を用意し、空の配列 $result = []; を作成します。parse_str($str, $result); を実行すると、$str の内容が解析され、キー (a, b, c) と値 (1, 2, 3) のペアが $result 配列に格納されます。初期状態では、配列の値はすべて文字列として扱われます。

次に、foreach ループを使用して $result 配列の各要素を調べ、is_numeric() 関数で値が数値として解釈できるかどうかを確認します。数値として解釈できる場合、(int)$value または (float)$value を使用して、それぞれの値を整数または浮動小数点数に明示的に型変換し、$result 配列内の値を更新します。これにより、文字列として格納されていた数値が、実際に数値として扱えるようになります。最後に、変換後の $result 配列の内容を print_r() 関数で出力し、結果を確認します。