Files
doc-fr/reference/errorfunc/functions/set-error-handler.xml
Yannick Torres 1d925e7b0f sync with EN version
git-svn-id: https://svn.php.net/repository/phpdoc/fr/trunk@166915 c90b9560-bf6c-de11-be94-00142212c4b1
2004-08-20 19:57:42 +00:00

317 lines
11 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.21 $ -->
<!-- EN-Revision: 1.23 Maintainer: yannick Status: ready -->
<refentry id="function.set-error-handler">
<refnamediv>
<refname>set_error_handler</refname>
<refpurpose>
Spécifie une fonction utilisateur comme gestionnaire d'erreurs
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>mixed</type><methodname>set_error_handler</methodname>
<methodparam><type>callback</type><parameter>error_handler</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>error_types</parameter></methodparam>
</methodsynopsis>
<para>
<function>set_error_handler</function> choisit la fonction utilisateur
<parameter>error_handler</parameter> pour gérer les erreurs dans un script.
Retourne une chaîne de caractères contenant le dernier gestionnaire d'erreur
(si il y en avait un) ou &false; en cas d'erreur. Si l'ancien gestionnaire d'erreur était une
méthode d'une classe, cette fonction retournera un tableau indexé avec les noms
de la classe et de la méthode.
</para>
<para>
<function>set_error_handler</function> peut être utilisé pour définir
votre propre manière de gérer les erreurs durant l'exécution, par exemple
pour une application dans laquelle vous devez nettoyer les données/fichiers
lorsqu'une erreur survient ou lorsque vous devez déclencher une erreur sous
certaines conditions (en utilisant <function>trigger_error</function>).
</para>
<para>
Le second paramètre <parameter>error_types</parameter> a été introduit
en &php; 5, et sert de masque pour appeler la fonction
<parameter>error_handler</parameter> de la même façon que l'option de
configuration <link linkend="ini.error-reporting">error_reporting</link>
contrôle les erreurs qui sont affichées. Sans le masque,
<parameter>error_handler</parameter> sera appelé pour toutes les erreurs,
quelque soit la valeur de
<link linkend="ini.error-reporting">error_reporting</link>.
</para>
<para>
La fonction utilisateur doit accepter deux paramètres :
le code d'erreur et une chaîne décrivant le code d'erreur. Depuis
&php; 4.0.2, trois paramètres optionnels sont fournis en même temps :
le fichier dans lequel l'erreur est survenue, la ligne à laquelle
l'erreur est survenue, et le contexte dans lequel l'erreu est survenue
(un tableau contenant la liste des symboles lors de l'erreur). La fonction
peut être décrite comme ceci :
<methodsynopsis>
<methodname><replaceable>handler</replaceable></methodname>
<methodparam><type>int</type><parameter>errno</parameter></methodparam>
<methodparam><type>string</type><parameter>errstr</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>errfile</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>errline</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>errcontext</parameter></methodparam>
</methodsynopsis>
<variablelist>
<varlistentry>
<term><parameter>errno</parameter></term>
<listitem>
<simpara>
Le premier paramètre <parameter>errno</parameter>, contient le
niveau d'erreur, sous la forme d'un entier.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>errstr</parameter></term>
<listitem>
<simpara>
Le second paramètre <parameter>errstr</parameter>, contient le
message d'erreur, sous forme de chaîne.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>errfile</parameter></term>
<listitem>
<simpara>
Le troisième paramètre, optionnel, <parameter>errfile</parameter>,
contient le nom du fichier dans lequel l'erreur a été identifiée.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>errline</parameter></term>
<listitem>
<simpara>
Le quatrième paramètre, optionnel, <parameter>errline</parameter>,
contient le numéro de ligne à laquelle l'erreur a été identifiée.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>errcontext</parameter></term>
<listitem>
<simpara>
Le cinquième paramètre, optionnel, <parameter>errcontext</parameter>,
est un tableaui qui pointe sur la table des symboles actifs lors
de l'erreur. En d'autres termes, <parameter>errcontext</parameter>
contient un tableau avec toutes les variables qui existaient lorsque
l'erreur a été déclenchée.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</para>
<note>
<simpara>
Au lieu d'un nom de fonction, vous pouvez utiliser un tableau contenant
deux éléments, une référence sur un objet et un nom de méthode. Cette
fonctionnalité a été ajoutée en &php; 4.3.0.
</simpara>
</note>
<note>
<para>
Les types d'erreur suivants ne peuvent pas être gérés avec cette fonction :
<constant>E_ERROR</constant>, <constant>E_PARSE</constant>,
<constant>E_CORE_ERROR</constant>, <constant>E_CORE_WARNING</constant>,
<constant>E_COMPILE_ERROR</constant>,
<constant>E_COMPILE_WARNING</constant> et
<constant>E_STRICT</constant>.
</para>
</note>
<para>
L'exemple ci-dessous illustre l'interception d'erreurs internes avec
génération d'erreur et son exploitation dans une fonction utilisateur :
<example>
<title>
Traitement des erreurs avec <function>set_error_handler</function> et
<function>trigger_error</function>
</title>
<programlisting role="php">
<![CDATA[
<?php
// redéfini les constantes utilisateur (PHP 4 Uniquement)
define ("FATAL",E_USER_ERROR);
define ("ERROR",E_USER_WARNING);
define ("WARNING",E_USER_NOTICE);
// configure le niveau de rapport d'erreur pour ce script
error_reporting (FATAL | ERROR | WARNING);
// gestionnaire d'erreurs
function myErrorHandler ($errno, $errstr, $errfile, $errline)
{
switch ($errno) {
case FATAL:
echo "<strong>FATAL</strong> [$errno] $errstr<br />\n";
echo " Fatal error in line ".$errline." of file ".$errfile;
echo ", PHP ".PHP_VERSION." (".PHP_OS.")<br />\n";
echo "Aborting...<br />\n";
exit(1);
break;
case ERROR:
echo "<strong>ERROR</strong> [$errno] $errstr<br />\n";
break;
case WARNING:
echo "<strong>WARNING</strong> [$errno] $errstr<br />\n";
break;
default:
echo "Unkown error type: [$errno] $errstr<br />\n";
break;
}
}
// fonction pour tester la gestion d'erreur
function scale_by_log ($vect, $scale)
{
if ( !is_numeric($scale) || $scale <= 0 ) {
trigger_error("log(x) for x <= 0 is undefined, you used: scale = $scale",
FATAL);
}
if (!is_array($vect)) {
trigger_error("Incorrect input vector, array of values expected", ERROR);
return null;
}
for ($i=0; $i<count($vect); $i++) {
if (!is_numeric($vect[$i]))
trigger_error("Value at position $i is not a number, using 0 (zero)",
WARNING);
$temp[$i] = log($scale) * $vect[$i];
}
return $temp;
}
// Configuration du gestionnaire d'erreurs
$old_error_handler = set_error_handler("myErrorHandler");
// génération de quelques erreurs. Commençons par créer un tableau
echo "vecteur a \n";
$a = array(2,3,"foo",5.5,43.3,21.11);
print_r($a);
// générons maintenant un autre tableau, avec des alertes
echo "----\nvecteur b - une alerte (b = log(PI) * a)\n";
$b = scale_by_log($a, M_PI);
print_r($b);
// ceci est un problème, nous avons utilisé une chaîne au lieu d'un tableau
echo "----\nvecteur c - une erreur\n";
$c = scale_by_log("not array",2.3);
var_dump($c);
// Ceci est une erreur critique : le logarithme de zéro ou d'un nombre négatif est indéfini
echo "----\nvecteur d - erreur fatale\n";
$d = scale_by_log($a, -2.5);
?>
]]>
</programlisting>
&example.outputs;
<programlisting>
<![CDATA[
vecteur a
Array
(
[0] => 2
[1] => 3
[2] => foo
[3] => 5.5
[4] => 43.3
[5] => 21.11
)
----
vecteur b - une alerte (b = log(PI) * a)
<strong>WARNING</strong> [1024] Value at position 2 is not a number, using 0 (zero)<br />
Array
(
[0] => 2.2894597716988
[1] => 3.4341896575482
[2] => 0
[3] => 6.2960143721717
[4] => 49.566804057279
[5] => 24.165247890281
)
----
vecteur c - une erreur
<strong>ERROR</strong> [512] Incorrect input vector, array of values expected<br />
NULL
----
vecteur d - erreur fatale
<strong>FATAL</strong> [256] log(x) for x <= 0 is undefined, you used: scale = -2.5<br />
Fatal error in line 37 of file /Users/imac/-, PHP 5.0.0-dev (Darwin)<br />
Aborting...<br />
]]>
</programlisting>
</example>
</para>
<para>
Il faut se rappeler que la fonction standard de traitement des erreurs
de &php; est alors complètement ignorée.
<function>error_reporting</function>
n'aura plus d'effet, et votre fonction de gestion des
erreurs sera toujours appelée. Vous pourrez toujours lire la valeur
de l'erreur courante de <function>error_reporting</function> et
faire réagir la fonction de gestion des erreurs en fonction.
Cette remarque est notamment valable si la commande a été
préfixée par <link linkend="language.operators.errorcontrol">@</link>
(0 sera retourné).
</para>
<para>
Notez aussi qu'il est alors confié à cette fonction de
terminer le script (<function>die</function>) si nécessaire. Si la
fonction de gestion des erreurs se termine normalement, l'exécution
du script se poursuivra avec l'exécution de la prochaine commande.
</para>
<note>
<para>
Si une erreur survient avant que le script ne soit exécuté (par exemple
un téléchargement de fichier), le gestionnaire d'erreurs personnalisé ne pourra
pas être appelé, car il n'est pas encore enregistré.
</para>
</note>
<note>
<para>
La second paramètre <parameter>error_types</parameter> a été introduit
en &php; 5.
</para>
</note>
<para>
Voir aussi
<function>error_reporting</function>,
<function>restore_error_handler</function>,
<function>trigger_error</function> et
<link linkend="errorfunc.constants">les constantes de niveau
d'erreurs</link>.
</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:"../../../../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
-->