PHP
JSON

前書き

構文

• 文字列json_encode（mixed $ value [、int $ options = 0 [、int $ depth = 512]]）
• 混合json_decode（文字列$ json [、bool $ assoc = false [、int $ depth = 512 [、int $ options = 0]]]）

パラメーター

備考

JSON文字列をデコードする

json_decode()関数はJSONでエンコードされた文字列を最初のパラメータとして取り、それをPHP変数に解析します。

通常、 json_decode()は、JSONオブジェクトの最上位項目がディクショナリである場合は\ stdClassのオブジェクトを返し、JSONオブジェクトが配列の場合はインデックス付き配列を返します 。また、スカラー値、または単純な文字列"true" 、 "false" 、 "null"などのスカラー値については、スカラー値またはNULLを戻しNULL 。また、エラー時にNULLを返しNULL 。

// Returns an object (The top level item in the JSON string is a JSON dictionary)
$json_string = '{"name": "Jeff", "age": 20, "active": true, "colors": ["red", "blue"]}';
$object = json_decode($json_string);
printf('Hello %s, You are %s years old.', $object->name, $object->age);
#> Hello Jeff, You are 20 years old.

// Returns an array (The top level item in the JSON string is a JSON array)
$json_string = '["Jeff", 20, true, ["red", "blue"]]';
$array = json_decode($json_string);
printf('Hello %s, You are %s years old.', $array[0], $array[1]);

上記でデコードしたオブジェクトの各プロパティの型と値を表示するには、 var_dump()を使用します。

// Dump our above $object to view how it was decoded
var_dump($object);

出力（変数の種類に注意してください）：

class stdClass#2 (4) {
 ["name"] => string(4) "Jeff"
 ["age"] => int(20)
 ["active"] => bool(true)
 ["colors"] =>
   array(2) {
     [0] => string(3) "red"
     [1] => string(4) "blue"
   }
}

注： JSONの変数型は、PHP同等のものに変換されました。

オブジェクトを返す代わりにJSONオブジェクトの連想配列を返すには、 json_decode() 2番目のパラメータとしてtrueを渡しtrue 。

$json_string = '{"name": "Jeff", "age": 20, "active": true, "colors": ["red", "blue"]}';
$array = json_decode($json_string, true); // Note the second parameter
var_dump($array);

出力（配列連想構造に注意してください）：

array(4) {
  ["name"] => string(4) "Jeff"
  ["age"] => int(20)
  ["active"] => bool(true)
  ["colors"] =>
  array(2) {
    [0] => string(3) "red"
    [1] => string(4) "blue"
  }
}

返される変数がオブジェクトでない場合、2番目のパラメータ（ $assoc ）は無効です。

注意： $assocパラメータを使用すると、空の配列と空のオブジェクトの区別が失われます。つまり、デコードされた出力に対してjson_encode()を実行すると、別のJSON構造になります。

json_decode()関数は、再帰的にJSON文字列が512以上の要素（ 5.2.3より前のバージョンでは20要素、バージョン5.2.3では128要素）の「深さ」を持つ場合、 NULL返しNULL 。バージョン5.3以降では、この制限は、後述するように、第3パラメータ（ $depth ）を使用して制御できます。

マニュアルによると：

PHPはオリジナルのRFC 4627で指定されているJSONのスーパーセットを実装しています。スカラー型とNULLをエンコードしてデコードします。 RFC 4627は、配列またはオブジェクトの内部にネストされている場合にのみ、これらの値をサポートします。このスーパーセットは、より新しい»RFC 7159 （RFC 4627に取って替わることを目指す）と»ECMA-404の JSONテキストの拡張された定義と一致しますが、これはRFC 4627を厳密に遵守する古いJSONパーサーとの相互運用性の問題を引き起こす可能性があります。単一のスカラー値をエンコードします。

つまり、たとえば、単純な文字列はPHPで有効なJSONオブジェクトと見なされます。

$json = json_decode('"some string"', true);
var_dump($json, json_last_error_msg());

出力：

string(11) "some string"
string(8) "No error"

しかし配列やオブジェクトではなく、単純な文字列はRFC 4627標準の一部ではありません。その結果、 JSLint 、 JSON Formatter＆Validator （RFC 4627モード）などのオンラインチェッカーでエラーが発生します。

再帰の深$depth 3番目の$depthパラメータ（デフォルト値は512 ）があります。これは、元のオブジェクトの中に入れ子にされたオブジェクトのデコード量を意味します。

4番目の$optionsパラメータが$optionsます。現在、1つの値JSON_BIGINT_AS_STRINGのみを受け入れます。デフォルトの動作（このオプションを省略）は、大きな整数を文字列の代わりに浮動小数点数にキャストすることです。

true、false、およびnullリテラルの無効でない小文字でないバリアントは、もはや有効な入力として受け入れられません。

したがって、この例：

