PHP Conference Japan 2024

json_last_error

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

json_last_errorRetourne la dernière erreur JSON

Description

json_last_error(): int

Retourne la dernière erreur, s'il y en a eu, survenue lors de la dernière opération d'encodage/décodage JSON, qui n'a pas spécifié JSON_THROW_ON_ERROR.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Retourne une des constantes suivantes :

Codes d'erreur JSON
Constante Signification Disponibilité
JSON_ERROR_NONE Aucune erreur n'est survenue  
JSON_ERROR_DEPTH La profondeur maximale de la pile a été atteinte  
JSON_ERROR_STATE_MISMATCH JSON invalide ou mal formé  
JSON_ERROR_CTRL_CHAR Erreur lors du contrôle des caractères ; probablement un encodage incorrect  
JSON_ERROR_SYNTAX Erreur de syntaxe  
JSON_ERROR_UTF8 Caractères UTF-8 malformés, possiblement mal encodés  
JSON_ERROR_RECURSION Une ou plusieurs références récursives sont présentes dans la valeur à encoder  
JSON_ERROR_INF_OR_NAN Une ou plusieurs valeurs NAN ou INF sont présentes dans la valeurs à encoder.  
JSON_ERROR_UNSUPPORTED_TYPE Une valeur d'un type qui ne peut être encodée a été fournie  
JSON_ERROR_INVALID_PROPERTY_NAME Un nom de propriété qui ne peut pas être encodé a été donné  
JSON_ERROR_UTF16 Caractères UTF-16 mal formés, probablement mal encodé  

Exemples

Exemple #1 Exemple avec json_last_error()

<?php
// Une chaîne JSON valide
$json[] = '{"Organisation": "Équipe de Documentation PHP"}';

// Une chaîne json invalide qui va générer une erreur de syntaxe,
// ici, utilisation de ' au lieu de "
$json[] = "{'Organisation': 'Équipe de Documentation PHP'}";

foreach (
$json as $string) {
echo
'Décodage : ' . $string;
json_decode($string);

switch (
json_last_error()) {
case
JSON_ERROR_NONE:
echo
' - Aucune erreur';
break;
case
JSON_ERROR_DEPTH:
echo
' - Profondeur maximale atteinte';
break;
case
JSON_ERROR_STATE_MISMATCH:
echo
' - Inadéquation des modes ou underflow';
break;
case
JSON_ERROR_CTRL_CHAR:
echo
' - Erreur lors du contrôle des caractères';
break;
case
JSON_ERROR_SYNTAX:
echo
' - Erreur de syntaxe ; JSON malformé';
break;
case
JSON_ERROR_UTF8:
echo
' - Caractères UTF-8 malformés, probablement une erreur d\'encodage';
break;
default:
echo
' - Erreur inconnue';
break;
}

echo
PHP_EOL;
}
?>

L'exemple ci-dessus va afficher :

Décodage : {"Organisation": "Équipe de Documentation PHP"} - Aucune erreur
Décodage : {'Organisation': 'Équipe de Documentation PHP'} - Erreur de syntaxe ; JSON malformé

Exemple #2 json_last_error() avec json_encode()

<?php
// Une séquence UTF8 invalide
$text = "\xB1\x31";

$json = json_encode($text);
$error = json_last_error();

var_dump($json, $error === JSON_ERROR_UTF8);
?>

L'exemple ci-dessus va afficher :

string(4) "null"
bool(true)

Exemple #3 json_last_error() et JSON_THROW_ON_ERROR

<?php
// Une séquence UTF8 invalide qui cause JSON_ERROR_UTF8
json_encode("\xB1\x31");

// Ceci ne produit pas une erreur JSON
json_encode('okay', JSON_THROW_ON_ERROR);

// L'état d'erreur global n'a pas été modifié par le json_encode() ci-dessus
var_dump(json_last_error() === JSON_ERROR_UTF8);
?>

L'exemple ci-dessus va afficher :

bool(true)

Voir aussi

  • json_last_error_msg() - Retourne le message de la dernière erreur survenue lors de l'appel à la fonction json_encode() ou json_decode()
  • json_decode() - Décode une chaîne JSON
  • json_encode() - Retourne la représentation JSON d'une valeur

add a note

User Contributed Notes 8 notes

up
319
jimmetry at gmail dot com
13 years ago
While this can obviously change between versions, the current error codes are as follows:

0 = JSON_ERROR_NONE
1 = JSON_ERROR_DEPTH
2 = JSON_ERROR_STATE_MISMATCH
3 = JSON_ERROR_CTRL_CHAR
4 = JSON_ERROR_SYNTAX
5 = JSON_ERROR_UTF8

I'm only posting these for people who may be trying to understand why specific JSON files are not being decoded. Please do not hard-code these numbers into an error handler routine.
up
44
praveenscience at gmail dot com
10 years ago
I used this simple script, flicked from StackOverflow to escape from the function failing:

