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

Copy
1<?php
2
3/**
4 * http_build_query と json_encode の使い分けを示すサンプル.
5 */
6function demonstrateQueryBuilderVsJsonEncoder(): void
7{
8    $data = [
9        'name' => '太郎',
10        'age' => 30,
11        'city' => '東京',
12        'skills' => ['PHP', 'JavaScript', 'MySQL']
13    ];
14
15    // http_build_query を使用して URL エンコードされた文字列を生成
16    $query = http_build_query($data);
17    echo "http_build_query: " . $query . PHP_EOL;
18
19    // URLのskillsパラメータを展開して表現
20    $query_expanded = http_build_query($data, '', '&', PHP_QUERY_RFC3986);
21    echo "http_build_query (RFC3986): " . $query_expanded . PHP_EOL;
22
23    // json_encode を使用して JSON 文字列を生成
24    $json = json_encode($data, JSON_UNESCAPED_UNICODE);
25    echo "json_encode: " . $json . PHP_EOL;
26
27    // json_encodeされたデータをデコード
28    $decoded_json = json_decode($json, true);
29    echo "json_decode: " . PHP_EOL;
30    print_r($decoded_json);
31}
32
33demonstrateQueryBuilderVsJsonEncoder();

http_build_query関数は、PHPで配列やオブジェクトをURLエンコードされたクエリ文字列に変換するために使用されます。この関数は、Web APIへのリクエストやURLパラメータの作成に役立ちます。第一引数$dataには、変換したい配列またはオブジェクトを指定します。第二引数$numeric_prefixは、数値キーを持つ要素のプレフィックスを指定する場合に使用します。第三引数$arg_separatorは、引数を区切る文字を指定します。デフォルトは&です。第四引数$encoding_typeは、エンコードタイプを指定します。PHP_QUERY_RFC1738（デフォルト）またはPHP_QUERY_RFC3986を指定できます。

このサンプルコードでは、http_build_queryとjson_encodeの使い分けを示しています。http_build_queryは、連想配列をURLエンコードされた文字列に変換します。一方、json_encodeは、配列をJSON形式の文字列に変換します。json_encodeを使用すると、複雑なデータ構造を表現できます。また、JSON_UNESCAPED_UNICODEオプションを使用することで、日本語などのUnicode文字をエスケープせずにJSON文字列に含めることができます。json_decode関数は、JSON形式の文字列をPHPの配列に変換します。 http_build_query関数を使用することで、URLに含めるパラメータを簡単に生成できます。

Copy
1<?php
2
3/**
4 * 配列をクエリ文字列に変換し、それを元の配列に戻す例
5 */
6
7// 元の配列データ
8$data = [
9    'name' => 'John Doe',
10    'age' => 30,
11    'city' => 'New York'
12];
13
14// http_build_query() を使用してクエリ文字列を生成
15$query_string = http_build_query($data);
16
17echo "生成されたクエリ文字列: " . $query_string . PHP_EOL;
18
19// parse_str() を使用してクエリ文字列を配列に戻す
20parse_str($query_string, $result);
21
22echo "parse_str() で配列に戻した結果:". PHP_EOL;
23print_r($result);
24
25// オブジェクトの場合
26$object = (object) [
27    'name' => 'Jane Doe',
28    'age' => 25,
29    'city' => 'Los Angeles'
30];
31
32$query_string_from_object = http_build_query($object);
33
34echo "オブジェクトから生成されたクエリ文字列: " . $query_string_from_object . PHP_EOL;
35
36parse_str($query_string_from_object, $result_from_object);
37
38echo "parse_str() でオブジェクトから配列に戻した結果:". PHP_EOL;
39print_r($result_from_object);

http_build_query関数は、PHPのextensionで提供される関数の一つで、配列やオブジェクトをURLエンコードされたクエリ文字列に変換するために使用します。引数$dataに変換したい配列またはオブジェクトを渡します。$numeric_prefixは、数値キーを持つ配列要素のキーの前に付加するプレフィックスを指定します（省略可）。$arg_separatorは、引数セパレータを指定します（省略可、デフォルトは &）。$encoding_typeは、URLエンコードのタイプを指定します（省略可、デフォルトは PHP_QUERY_RFC1738）。

このサンプルコードでは、まず連想配列$dataをhttp_build_query()関数を使ってクエリ文字列に変換しています。生成されたクエリ文字列はname=John+Doe&age=30&city=New+Yorkのようになります。

次に、parse_str()関数を使って、生成されたクエリ文字列を元の配列に戻しています。parse_str()関数は、クエリ文字列を解析し、結果を配列に格納します。

同様に、オブジェクトをhttp_build_query()関数に渡してクエリ文字列を生成し、parse_str()関数で配列に戻す例も示しています。このように、http_build_query関数は配列だけでなくオブジェクトも処理できます。

http_build_query関数の戻り値は、生成されたクエリ文字列です。この関数とparse_str関数を組み合わせることで、配列とクエリ文字列を相互に変換することが可能です。これは、GETリクエストの作成や、セッションデータの保存など、様々な場面で役立ちます。