var_dump(json_decode('tRue'), json_last_error_msg());
var_dump(json_decode('tRUe'), json_last_error_msg());
var_dump(json_decode('tRUE'), json_last_error_msg());
var_dump(json_decode('TRUe'), json_last_error_msg());
var_dump(json_decode('TRUE'), json_last_error_msg());
var_dump(json_decode('true'), json_last_error_msg());

PHP 5.6より前：

bool(true)
string(8) "No error"
bool(true)
string(8) "No error"
bool(true)
string(8) "No error"
bool(true)
string(8) "No error"
bool(true)
string(8) "No error"
bool(true)
string(8) "No error"

以降：

NULL
string(12) "Syntax error"
NULL
string(12) "Syntax error"
NULL
string(12) "Syntax error"
NULL
string(12) "Syntax error"
NULL
string(12) "Syntax error"
bool(true)
string(8) "No error"

falseとnullについても同様の動作が発生しnull 。

文字列が変換できない場合、 json_decode()はNULLを返しNULL 。

$json = "{'name': 'Jeff', 'age': 20 }" ;  // invalid json 

$person = json_decode($json);
echo $person->name;    //  Notice: Trying to get property of non-object: returns null
echo json_last_error();     
#  4 (JSON_ERROR_SYNTAX)
echo json_last_error_msg(); 
#  unexpected character 

エラーを検出するためにNULLを返すだけでは安全ではありません。たとえば、JSON文字列に"null"以外が含まれている場合、 json_decode()はエラーが発生していなくてもnullを返しnull 。

JSON文字列のエンコーディング

json_encode関数は、PHP配列（またはPHP 5.4以降、 JsonSerializableインタフェースを実装するオブジェクト）をJSONエンコード文字列に変換します。成功した場合はJSONエンコードされた文字列を返し、失敗した場合はFALSEを返します。

$array = [
    'name' => 'Jeff',
    'age' => 20,
    'active' => true,
    'colors' => ['red', 'blue'],
    'values' => [0=>'foo', 3=>'bar'],
];

エンコーディング中にPHPのデータ型文字列、整数、ブール値はJSONに相当するものに変換されます。連想配列はJSONオブジェクトとしてエンコードされます。デフォルトの引数で呼び出されると、インデックス配列はJSON配列としてエンコードされます。 （配列キーが0から始まる連続した数値シーケンスでない場合は、配列はJSONオブジェクトとしてエンコードされます）。

echo json_encode($array);

出力：

{"name":"Jeff","age":20,"active":true,"colors":["red","blue"],"values":{"0":"foo","3":"bar"}}

引数

PHP 5.3以降、 json_encodeの第2引数はビットマスクです。このビットマスクは、次のうちの1つ以上になります。

任意のビットマスクと同様に、2進のOR演算子| 。

$array = ['Joel', 23, true, ['red', 'blue']];
echo json_encode($array);
echo json_encode($array, JSON_FORCE_OBJECT);

["Joel",23,true,["red","blue"]]
{"0":"Joel","1":23,"2":true,"3":{"0":"red","1":"blue"}}

$array = ["tag"=>"<>", "amp"=>"&", "apos"=>"'", "quot"=>"\""];
echo json_encode($array);
echo json_encode($array, JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT);

{"tag":"<>","amp":"&","apos":"'","quot":"\""}
{"tag":"\u003C\u003E","amp":"\u0026","apos":"\u0027","quot":"\u0022"}

$array = ['23452', 23452];
echo json_encode($array);
echo json_encode($array, JSON_NUMERIC_CHECK);

["23452",23452]    
[23452,23452]

$array = ['a' => 1, 'b' => 2, 'c' => 3, 'd' => 4];
echo json_encode($array);
echo json_encode($array, JSON_PRETTY_PRINT);

{"a":1,"b":2,"c":3,"d":4}
{
    "a": 1,
    "b": 2,
    "c": 3,
    "d": 4
}

$array = ['filename' => 'example.txt', 'path' => '/full/path/to/file/'];
echo json_encode($array);
echo json_encode($array, JSON_UNESCAPED_SLASHES);

{"filename":"example.txt","path":"\/full\/path\/to\/file"}
{"filename":"example.txt","path":"/full/path/to/file"}

$blues = ["english"=>"blue", "norwegian"=>"blå", "german"=>"blau"];
echo json_encode($blues);
echo json_encode($blues, JSON_UNESCAPED_UNICODE);

{"english":"blue","norwegian":"bl\u00e5","german":"blau"}
{"english":"blue","norwegian":"blå","german":"blau"}

$fp = fopen("foo.txt", "r");
$array = ["file"=>$fp, "name"=>"foo.txt"];
echo json_encode($array); // no output
echo json_encode($array, JSON_PARTIAL_OUTPUT_ON_ERROR);

{"file":null,"name":"foo.txt"}

$array = [5.0, 5.5];
echo json_encode($array);
echo json_encode($array, JSON_PRESERVE_ZERO_FRACTION);

[5,5.5]
[5.0,5.5]

