Manuel PHP
Précédent |  | Suivant

# set_error_handler

(PHP 4 >= 4.0.1, PHP 5)

set_error_handler -- Spécifie une fonction utilisateur comme gestionnaire d'erreurs

## Description

mixed set_error_handler ( callback error_handler [, int error_types] )

set_error_handler() choisit la fonction utilisateur `error_handler` pour gérer les erreurs dans un script.

set_error_handler() 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 trigger_error()).

Il faut se rappeler que la fonction standard de traitement des erreurs de PHP est alors complètement ignorée. error_reporting() 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 error_reporting 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 @.

Notez aussi qu'il est alors confié à cette fonction de terminer le script (die()) 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.

Les types d'erreur suivants ne peuvent pas être gérés avec cette fonction : `E_ERROR`, `E_PARSE`, `E_CORE_ERROR`, `E_CORE_WARNING`, `E_COMPILE_ERROR`, `E_COMPILE_WARNING` ainsi que la plupart des `E_STRICT` d'un fichier lorsque set_error_handler() est appelé.

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é.

## Liste de paramètres

`error_handler`

  La fonction utilisateur doit accepter deux paramètres : le code d'erreur et une chaîne décrivant le code d'erreur. Depuis, 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 :

  `handler` ( int errno, string errstr [, string errfile [, int errline [, array errcontext]]] )

  `errno`

    Le premier paramètre `errno`, contient le niveau d'erreur, sous la forme d'un entier.

  `errstr`

    Le second paramètre `errstr`, contient le message d'erreur, sous forme de chaîne.

  `errfile`

    Le troisième paramètre, optionnel, `errfile`, contient le nom du fichier dans lequel l'erreur a été identifiée.

  `errline`

    Le quatrième paramètre, optionnel, `errline`, contient le numéro de ligne à laquelle l'erreur a été identifiée.

  `errcontext`

    Le cinquième paramètre, optionnel, `errcontext`, est un tableau qui pointe sur la table des symboles actifs lors de l'erreur. En d'autres termes, `errcontext` contient un tableau avec toutes les variables qui existaient lorsque l'erreur a été déclenchée. La fonction de gestion d'erreurs de l'utilisateur ne doit pas modifier le contexte d'erreur.

`error_types`

  Sert de masque pour appeler la fonction `error_handler` de la même façon que l'option de configuration error_reporting contrôle les erreurs qui sont affichées. Sans le masque, `error_handler` sera appelé pour toutes les erreurs, quelque soit la valeur de error_reporting.

## Valeurs de retour

Retourne une chaîne de caractères contenant le dernier gestionnaire d'erreurs (si il y en avait un) ou `NULL` en cas d'erreur. Si l'ancien gestionnaire d'erreurs était une méthode d'une classe, cette fonction retournera un tableau indexé avec les noms de la classe et de la méthode.

## Historique

Version | Description
--- | ---
5.2.0 | Le gestionnaire d'erreurs doit retourner `FALSE` pour peupler la variable $php_errormsg.
5.0.0 | Le paramètre `error_types` a été introduit.
4.3.0 | Au lieu d'un nom de fonction, un tableau contenant une référence à un objet ainsi qu'un nom de méthode peut aussi être passé au paramètre `error_handler`.
4.0.2 | Trois paramètres optionnels pour le paramètre `error_handler` de la fonction utilisateur ont été introduits. C'est le nom du fichier, le numéro de ligne ainsi que le contexte.

## Exemples

Exemple 1. Gestionnaire d'erreurs avec set_error_handler() et trigger_error()

L'exemple ci-dessous illustre l'interception d'erreurs internes avec génération d'erreur et son exploitation dans une fonction utilisateur :

`<?php
// Gestionnaire d'erreurs
function myErrorHandler($errno, $errstr, $errfile, $errline)
{
switch ($errno) {
case E_USER_ERROR:
echo "<b>Mon ERREUR</b> [$errno] $errstr<br />\n";
echo " Erreur fatale sur la ligne $errline dans le fichier $errfile";
echo ", PHP " . PHP_VERSION . " (" . PHP_OS . ")<br />\n";
echo "Arrêt...<br />\n";
exit(1);
break;
case E_USER_WARNING:
echo "<b>Mon ALERTE</b> [$errno] $errstr<br />\n";
break;
case E_USER_NOTICE:
echo "<b>Mon AVERTISSEMENT</b> [$errno] $errstr<br />\n";
break;
default:
echo "Type d'erreur inconnu : [$errno] $errstr<br />\n";
break;
}
/* Ne pas exécuter le gestionnaire interne de PHP */
return true;
}
// 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", E_USER_ERROR);
}
if (!is_array($vect)) {
trigger_error("Type d'entrée incorrect, tableau de valeurs attendu", E_USER_WARNING);
return null;
}
$temp = array();
foreach($vect as $pos => $value) {
if (!is_numeric($value)) {
trigger_error("La valeur à la position $pos n'est pas un nombre, utilisation 0 (zéro)", E_USER_NOTICE);
$value = 0;
}
$temp[$pos] = log($scale) * $value;
}
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 "vector a\n";
$a = array(2, 3, "foo", 5.5, 43.3, 21.11);
print_r($a);
// Générons maintenant un second tableau
echo "----\nvector b - a notice (b = log(PI) * a)\n";
/* Valeur à la position $pos n'est pas un nombre, utilisation de 0 (zéro) */
$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 "----\nvector c - a warning\n";
/* Type d'entrée incorrect, tableau de valeurs attendu */
$c = scale_by_log("non un tablau", 2.3);
var_dump($c); // NULL
// Ceci est une erreur critique : le logarithme de zéro ou d'un nombre négatif est indéfini
echo "----\nvector d - fatal error\n";
/* log(x) pour x <= 0 est indéfini, vous utilisez : scale = $scale" */
$d = scale_by_log($a, -2.5);
var_dump($d); // Jamais atteint
?>`

L'exemple ci-dessus va afficher quelque chose de similaire à :

    vector a
    Array
    (
        [0] => 2
        [1] => 3
        [2] => foo
        [3] => 5.5
        [4] => 43.3
        [5] => 21.11
    )
    ----
    vector b - a notice (b = log(PI) * a)
    <b>Mon AVERTISSEMENT</b> [1024] La valeur à la position 2 n'est pas un nombre, utilisation de 0 (zéro)<br />
    Array
    (
        [0] => 2.2894597716988
        [1] => 3.4341896575482
        [2] => 0
        [3] => 6.2960143721717
        [4] => 49.566804057279
        [5] => 24.165247890281
    )
    ----
    vector c - an warning
    <b>Mon ALERTE</b> [512] Entrée incorrect, tableau de valeurs attendu<br />
    NULL
    ----
    vector d - fatal error
    <b>Mon ERREUR</b> [256] log(x) for x <= 0 est indéfini, vous utilisez : scale = -2.5<br />
    Erreur fatale sur la ligne 36 dans le fichier trigger_error.php, PHP 4.0.2 (Linux)<br />
    Abandon...<br />

## Voir aussi

error_reporting()
restore_error_handler()
trigger_error()
error level constants
information à propos de callback type

Précédent | Sommaire | Suivant
restore_exception_handler | Niveau supérieur | set_exception_handler