PHP json_decode(): JSON'u Diziye veya Nesneye Çevirme

json_decode($json, true) bir JSON dizgesini, her JSON nesnesi bir ilişkisel dizi olacak şekilde PHP değerlerine çevirir. true yazmazsanız JSON nesneleri bunun yerine -> ile okunan stdClass nesnelerine dönüşür. Geçersiz JSON null verir.

<?php
$json = '{"name": "Ada", "age": 36, "langs": ["php", "js"], "admin": true}';

$data = json_decode($json, true);   // associative array
echo $data['name'], "\n";
echo $data['langs'][1], "\n";

$obj = json_decode($json);          // stdClass object
echo $obj->name, "\n";
echo $obj->langs[0], "\n";

print_r($data);

Çıktı:

Ada
js
Ada
php
Array
(
    [name] => Ada
    [age] => 36
    [langs] => Array
        (
            [0] => php
            [1] => js
        )

    [admin] => 1
)

Hangi modu seçerseniz seçin JSON dizileri her zaman PHP listelerine dönüşür. Diğer yön, PHP'den JSON'a, json_encode() fonksiyonudur.

İlişkisel dizi mi nesne mi: true ve false

İki mod da aynı veriyi tutar; kodunuzda daha iyi okunanı seçin. Diziler her dizi fonksiyonuyla çalışır (array_column, array_map, isset($data['key'])), bu yüzden kodların çoğu true verir. Nesneler, tire veya sayı içeren anahtarlar gibi geçerli özellik adı olmayan anahtarlar için süslü parantez söz dizimi gerektirir:

<?php
$json = '{"first-name": "Ada", "0": "zero", "address": {"city": "London"}}';

$arr = json_decode($json, true);
echo $arr['first-name'], ' ', $arr[0], ' ', $arr['address']['city'], "\n";

$obj = json_decode($json);
echo $obj->{'first-name'}, ' ', $obj->{'0'}, ' ', $obj->address->city, "\n";

var_dump($obj->address);

Çıktı:

Ada zero London
Ada zero London
object(stdClass)#2 (1) {
  ["city"]=>
  string(6) "London"
}

Dördüncü parametre bayrakları alır. JSON_OBJECT_AS_ARRAY de dizi verir, ama yalnızca ikinci argüman null (varsayılan değeri) iken: json_decode($json, flags: JSON_OBJECT_AS_ARRAY) dizi döndürür, json_decode($json, false, 512, JSON_OBJECT_AS_ARRAY) ise yine nesne döndürür.

İç içe JSON üzerinde dolaşma

API yanıtları genellikle bir nesnenin içindeki bir nesne listesidir. Bir kez çözümleyin, sonra foreach ile dolaşın ve eksik olabilecek alanlar için ?? kullanın:

<?php
$json = <<<'JSON'
{
    "page": 1,
    "users": [
        {"id": 1, "name": "Ada", "email": "ada@example.com", "roles": ["admin", "editor"]},
        {"id": 2, "name": "Linus", "roles": []},
        {"id": 3, "name": "Grace", "email": "grace@example.com", "roles": ["editor"]}
    ]
}
JSON;

$data = json_decode($json, true);

foreach ($data['users'] as $user) {
    $email = $user['email'] ?? 'no email';
    $roles = $user['roles'] ? implode(', ', $user['roles']) : 'none';
    echo "#{$user['id']} {$user['name']} <$email> roles: $roles\n";
}

$names = array_column($data['users'], 'name', 'id');
print_r($names);

Çıktı:

#1 Ada <ada@example.com> roles: admin, editor
#2 Linus <no email> roles: none
#3 Grace <grace@example.com> roles: editor
Array
(
    [1] => Ada
    [2] => Linus
    [3] => Grace
)

Geçersiz JSON'u ele alma

json_decode() geçersiz JSON için null döndürür, ama null aynı zamanda null JSON metni için de doğru sonuçtur, bu yüzden tek başına null başarısız olup olmadığını söylemez. json_last_error_msg() son çağrının nedenini verir. Daha temiz yol bir JsonException fırlatan JSON_THROW_ON_ERROR kullanmaktır:

<?php
var_dump(json_decode('{"a": 1,}'));   // trailing comma
echo json_last_error_msg(), "\n";

var_dump(json_decode('null'));        // valid JSON, also null
echo json_last_error_msg(), "\n";

try {
    $data = json_decode("{'a': 1}", true, 512, JSON_THROW_ON_ERROR);
} catch (JsonException $e) {
    echo 'Invalid JSON: ', $e->getMessage(), "\n";
}

