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

Copy
1<?php
2
3/**
4 * JSONオブジェクトをPHPの連想配列としてデコードするサンプル。
5 *
6 * `JSON_OBJECT_AS_ARRAY` は、PHPのJSON拡張において、
7 * JSONオブジェクトが連想配列として扱われる概念を指します。
8 * PHPの `json_decode()` 関数では、第二引数に `true` を渡すことで、
9 * この挙動を実現できます。
10 *
11 * @param string $jsonString デコードするJSON文字列。
12 * @return array デコードされた連想配列。
13 * @throws RuntimeException JSONデコードエラーが発生した場合。
14 */
15function decodeJsonObjectsAsAssociativeArrays(string $jsonString): array
16{
17    // `json_decode()` の第二引数に `true` を指定することで、
18    // JSONオブジェクトがPHPの連想配列としてデコードされます。
19    $decodedData = json_decode($jsonString, true);
20
21    // JSONデコード中にエラーが発生したかを確認
22    if (json_last_error() !== JSON_ERROR_NONE) {
23        throw new RuntimeException("JSONデコードエラー: " . json_last_error_msg());
24    }
25
26    // デコード結果が期待通り配列であるかを確認 (トップレベルがJSONオブジェクト/配列の場合)
27    if (!is_array($decodedData)) {
28        throw new RuntimeException("デコード結果が期待される配列ではありません。");
29    }
30
31    return $decodedData;
32}
33
34// サンプルJSON文字列 (JSONオブジェクト)
35$jsonInput = '{"id": 101, "name": "PHP Expert", "version": 8, "details": {"type": "language", "release_year": 2020}}';
36
37try {
38    // 関数を呼び出してJSONを連想配列としてデコード
39    $parsedData = decodeJsonObjectsAsAssociativeArrays($jsonInput);
40
41    echo "--- 元のJSON文字列 ---\n";
42    echo $jsonInput . "\n\n";
43
44    echo "--- PHPの連想配列としてデコードされたデータ ---\n";
45    print_r($parsedData);
46
47    echo "\n--- 連想配列としてデータにアクセス ---\n";
48    echo "ID: " . $parsedData['id'] . "\n";
49    echo "名前: " . $parsedData['name'] . "\n";
50    echo "バージョン: " . $parsedData['version'] . "\n";
51    echo "詳細タイプ: " . $parsedData['details']['type'] . "\n";
52    echo "リリース年: " . $parsedData['details']['release_year'] . "\n";
53
54} catch (RuntimeException $e) {
55    echo "エラーが発生しました: " . $e->getMessage() . "\n";
56}

このPHPのサンプルコードは、JSON形式の文字列をPHPプログラムで扱いやすい「連想配列」に変換する方法を示しています。JSON_OBJECT_AS_ARRAYという概念は、JSONオブジェクトをPHPの連想配列として扱うことを指し、この動作はjson_decode()関数の第二引数にtrueを指定することで実現されます。

サンプルコード内のdecodeJsonObjectsAsAssociativeArrays関数は、引数としてデコードしたいJSON形式の文字列を受け取ります。この関数は、指定されたJSON文字列をPHPの連想配列に変換し、その結果を戻り値として返します。変換されたデータは、$parsedData['キー名']のように、PHPの連想配列として直接アクセスし、利用することができます。

また、JSONデコード中にエラーが発生した場合に備え、json_last_error()関数でエラーの有無を確認し、問題があればエラーメッセージを表示する堅牢なエラーハンドリングも含まれています。このコードは、ウェブアプリケーションなどで外部APIからJSONデータを受け取り、PHPで処理する際の基本的なパターンとして非常に役立ちます。

Copy
1<?php
2
3/**
4 * JSON_OBJECT_AS_ARRAY 定数の使用例を示すサンプルコード。
5 *
6 * この定数を json_decode() 関数のオプションとして使用することで、
7 * JSONオブジェクトを PHP の連想配列としてデコードできます。
8 * デフォルトの挙動と比較することで、定数の効果を理解しやすくなります。
9 */
10
11// サンプルとして使用するJSON形式の文字列
12$jsonString = '{"item_id": 101, "item_name": "USB Drive", "price": 15.99, "available": true}';
13
14echo "--- JSONオブジェクトをデフォルトでデコードした場合 (stdClass オブジェクト) ---\n";
15// json_decode() の第2引数（オプション）を省略するか false を指定した場合、
16// JSONオブジェクトはPHPの stdClass オブジェクトとしてデコードされます。
17$decodedAsObject = json_decode($jsonString);
18
19// デコード結果の型と構造を確認します。
20echo "デコード後の型: " . gettype($decodedAsObject) . "\n";
21var_dump($decodedAsObject);
22
23// オブジェクトのプロパティには「->」演算子でアクセスします。
24if (is_object($decodedAsObject)) {
25    echo "デフォルトでのアクセス例 (オブジェクト): 商品名: " . $decodedAsObject->item_name . "\n\n";
26}
27
28
29echo "--- JSON_OBJECT_AS_ARRAY 定数を使用して連想配列としてデコードした場合 ---\n";
30// json_decode() の第2引数に JSON_OBJECT_AS_ARRAY 定数を指定すると、
31// JSONオブジェクトがPHPの連想配列としてデコードされます。
32$decodedAsArray = json_decode($jsonString, JSON_OBJECT_AS_ARRAY);
33
34// デコード結果の型と構造を確認します。
35echo "デコード後の型: " . gettype($decodedAsArray) . "\n";
36var_dump($decodedAsArray);
37
38// 連想配列の要素には「[]」を使ってアクセスします。
39if (is_array($decodedAsArray)) {
40    echo "配列でのアクセス例 (連想配列): 商品名: " . $decodedAsArray['item_name'] . "\n\n";
41}
42
43?>

PHP 8で利用できるJSON_OBJECT_AS_ARRAYは、JSON形式の文字列をPHPのデータ構造に変換するjson_decode()関数の動作を制御する定数です。この定数自体に引数や戻り値はありませんが、json_decode()関数の第2引数として利用することで、そのデコード挙動に影響を与えます。

json_decode()関数は、JSONオブジェクトをデフォルトではPHPの標準クラスであるstdClassのオブジェクトとしてデコードします。この場合、デコードされたデータには$オブジェクト->プロパティ名のように「->」演算子を使ってアクセスします。

一方、json_decode()関数の第2引数にJSON_OBJECT_AS_ARRAY定数を指定すると、JSONオブジェクトはPHPの連想配列としてデコードされます。この場合、デコードされたデータには$配列['キー名']のように「[]」演算子を使ってアクセスします。

サンプルコードは、この違いを明確に示しています。まず、JSON文字列を定数なしでデコードし、オブジェクトとして扱われる様子とプロパティへのアクセス方法を確認します。次に、同じJSON文字列をJSON_OBJECT_AS_ARRAY定数を使ってデコードし、連想配列として扱われる様子と要素へのアクセス方法を示しています。この定数を使用することで、JSONデータをPHPの連想配列として直接利用できるようになり、配列操作が直感的かつ容易になります。