JSON の扱い

Nette\Utils\Json は、JSON 形式のエンコードとデコードのための関数を集めた静的クラスです。さまざまな PHP バージョンの脆弱性に対処し、エラー時には例外を投げます。

インストール:

composer require nette/utils

以下の例では、次のクラスの別名が定義されているものとします。

use Nette\Utils\Json;

使い方

$value を JSON 形式に変換します。

$pretty を true にすると、読みやすく分かりやすい形に整形します。

Json::encode($value); // JSON を返す
Json::encode($value, pretty: true); // より読みやすい JSON を返す

$asciiSafe を true にすると ASCII の出力になり、Unicode の文字は \uxxxx の並びに置き換えられます。

Json::encode('žluťoučký', asciiSafe: true);
// '"\u017elu\u0165ou\u010dk\u00fd"'

$htmlSafe パラメータは、出力に HTML で特別な意味を持つ文字が含まれないようにします。

Json::encode('one<two & three', htmlSafe: true);
// '"one\u003Ctwo \u0026 three"'

$forceObjects を true にすると、数値のキーを持つ配列も JavaScript のオブジェクトとしてエンコードされます。

Json::encode(['a', 'b', 'c']);
// '["a","b","c"]'
Json::encode(['a', 'b', 'c'], forceObjects: true);
// '{"0":"a","1":"b","2":"c"}'

エラー時には Nette\Utils\JsonException を投げます。

try {
	$json = Json::encode($value);
} catch (Nette\Utils\JsonException $e) {
	// 例外の処理
}

JSON の文字列を PHP の値に解析します。

$forceArrays を true にすると、オブジェクトではなく配列を返すようになります。

Json::decode('{"variable": true}'); // stdClass 型のオブジェクトを返す
Json::decode('{"variable": true}', forceArrays: true); // 配列を返す

エラー時には Nette\Utils\JsonException を投げます。

try {
	$value = Json::decode($json);
} catch (Nette\Utils\JsonException $e) {
	// 例外の処理
}

$this->sendJson($data) メソッドが使えます。たとえば action*() メソッドの中から呼び出せます。レスポンスの送信をご覧ください。