6.9.14 set_error_handler() Spécifie une fonction utilisateur comme gestionnaire d'erreurs

set_error_handler choisit la fonction utilisateur error_handler 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.

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

Le second paramètre error_types a été introduit en PHP 5, et 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 .

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 : 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 tableaui 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.

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

Traitement des erreurs avec set_error_handler et trigger_error

<?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); ?>

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 @ (0 sera retourné).

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.

Voir aussi error_reporting , restore_error_handler , trigger_error et les constantes de niveau d'erreurs .