trigger-error.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 72b70d7c3c3b2b87423641906da2db407c32c3c3 Maintainer: hholzgra Status: ready -->
<!-- Reviewed: yes -->
<!-- Rev-Revision: c44475e1fafcbee203ed4935a6d5d7a01379fcdc Reviewer: samesch -->
<refentry xml:id="function.trigger-error" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>trigger_error</refname>
  <refpurpose>
   Erzeugt eine benutzerdefinierte Fehlermeldung/Warnung/Benachrichtigung
  </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>
   Wird verwendet, um eine benutzerdefinierte Fehlerbedingung auszulösen und
   kann in Verbindung mit der eingebauten Fehlerbehandlung verwendet werden
   oder mit einer benutzerdefinierten Funktion, die mittels
   <function>set_error_handler</function> als neue Fehlerbehandlung festgelegt
   wurde.
  </para>
  <para>
   Diese Funktion ist nützlich, wenn Sie zur Laufzeit eine bestimmte
   Rückmeldung bei einer Ausnahme brauchen.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>message</parameter></term>
     <listitem>
      <para>
       Die gewünschte Fehlermeldung für diesen Fehler. Die Länge ist auf 1024
       Bytes begrenzt, darüber hinausgehende Zeichen werden abgeschnitten.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>error_level</parameter></term>
     <listitem>
      <para>
       Der gewünschte Fehlertyp für diesen Fehler. Es können nur Konstanten
       der <constant>E_USER_<replaceable>*</replaceable></constant>-Familie gewählt werden, der Vorgabewert ist
       <constant>E_USER_NOTICE</constant>.
      </para>
      <warning>
       <simpara>
        Die Übergabe von <constant>E_USER_ERROR</constant> als
        <parameter>error_level</parameter> ist nun veraltet.
        Stattdessen sollte eine <exceptionname>Exception</exceptionname>
        geworfen oder <function>exit</function> aufgerufen werden.
       </simpara>
      </warning>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Wenn <parameter>error_level</parameter> nicht einer der Werte
   <constant>E_USER_ERROR</constant>, <constant>E_USER_WARNING</constant>,
   <constant>E_USER_NOTICE</constant>, <constant>E_USER_DEPRECATED</constant>
   ist, wirft diese Funktion einen <classname>ValueError</classname>.
  </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>
       Die Übergabe von <constant>E_USER_ERROR</constant> als
       <parameter>error_level</parameter> ist nun veraltet.
       Stattdessen sollte eine <exceptionname>Exception</exceptionname>
       geworfen oder <function>exit</function> aufgerufen werden.
      </entry>
     </row>
     <row>
      <entry>8.4.0</entry>
      <entry>
       Die Funktion hat nun den Rückgabetyp <type>true</type> statt
       <type>bool</type>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       Die Funktion wirft nun einen <classname>ValueError</classname>, wenn
       ein ungültiges <parameter>error_level</parameter> angegeben wird; zuvor
       gab sie &false; zurück.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>trigger_error</function>-Beispiel</title>
    <para>
     Siehe auch <function>set_error_handler</function> für ein ausführlicheres
     Beispiel.
    </para>
    <programlisting role="php">
<![CDATA[
<?php
$password = $_POST['password'] ?? '';
if ($password === '') {
  trigger_error("Die Verwendung eines leeren Passworts ist unsicher", E_USER_WARNING);
}
$hash = password_hash($password, PASSWORD_DEFAULT);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <warning>
   <para>
    Die HTML-Entities in der <parameter>error_msg</parameter> werden nicht
    automatisch maskiert. Wenn die Fehlermeldung in einem Browser ausgegeben
    werden soll, so sollten Sie diese mit <function>htmlentities</function>
    vorverarbeiten.
   </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>Die <link linkend="errorfunc.constants">Error Level Konstanten</link></member>
    <member>Das Attribut <classname>Deprecated</classname></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
-->