trigger-error.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 72b70d7c3c3b2b87423641906da2db407c32c3c3 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.trigger-error" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>trigger_error</refname>
  <refpurpose>
   Генерирует предупреждение, уведомление или сообщение об ошибке на уровне пользователя
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>true</type><methodname>trigger_error</methodname>
   <methodparam><type>string</type><parameter>message</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>error_level</parameter><initializer><constant>E_USER_NOTICE</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   Функция инициирует состояние пользовательской ошибки. Функцию разрешается использовать
   в сочетании со встроенным обработчиком ошибок или функцией,
   которую разработчик определил и установил через функцию
   <function>set_error_handler</function> как новый обработчик ошибок.
  </para>
  <para>
   Польза функции проявляется при выполнении кода, когда
   требуется сгенерировать конкретный ответ на исключение.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>message</parameter></term>
     <listitem>
      <para>
       Сообщение, которое функция назначит ошибке. Длина сообщения ограничивается
       1024 байтами. Функция обрежет символы, которые идут после 1024-го.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>error_level</parameter></term>
     <listitem>
      <para>
       Тип, который функция назначит ошибке. Параметр работает только
       с константами семейства <constant>E_USER_<replaceable>*</replaceable></constant>,
       а значение по умолчанию равно <constant>E_USER_NOTICE</constant>.
      </para>
      <warning>
       <simpara>
        Передача константы <constant>E_USER_ERROR</constant> как значения уровня ошибки
        в параметр <parameter>error_level</parameter> устарела.
        Вместо этого рекомендуют выбрасывать исключение <exceptionname>Exception</exceptionname>
        или вызывать функцию <function>exit</function>.
       </simpara>
      </warning>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.true.always;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Функция выбрасывает исключение <classname>ValueError</classname>,
   если значение параметра <parameter>error_level</parameter> не соответствует значениям
   <constant>E_USER_ERROR</constant>, <constant>E_USER_WARNING</constant>,
   <constant>E_USER_NOTICE</constant> или <constant>E_USER_DEPRECATED</constant>.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.4.0</entry>
      <entry>
       Передача константы <constant>E_USER_ERROR</constant> как значения уровня ошибки
       в параметр <parameter>error_level</parameter> устарела.
       Вместо этого рекомендуют выбрасывать исключение <exceptionname>Exception</exceptionname>
       или вызывать функцию <function>exit</function>.
      </entry>
     </row>
     <row>
      <entry>8.4.0</entry>
      <entry>
       Вместо типа <type>bool</type>
       функции теперь возвращает тип <type>true</type>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Функция выбрасывает ошибку <classname>ValueError</classname>,
       если в аргументе <parameter>error_level</parameter> передали недопустимое значение.
       Раньше функция возвращала значение &false;.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример запуска состояния пользовательской ошибки функцией <function>trigger_error</function></title>
    <para>
     Развёрнутый пример приводит описание
     функции <function>set_error_handler</function>.
    </para>
    <programlisting role="php">
<![CDATA[
<?php

if ($divisor == 0) {
    trigger_error("Не могу поделить на ноль", E_USER_ERROR);
}

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <warning>
   <para>
    HTML-сущности в параметре <parameter>message</parameter> не экранируются.
    Сообщение преобразовывают функцией <function>htmlentities</function>,
    если ошибку требуется отобразить в браузере.
   </para>
  </warning>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>error_reporting</function></member>
    <member><function>set_error_handler</function></member>
    <member><function>restore_error_handler</function></member>
    <member><link linkend="errorfunc.constants">Константы уровней ошибок</link></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
-->