archived-doc-ru/reference/json/functions/json-last-error.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 058ea1e8420b9c1b24402af52545e8313428e1d1 Maintainer: mch Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.json-last-error" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>json_last_error</refname>
  <refpurpose>Возвращает код последней ошибки</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>json_last_error</methodname>
   <void />
  </methodsynopsis>
  <para>
   Функция возвращает код последней ошибки,
   которая возникла во время кодирования, декодирования или проверки JSON-данных
   без установки флага <constant>JSON_THROW_ON_ERROR</constant>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Функция возвращает целочисленное значение в виде следующих
   констант:
  </para>
  <table>
   <title>Коды ошибок JSON</title>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>Константа</entry>
      <entry>Значение</entry>
      <entry>Доступность</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry><constant>JSON_ERROR_NONE</constant></entry>
      <entry>Без ошибок</entry>
      <entry></entry>
     </row>
     <row>
      <entry><constant>JSON_ERROR_DEPTH</constant></entry>
      <entry>Достигнута максимальная глубина стека</entry>
      <entry></entry>
     </row>
     <row>
      <entry><constant>JSON_ERROR_STATE_MISMATCH</constant></entry>
      <entry>Недопустимые или сформированные с нарушением формата JSON данные</entry>
      <entry></entry>
     </row>
     <row>
      <entry><constant>JSON_ERROR_CTRL_CHAR</constant></entry>
      <entry>Ошибка управляющего символа, возможно, неверная кодировка</entry>
      <entry></entry>
     </row>
     <row>
      <entry><constant>JSON_ERROR_SYNTAX</constant></entry>
      <entry>Синтаксическая ошибка</entry>
      <entry></entry>
     </row>
     <row>
      <entry><constant>JSON_ERROR_UTF8</constant></entry>
      <entry>Некорректные для кодировки UTF-8 символы, возможно, неверная кодировка</entry>
      <entry></entry>
     </row>
     <row>
      <entry><constant>JSON_ERROR_RECURSION</constant></entry>
      <entry>Одна или несколько зацикленных ссылок в кодируемом значении</entry>
      <entry></entry>
     </row>
     <row>
      <entry><constant>JSON_ERROR_INF_OR_NAN</constant></entry>
      <entry>
       Одно или несколько значений
       <link linkend="language.types.float.nan"><constant>NAN</constant></link>
       или <link linkend="function.is-infinite"><constant>INF</constant></link>
       в кодируемом значении
      </entry>
      <entry></entry>
     </row>
     <row>
      <entry><constant>JSON_ERROR_UNSUPPORTED_TYPE</constant></entry>
      <entry>Передали значение с неподдерживаемым типом</entry>
      <entry></entry>
     </row>
     <row>
      <entry><constant>JSON_ERROR_INVALID_PROPERTY_NAME</constant></entry>
      <entry>Название свойства невозможно закодировать</entry>
      <entry></entry>
     </row>
     <row>
      <entry><constant>JSON_ERROR_UTF16</constant></entry>
      <entry>Некорректный для кодировки UTF-16 символ, возможно, некорректно закодирован</entry>
      <entry></entry>
     </row>
     <row>
      <entry><constant>JSON_ERROR_NON_BACKED_ENUM</constant></entry>
      <entry>Значение содержит нетипизированное перечисление, которое невозможно сериализовать</entry>
      <entry>Константа доступна с PHP 8.1.0</entry>
     </row>
    </tbody>
   </tgroup>
  </table>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример получения кода последней ошибки функцией <function>json_last_error</function></title>
    <programlisting role="php">
<![CDATA[
<?php

// Допустимая json-строка
$json[] = '{"Организация": "Команда PHP-документации"}';

// Недопустимая json-строка, которая вызовет синтаксическую ошибку,
// поскольку вместо двойных кавычек указали одинарные
$json[] = "{'Организация': 'Команда PHP-документации'}";


foreach ($json as $string) {
    echo 'Декодируем: ' . $string;
    json_decode($string);

    switch (json_last_error()) {
        case JSON_ERROR_NONE:
            echo ' — Без ошибок';
            break;
        case JSON_ERROR_DEPTH:
            echo ' — Достигнута максимальная глубина стека';
            break;
        case JSON_ERROR_STATE_MISMATCH:
            echo ' — Некорректные разряды или несоответствие режимов';
            break;
        case JSON_ERROR_CTRL_CHAR:
            echo ' — Некорректный управляющий символ';
            break;
        case JSON_ERROR_SYNTAX:
            echo ' — Синтаксическая ошибка, некорректный формат JSON';
            break;
        case JSON_ERROR_UTF8:
            echo ' — Некорректные символы для кодировки UTF-8, возможно, строку неправильно закодировали';
            break;
        default:
            echo ' — Неизвестная ошибка';
            break;
    }

    echo PHP_EOL;
}

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Декодируем: {"Организация": "Команда PHP-документации"} — Без ошибок
Декодируем: {'Организация': 'Команда PHP-документации'} — Синтаксическая ошибка, некорректный формат JSON
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>
     Пример получения функцией <function>json_last_error</function> кода последней ошибки,
     которую сгенерировала функция <function>json_encode</function>
    </title>
    <programlisting role="php">
<![CDATA[
<?php

// Недопустимая для кодировки UTF-8 последовательность символов
$text = "\xB1\x31";

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

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

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
string(4) "null"
bool(true)
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>
     Пример получения кода последней ошибки функцией <function>json_last_error</function>
     при обработке JSON-данных с флагом <constant>JSON_THROW_ON_ERROR</constant>
    </title>
    <programlisting role="php">
<![CDATA[
<?php

// Недопустимая для кодировки UTF-8 последовательность символов, которая вызывает ошибку JSON_ERROR_UTF8
json_encode("\xB1\x31");

// Следующий вызов не генерирует ошибку при кодировании данных в формат JSON
json_encode('okay', JSON_THROW_ON_ERROR);

// Второй вызов функции json_encode() не изменил глобальное состояние ошибки,
// которую сгенерировал первый вызов
var_dump(json_last_error() === JSON_ERROR_UTF8);

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
bool(true)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>json_last_error_msg</function></member>
    <member><function>json_decode</function></member>
    <member><function>json_encode</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->