trigger-error.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.trigger-error" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>trigger_error</refname>
  <refpurpose>Generates a user-level error/warning/notice message</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>
   Used to trigger a user error condition, it can be used in conjunction
   with the built-in error handler, or with a user defined function that has
   been set as the new error handler
   (<function>set_error_handler</function>). 
  </para>
  <para>
   This function is useful when you need to generate a particular response to
   an exception at runtime.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>message</parameter></term>
     <listitem>
      <para>
       The designated error message for this error. It's limited to 1024 
       bytes in length. Any additional characters beyond 1024 bytes will be 
       truncated.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>error_level</parameter></term>
     <listitem>
      <para>
       The designated error type for this error. It only works with the <constant>E_USER_<replaceable>*</replaceable></constant>
       family of constants, and will default to <constant>E_USER_NOTICE</constant>.
      </para>
      <warning>
       <simpara>
        Passing <constant>E_USER_ERROR</constant> as the
        <parameter>error_level</parameter> is now deprecated.
        Throw an <exceptionname>Exception</exceptionname> or
        call <function>exit</function> instead.
       </simpara>
      </warning>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   This function throws a <classname>ValueError</classname> if
   <parameter>error_level</parameter> is not one of
   <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>
       Passing <constant>E_USER_ERROR</constant> as the
       <parameter>error_level</parameter> is now deprecated.
       Throw an <exceptionname>Exception</exceptionname> or
       call <function>exit</function> instead.
      </entry>
     </row>
     <row>
      <entry>8.4.0</entry>
      <entry>
       The function now has a return type of <type>true</type>
       instead of <type>bool</type>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       The function now throws a <classname>ValueError</classname> if an invalid
       <parameter>error_level</parameter> is specified. Previously, it returned &false;.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>trigger_error</function> example</title>
    <para>
     See <function>set_error_handler</function> for a more extensive example.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$password = $_POST['password'] ?? '';
if ($password === '') {
  trigger_error("Using an empty password is unsafe", E_USER_WARNING);
}
$hash = password_hash($password, PASSWORD_DEFAULT);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <warning>
   <para>
     HTML entities in <parameter>message</parameter> are not
     escaped. Use <function>htmlentities</function> on the message if
     the error is to be displayed in a browser.
   </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>The <link linkend="errorfunc.constants">error level constants</link></member>
    <member>The <classname>Deprecated</classname> attribute</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
-->