$array = ["line"=>"\xe2\x80\xa8", "paragraph"=>"\xe2\x80\xa9"];
echo json_encode($array, JSON_UNESCAPED_UNICODE);
echo json_encode($array, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_LINE_TERMINATORS);

{"line":"\u2028","paragraph":"\u2029"}
{"line":"
","paragraph":"
"}

JSONエラーのデバッグ

json_encodeまたはjson_decodeが指定された文字列の解析に失敗すると、 falseを返しfalse 。この問題が発生したとき、PHP自体が責任を使用するユーザーにあり、エラーや警告は発生しませんjson_last_error（）とjson_last_error_msg（）エラーが発生したかどうかを確認し、それをデバッグ（アプリケーションに応じて行動すると、エラーメッセージを表示する機能を、など）。

次の例は、JSONを操作する際の一般的なエラーを示しています（ JSON文字列のデコード/エンコードに失敗した場合など） 。

// An incorrectly formed JSON string
$jsonString = json_encode("{'Bad JSON':\xB1\x31}");

if (json_last_error() != JSON_ERROR_NONE) {
    printf("JSON Error: %s", json_last_error_msg());
}

#> JSON Error: Malformed UTF-8 characters, possibly incorrectly encoded

json_last_error_msg

json_last_error_msg()は、文字列をエンコード/デコードしようとしたときに発生した、最後に発生したエラーの人間が読めるメッセージを返します。

• エラーが発生していなくても、この関数は常に文字列を返します。
  デフォルトの非エラー文字列はNo Error
• 他の（未知の）エラーが発生した場合はfalseを返しfalse
• json_last_error_msgは各反復でオーバーライドされるため、このループでは注意が必要です。

この関数を使用して、表示するメッセージを取得し、制御ステートメントではテストしないでください。

// Don't do this:
if (json_last_error_msg()){} // always true (it's a string)
if (json_last_error_msg() != "No Error"){} // Bad practice

// Do this: (test the integer against one of the pre-defined constants)
if (json_last_error() != JSON_ERROR_NONE) {
    // Use json_last_error_msg to display the message only, (not test against it)
    printf("JSON Error: %s", json_last_error_msg());
}

この関数は、PHP 5.5より前には存在しません。ここにpolyfill実装があります：

if (!function_exists('json_last_error_msg')) {
    function json_last_error_msg() {
        static $ERRORS = array(
            JSON_ERROR_NONE => 'No error',
            JSON_ERROR_DEPTH => 'Maximum stack depth exceeded',
            JSON_ERROR_STATE_MISMATCH => 'State mismatch (invalid or malformed JSON)',
            JSON_ERROR_CTRL_CHAR => 'Control character error, possibly incorrectly encoded',
            JSON_ERROR_SYNTAX => 'Syntax error',
            JSON_ERROR_UTF8 => 'Malformed UTF-8 characters, possibly incorrectly encoded'
        );

        $error = json_last_error();
        return isset($ERRORS[$error]) ? $ERRORS[$error] : 'Unknown error';
    }
}

json_last_error

json_last_error()は、PHPが提供する定義済みの定数の1つにマップされた整数を返します。

オブジェクトでのJsonSerializableの使用

class User extends Model implements JsonSerializable {
    public $id;
    public $name;
    public $surname;
    public $username;
    public $password;
    public $email;
    public $date_created;
    public $date_edit;
    public $role;
    public $status;

    public function jsonSerialize() {
        return [
            'name' => $this->name,
            'surname' => $this->surname,
            'username' => $this->username
        ];
    }
}

public function jsonSerialize()

json_encode($User);

{"name":"John", "surname":"Doe", "username" : "TestJson"}

<?php

class User {
    // private properties only within this class
    private $id;
    private $date_created;
    private $date_edit;

    // properties used in extended classes
    protected $password;
    protected $email;
    protected $role;
    protected $status;

    // share these properties with the end user        
    public $name;
    public $surname;
    public $username;

    // jsonSerialize() not needed here
}        

$theUser = new User();

var_dump(json_encode($theUser));

string(44) "{"name":null,"surname":null,"username":null}"

ヘッダーjsonと返された応答

コンテンツタイプのヘッダーをJSONとして追加すると：

<?php
 $result = array('menu1' => 'home', 'menu2' => 'code php', 'menu3' => 'about');

//return the json response :
header('Content-Type: application/json');  // <-- header declaration
echo json_encode($result, true);    // <--- encode
exit();

ヘッダーがあるので、返されたデータとそのデータを処理する方法をアプリが検出できます。
コンテンツヘッダーは返されるデータの種類に関する情報に過ぎないことに注意してください 。

UTF-8を使用している場合は、次を使用できます。

header("Content-Type: application/json;charset=utf-8");

例jQuery：

$.ajax({
        url:'url_your_page_php_that_return_json'        
    }).done(function(data){
        console.table('json ',data);
        console.log('Menu1 : ', data.menu1);
    });