Çıktı:

NULL
Syntax error
NULL
No error
Invalid JSON: Syntax error

Üçüncü argüman 512 en büyük iç içelik derinliğidir (varsayılan). Adlandırılmış argümanlarla onu atlayabilirsiniz: json_decode($json, true, flags: JSON_THROW_ON_ERROR).

json_validate() ile bir dizgenin geçerli JSON olup olmadığını kontrol etme

PHP 8.3 json_validate() fonksiyonunu ekledi. Çözümlenmiş dizileri oluşturmadan true veya false yanıtını verir, bu yüzden tek ihtiyacınız evet veya hayır olduğunda, örneğin bir istek gövdesini erkenden reddetmek için, çözümlemekten daha az bellek kullanır:

<?php
$inputs = ['{"a": 1}', '[1, 2, 3]', '"text"', '{a: 1}', "{'a': 1}", ''];

foreach ($inputs as $input) {
    $ok = json_validate($input) ? 'valid' : 'invalid: ' . json_last_error_msg();
    echo str_pad(var_export($input, true), 14), $ok, "\n";
}

Çıktı:

'{"a": 1}'    valid
'[1, 2, 3]'   valid
'"text"'      valid
'{a: 1}'      invalid: Syntax error
'{\'a\': 1}'  invalid: Syntax error
''            invalid: Syntax error

Veriyi zaten kullanacaksanız json_validate() adımını atlayın ve JSON_THROW_ON_ERROR ile çözümleyin: önce doğrulamak dizgeyi iki kez ayrıştırır.

Bir JSON dosyasını okuma

Dosyayı file_get_contents() ile okuyun ve dizgeyi çözümleyin. Bu blok okunacak bir dosya olsun diye önce settings.json dosyasını yazar:

<?php
file_put_contents('settings.json', '{"theme": "dark", "fontSize": 14, "plugins": ["git", "lint"]}');

$text = file_get_contents('settings.json');
if ($text === false) {
    exit("Cannot read settings.json\n");
}

$settings = json_decode($text, true, flags: JSON_THROW_ON_ERROR);
echo "Theme: {$settings['theme']}\n";
echo "Plugins: ", count($settings['plugins']), "\n";

// Change a value and write the file back
$settings['fontSize'] = 16;
file_put_contents('settings.json', json_encode($settings, JSON_PRETTY_PRINT));
echo file_get_contents('settings.json'), "\n";

Çıktı:

Theme: dark
Plugins: 2
{
    "theme": "dark",
    "fontSize": 16,
    "plugins": [
        "git",
        "lint"
    ]
}

json_decode neden null döndürür: olağan nedenler

JSON, JavaScript ve PHP dizi söz diziminden daha katıdır. Aşağıdaki her dizge makul görünür ve her biri null döndürür. Her birinin nedenini görmek için çalıştırın, sonra birini düzeltip tekrar çalıştırın:

<?php
$cases = [
    'single quotes'   => "{'name': 'Ada'}",
    'unquoted key'    => '{name: "Ada"}',
    'trailing comma'  => '{"name": "Ada",}',
    'comment'         => '{"name": "Ada" /* admin */}',
    'byte order mark' => "\xEF\xBB\xBF" . '{"name": "Ada"}',
    'too deep'        => '[[["Ada"]]]',
];

foreach ($cases as $label => $json) {
    $depth = $label === 'too deep' ? 2 : 512;
    $result = json_decode($json, true, $depth);
    echo str_pad($label, 17), $result === null ? json_last_error_msg() : 'ok', "\n";
}

// Big integers lose precision unless you ask for strings
var_dump(json_decode('{"id": 12345678901234567890}', true)['id']);
var_dump(json_decode('{"id": 12345678901234567890}', true, 512, JSON_BIGINT_AS_STRING)['id']);

Çıktı:

single quotes    Syntax error
unquoted key     Syntax error
trailing comma   Syntax error
comment          Syntax error
byte order mark  Syntax error
too deep         Maximum stack depth exceeded
float(1.2345678901234567E+19)
string(20) "12345678901234567890"

Bir bayt sırası işareti (BOM) çoğu editörde görünmezdir ve bir JSON dosyasının "iyi görünüp" çözümlenmemesinin klasik nedenidir. Çözümlemeden önce onu $text = preg_replace('/^\xEF\xBB\xBF/', '', $text); ile temizleyin.