trigger-error.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 72b70d7c3c3b2b87423641906da2db407c32c3c3 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.trigger-error" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>trigger_error</refname>
  <refpurpose>Déclenche une erreur utilisateur</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>trigger_error</function> est utilisé pour déclencher
   une erreur utilisateur. Elle peut aussi être utilisée en
   conjonction avec un gestionnaire d'erreurs interne, ou un gestionnaire
   d'erreurs utilisateur qui a été choisi comme gestionnaire
   d'erreurs avec <function>set_error_handler</function>.
  </para>
  <para>
   <function>trigger_error</function> est pratique lorsque vous devez
   générer une réponse particulière lors de
   l'exécution.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>message</parameter></term>
     <listitem>
      <para>
       Le message d'erreur désigné pour cette erreur. Il est limité en longueur à 1024 
       octets. Tous caractères après les 1024 octets seront ignorés.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>error_level</parameter></term>
     <listitem>
      <para>
       Le type d'erreur désigné pour cette erreur. Cela ne fonctionne qu'avec 
       la famille de constantes <constant>E_USER_<replaceable>*</replaceable></constant>
       et sera par défaut <constant>E_USER_NOTICE</constant>.
      </para>
      <warning>
       <simpara>
        Passer <constant>E_USER_ERROR</constant> comme
        <parameter>error_level</parameter> est désormais obsolète.
        Lancez une <exceptionname>Exception</exceptionname> ou
        appelez <function>exit</function> à la place.
       </simpara>
      </warning>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Cette fonction lance une <classname>ValueError</classname> si le
   <parameter>error_level</parameter> n'est pas l'un des
   <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>
       Passer <constant>E_USER_ERROR</constant> comme
       <parameter>error_level</parameter> est désormais obsolète.
       Lancez une <exceptionname>Exception</exceptionname> ou
       appelez <function>exit</function> à la place.
      </entry>
     </row>
     <row>
      <entry>8.4.0</entry>
      <entry>
       La fonction a désormais un type de retour <type>true</type>
       au lieu de <type>bool</type>.
      </entry>
     </row>
     <row>
      <entry>8.0.0</entry>
      <entry>
       La fonction lance désormais une <classname>ValueError</classname> si un
       <parameter>error_level</parameter> invalide est spécifié. Auparavant, elle retournait &false;.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>trigger_error</function></title>
    <para>
     Voir <function>set_error_handler</function> pour un exemple plus conséquent.
    </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>
    Les entités HTML contenues dans le paramètre <parameter>message</parameter>
    ne sont pas échappées. Utilisez la fonction <function>htmlentities</function>
    sur le message si l'erreur doit être affichée dans un navigateur.
   </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>Les <link linkend="errorfunc.constants">constantes de niveau d'erreur</link></member>
    <member>L’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
-->