【PHP8.x】PHP_QUERY_RFC1738定数の使い方

Copy
1<?php
2
3/**
4 * PHP_QUERY_RFC1738 定数を使用して、URLクエリ文字列をエンコードする例を示します。
5 *
6 * この定数は、http_build_query() 関数で使用され、URLエンコードの方式を指定します。
7 * PHP_QUERY_RFC1738 を指定すると、スペースが '+' 記号にエンコードされます。
8 * これは古い標準であり、現代のウェブアプリケーションでは PHP_QUERY_RFC3986 (デフォルト) が推奨されますが、
9 * 特定のレガシーシステムとの互換性が必要な場合に使用されることがあります。
10 */
11function demonstrateRfc1738QueryEncoding(): void
12{
13    // クエリパラメータとして使用する連想配列を準備します。
14    // スペースを含む値や特殊文字を含めてテストします。
15    $params = [
16        'name' => '山田 太郎',
17        'query' => 'PHP & Web Development',
18        'id' => 123,
19    ];
20
21    echo "--- RFC 1738 形式でのURLクエリエンコード ---" . PHP_EOL;
22
23    // http_build_query() 関数に PHP_QUERY_RFC1738 定数を渡し、
24    // RFC 1738 形式でクエリ文字列を構築します。
25    // この形式では、スペース (' ') が '+' にエンコードされます。
26    // また、'&' や '=' などの特殊文字もエンコードされます。
27    $queryStringRfc1738 = http_build_query($params, '', '&', PHP_QUERY_RFC1738);
28
29    echo "元のパラメータ配列:" . PHP_EOL;
30    print_r($params);
31    echo "PHP_QUERY_RFC1738 でエンコードされたクエリ文字列:" . PHP_EOL;
32    echo $queryStringRfc1738 . PHP_EOL . PHP_EOL;
33    echo "  (注: スペースが '+' に、'&' が '%26' にエンコードされています。)" . PHP_EOL;
34
35    echo "--- 比較: PHP_QUERY_RFC3986 形式 (PHPのデフォルト) ---" . PHP_EOL;
36
37    // 比較のために、PHP_QUERY_RFC3986 形式 (現代の標準、PHPのデフォルト) でエンコードします。
38    // この形式では、スペース (' ') が '%20' にエンコードされます。
39    $queryStringRfc3986 = http_build_query($params, '', '&', PHP_QUERY_RFC3986);
40
41    echo "PHP_QUERY_RFC3986 でエンコードされたクエリ文字列:" . PHP_EOL;
42    echo $queryStringRfc3986 . PHP_EOL . PHP_EOL;
43    echo "  (注: スペースが '%20' に、'&' が '%26' にエンコードされています。)" . PHP_EOL;
44
45    echo "--- どちらを使うべきか？ ---" . PHP_EOL;
46    echo "特別な理由がない限り、現代のWeb標準である RFC 3986 ('%20' エンコード) の使用が推奨されます。" . PHP_EOL;
47    echo "PHP_QUERY_RFC1738 は、古いシステムとの互換性が必要な場合にのみ検討してください。" . PHP_EOL;
48}
49
50// 関数を実行して、エンコード結果を出力します。
51demonstrateRfc1738QueryEncoding();

PHP_QUERY_RFC1738は、PHPでURLのクエリ文字列をエンコードする際に使用する特別な定数です。この定数自体に引数はなく、内部的に整数値（int）を保持していますが、その値を直接利用するのではなく、主にhttp_build_query()関数などの引数として渡すことで、URLエンコードの挙動を指定します。

具体的には、この定数を指定すると、URLエンコードの方式として「RFC 1738」形式が適用されます。この形式の最大の特徴は、クエリ文字列内のスペース（空白文字）が「+」記号に変換される点です。サンプルコードでは、この定数を使って連想配列をクエリ文字列に変換し、スペースが「+」にエンコードされる様子を示しています。

