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

Copy
1<?php
2
3/**
4 * JSON_NUMERIC_CHECK 定数の使用例を示します。
5 *
6 * この定数は json_encode() 関数のオプションとして使用され、
7 * 配列やオブジェクトの値が数値に見える文字列である場合に、
8 * それらをJSONの数値型としてエンコードするかどうかを制御します。
9 */
10function demonstrateJsonNumericCheck(): void
11{
12    // 数値に見える文字列を含むサンプルデータ
13    $data = [
14        'productId' => '12345',      // 数値に見える文字列
15        'quantity' => '100',         // 数値に見える文字列
16        'itemCode' => 'ITEM-A001',   // 数値ではない文字列
17        'price' => 29.99,
18        'active' => true,
19        'details' => [
20            'weight' => '5.5',       // 入れ子内の数値に見える文字列
21            'unit' => 'kg'
22        ]
23    ];
24
25    echo "--- JSON_NUMERIC_CHECK オプションなしの場合 ---\n";
26    // デフォルトの挙動。数値に見える文字列もそのまま文字列としてエンコードされます。
27    // JSON_PRETTY_PRINT は可読性を高めるためのオプションです。
28    $jsonWithoutNumericCheck = json_encode($data, JSON_PRETTY_PRINT);
29    if ($jsonWithoutNumericCheck === false) {
30        echo "JSON エンコードエラー: " . json_last_error_msg() . "\n";
31        return;
32    }
33    echo $jsonWithoutNumericCheck . "\n\n";
34
35    echo "--- JSON_NUMERIC_CHECK オプションありの場合 ---\n";
36    // JSON_NUMERIC_CHECK を指定すると、数値に見える文字列がJSONの数値型に変換されます。
37    // 例: "12345" => 12345, "5.5" => 5.5
38    $jsonWithNumericCheck = json_encode($data, JSON_PRETTY_PRINT | JSON_NUMERIC_CHECK);
39    if ($jsonWithNumericCheck === false) {
40        echo "JSON エンコードエラー: " . json_last_error_msg() . "\n";
41        return;
42    }
43    echo $jsonWithNumericCheck . "\n";
44}
45
46// サンプルコードを実行します。
47demonstrateJsonNumericCheck();
48

PHPのJSON_NUMERIC_CHECKは、json_encode()関数でPHPのデータ（配列やオブジェクト）をJSON形式の文字列に変換する際に使用できる定数です。この定数自体は整数値を持っており、json_encode()の第二引数（オプション）として指定することで機能が有効になります。

JSON_NUMERIC_CHECKの主な役割は、PHPのデータ内で「数値に見える文字列」がある場合に、それらをJSONの数値型としてエンコードするかどうかを制御することです。通常、json_encode()はPHPの文字列をそのままJSONの文字列として出力します。例えば、PHPの'12345'はJSONでは"12345"となります。

しかし、json_encode()にJSON_NUMERIC_CHECKオプションを指定すると、'12345'や'5.5'のように数値として解釈できる文字列は、JSONの数値型（例: 12345や5.5）に自動的に変換されます。一方、'ITEM-A001'のような数値ではない文字列は、変換されずにJSONの文字列として維持されます。この機能は、JSONデータを受け取るシステムで特定の値を数値型として扱いたい場合に、データの整合性を保ち、クライアント側での型変換の手間を省くのに役立ちます。