<?php
function utf8ize($d) {
if (
is_array($d)) {
foreach (
$d as $k => $v) {
$d[$k] = utf8ize($v);
}
} else if (
is_string ($d)) {
return
utf8_encode($d);
}
return
$d;
}
?>

Cheers,
Praveen Kumar!
up
30
hemono at gmail dot com
9 years ago
when json_decode a empty string, PHP7 will trigger an Syntax error:
<?php
json_decode
("");
var_dump(json_last_error(), json_last_error_msg());

// PHP 7
int(4)
string(12) "Syntax error"

// PHP 5
int(0)
string(8) "No error"
up
13
msxcms at bmforum dot com
7 years ago
use this code with mb_convert_encoding, you can json_encode some corrupt UTF-8 chars

function safe_json_encode($value, $options = 0, $depth = 512) {
$encoded = json_encode($value, $options, $depth);
if ($encoded === false && $value && json_last_error() == JSON_ERROR_UTF8) {
$encoded = json_encode(utf8ize($value), $options, $depth);
}
return $encoded;
}

function utf8ize($mixed) {
if (is_array($mixed)) {
foreach ($mixed as $key => $value) {
$mixed[$key] = utf8ize($value);
}
} elseif (is_string($mixed)) {
return mb_convert_encoding($mixed, "UTF-8", "UTF-8");
}
return $mixed;
}
up
9
George Dimitriadis
8 years ago
Just adding this note since I had to code this for the actual values reference.

<?php

echo JSON_ERROR_NONE . ' JSON_ERROR_NONE' . '<br />';
echo
JSON_ERROR_DEPTH . ' JSON_ERROR_DEPTH' . '<br />';
echo
JSON_ERROR_STATE_MISMATCH . ' JSON_ERROR_STATE_MISMATCH' . '<br />';
echo
JSON_ERROR_CTRL_CHAR . ' JSON_ERROR_CTRL_CHAR' . '<br />';
echo
JSON_ERROR_SYNTAX . ' JSON_ERROR_SYNTAX' . '<br />';
echo
JSON_ERROR_UTF8 . ' JSON_ERROR_UTF8' . '<br />';
echo
JSON_ERROR_RECURSION . ' JSON_ERROR_RECURSION' . '<br />';
echo
JSON_ERROR_INF_OR_NAN . ' JSON_ERROR_INF_OR_NAN' . '<br />';
echo
JSON_ERROR_UNSUPPORTED_TYPE . ' JSON_ERROR_UNSUPPORTED_TYPE' . '<br />';

/*
The above outputs :
0 JSON_ERROR_NONE
1 JSON_ERROR_DEPTH
2 JSON_ERROR_STATE_MISMATCH
3 JSON_ERROR_CTRL_CHAR
4 JSON_ERROR_SYNTAX
5 JSON_ERROR_UTF8
6 JSON_ERROR_RECURSION
7 JSON_ERROR_INF_OR_NAN
8 JSON_ERROR_UNSUPPORTED_TYPE
*/

?>
up
11
williamprogphp at yahoo dot com dot br
10 years ago
This is a quite simple and functional trick to validate JSON's strings.

<?php

function json_validate($string) {
if (
is_string($string)) {
@
json_decode($string);
return (
json_last_error() === JSON_ERROR_NONE);
}
return
false;
}
echo (
json_validate('{"test": "valid JSON"}') ? "It's a JSON" : "NOT is a JSON"); // prints 'It's a JSON'
echo (json_validate('{test: valid JSON}') ? "It's a JSON" : "NOT is a JSON"); // prints 'NOT is a JSON' due to missing quotes
echo (json_validate(array()) ? "It's a JSON" : "NOT is a JSON"); // prints 'NOT is a JSON' due to a non-string argument
?>

Cheers
up
0
greaties at ghvernuft dot nl
1 month ago
Protected and private properties are ignored,
when json_encoding a class instance.
The snippet

<?php
class Example
{
private
$privateprop = "private property";
protected
$protectedprop = "protected property";
public
$publicprop = "public property";
}
echo
json_encode(new Example);
?>

only returns
{"publicprop":"public property"}
up
0
wedge at atlanteans dot net
6 years ago
here is a small updated version of utf8ize that has the following addition :
* It uses iconv instead of utf8_encode for potentially better result.
* It adds the support of objects variable
* It also update array key value (in a case I met I had to utf8ize the key as well as those were generated from a user input value)

Here is the code.

<?php
function utf8ize($d) {
if (
is_array($d)) {
foreach (
$d as $k => $v) {
unset(
$d[$k]);
$d[utf8ize($k)] = utf8ize($v);
}
} else if (
is_object($d)) {
$objVars = get_object_vars($d);
foreach(
$objVars as $key => $value) {
$d->$key = utf8ize($value);
}
} else if (
is_string ($d)) {
return
iconv('UTF-8', 'UTF-8//IGNORE', utf8_encode($d));
}
return
$d;
}
?>
To Top