現代のWeb開発においては、スペースを「%20」にエンコードする「RFC 3986」形式（PHP_QUERY_RFC3986定数で指定、これがhttp_build_query()関数のデフォルト動作です）が一般的に推奨されています。そのため、PHP_QUERY_RFC1738は、主に古いシステムや特定のレガシーなWebサービスとの互換性を保つ必要がある場合にのみ検討すべき定数です。特別な理由がない限り、初心者のシステムエンジニアの方は、より新しい標準であるデフォルトのエンコード形式を利用することをお勧めします。サンプルコードは、両方のエンコード形式を比較して、その違いを明確に理解するのに役立ちます。

Copy
1<?php
2
3/**
4 * PHP_QUERY_RFC1738定数を使用してURLクエリ文字列を生成するサンプルコード。
5 *
6 * この定数は、http_build_query() 関数などでURLエンコードの際のスペースの扱いを指定します。
7 * PHP_QUERY_RFC1738 を指定すると、スペースが '+' 記号にエンコードされます。
8 * これはRFC 1738に準拠しており、主に古いシステムとの互換性が必要な場合に使用されます。
9 */
10function createRfc1738QueryStringExample(): void
11{
12    echo "--- PHP_QUERY_RFC1738定数の使用例 ---\n\n";
13
14    // URLクエリパラメータとして使用するデータを定義
15    $params = [
16        'name' => 'John Doe',         // スペースを含む文字列
17        'city' => 'New York',
18        'item' => 'pen & paper',      // 特殊文字を含む文字列
19        'id' => 123,
20    ];
21
22    echo "元のデータ:\n";
23    print_r($params);
24    echo "\n";
25
26    // http_build_query() 関数を使ってクエリ文字列を生成
27    // PHP_QUERY_RFC1738 を 'encoding_type' 引数に指定することで、
28    // スペースが '+' にエンコードされるようになります。
29    // (例: "John Doe" -> "John+Doe")
30    $queryStringRfc1738 = http_build_query($params, '', '&', PHP_QUERY_RFC1738);
31
32    echo "PHP_QUERY_RFC1738 を使用してエンコードされたクエリ文字列:\n";
33    echo $queryStringRfc1738 . "\n\n";
34
35    echo "--- 比較: PHPのデフォルト (RFC 3986) でのエンコード ---\n\n";
36
37    // 比較のために、PHPのデフォルト（RFC 3986）でエンコードしたクエリ文字列も生成します。
38    // デフォルトでは、スペースは '%20' にエンコードされます。
39    // (例: "John Doe" -> "John%20Doe")
40    $queryStringDefault = http_build_query($params);
41
42    echo "デフォルト (RFC 3986) でエンコードされたクエリ文字列:\n";
43    echo $queryStringDefault . "\n\n";
44
45    echo "違いに注目してください：\n";
46    echo "- PHP_QUERY_RFC1738: スペースが '+' になります。\n";
47    echo "- デフォルト (RFC 3986): スペースが '%20' になります。\n";
48}
49
50// 関数を実行してサンプルコードの動作を確認
51createRfc1738QueryStringExample();
52

PHP_QUERY_RFC1738は、PHP 8で利用できる定数で、主にURLのクエリ文字列を生成する際に、スペース文字のエンコード方法を指定するために使用されます。この定数自体は引数を持ちませんが、内部的には整数値（int）として定義されています。

このサンプルコードは、PHP_QUERY_RFC1738定数を使ってURLクエリ文字列を生成する例を示しています。http_build_query()関数は、配列からURLエンコードされたクエリ文字列を生成する関数ですが、その第4引数であるencoding_typeにPHP_QUERY_RFC1738を指定することで、クエリ文字列内のスペースが+記号に変換されます。これは、RFC 1738というインターネット標準の仕様に基づいており、主に古いシステムとの互換性が必要な場合に利用されます。

例えば、nameがJohn Doeというデータは、PHP_QUERY_RFC1738を使用するとname=John+Doeのようにエンコードされます。

比較として、PHPのデフォルトのエンコード方法（RFC 3986に準拠）も示されています。デフォルトでは、スペースは%20としてエンコードされますので、同じデータはname=John%20Doeとなります。

このように、PHP_QUERY_RFC1738定数を活用することで、URLクエリ文字列におけるスペースのエンコード形式を細かく制御し、特定の要件やシステムに合わせて柔軟に対応することが可能になります。