Chapitre 20. Exceptions

Table des matières
Exceptions étendues

PHP 5 a une gestion des exceptions similaire à ce qu'offrent les autres langages de programmation. Une exception peut être jetée, essayée et attrapée dans PHP. Un bloc d'essai doit inclure au moins un bloc de capture. De multiples blocs de capture peuvent être utilisés pour attraper différents types de classes ; l'exception continuera après que le dernier bloc de capture ne soit défini dans la séquence. Les exceptions peuvent être jetées dans les blocs de capture.

Lorsqu'une exception est jetée, le code suivant le traitement ne sera pas exécuté et PHP tentera de trouver le premier bloc de capture correspondant. Si une exception n'est pas attrapé, une erreur fatale issue de PHP sera envoyée avec un message spécifiant que l'exception n'a pu être attrapée à moins qu'un gestionnaire ne soit défini avec la fonction set_exception_handler().

Exemple 20-1. Lancer une exception

<?php
try
{
    
$error = 'Toujours lancer cette erreur';
    
throw new Exception($error);

    
// le code suivant une exception n'est pas exécuté.
    
echo 'Jamais exécuté';
}
catch (Exception $e) {
    echo
'Capture de l'exception : ',  $e->getMessage(), "\n";
}

// Continue l'
exécution
echo 'Bonjour le Monde !';
?>

Exceptions étendues

Une classe Exception définie par l'utilisateur peut être définie en étendant la classe Exception interne. Les membres et les propriétés suivantes montrent ce qui est accessible dans la classe enfant qui est dérivée de la classe exception interne.

Exemple 20-2. La classe Exception interne

<?php
class Exception
{
  
protected $message = 'exception inconnu'; // message de l'exception
  
protected $code = 0;                      // code de l'exception défini par l'utilisateur
  
protected $file;                          // nom du fichier source de l'exception
  
protected $line;                          // ligne de la source de l'exception

  
function __construct(string $message=NULL, int code=0);

  
final function getMessage();              // message de l'exception
  
final function getCode();                 // code de l'exception
  
final function getFile();                 // nom du fichier source
  
final function getLine();                 // ligne du fichier source
  
final function getTrace();                // un tableau de backtrace()
  
final function getTraceAsString();        // chaîne formattée de trace

  /* Remplacable */
  
function _toString();
  
// chaîne formatée pour l'affichage
}
?>

Si une classe étend la classe Exception interne et redéfinie le constructeur, il est vivement recommandé qu'elle appelle aussi parent::__construct() pour s'assurer que toutes les données disponibles ont été proprement assignées. La méthode __toString() peut être réécrite pour fournir un affichage personnalisé lorsque l'objet est présenté comme une chaîne.

Exemple 20-3. Etendre la classe Exception

<?php
/**
* Définition d'une classe d'exception personnalisée
*/
class MyException extends Exception
{
  
// Redéfinissez l'exception ainsi le message n'est pas facultatif
  
public function __construct($message, $code = 0) {

    
// traitement personnalisé que vous voulez réaliser ...

    // assurez-vous que tout a été assigné proprement
    
parent::__construct($message, $code);
  }

  
// chaîne personnalisé représentant l'objet
  
public function __toString() {
    return
__CLASS__ . ": [{$this->code}]: {$this->message}\n";
  }

  
public function customFunction() {
    echo
"Une fonction personnalisée pour ce type d'exception\n";
  }
}

/**
* Création d'une classe pour tester l'exception
*/
class TestException
{
  
public $var;

  const
THROW_NONE    = 0;
  const
THROW_CUSTOM  = 1;
  const
THROW_DEFAULT = 2;

  function
__construct($avalue = self::THROW_NONE) {

    switch (
$avalue) {
      case
self::THROW_CUSTOM:
        
// jète une exception personnalisé
        
throw new MyException('1 est un paramètre invalide', 5);
        break;

      case
self::THROW_DEFAULT:
        
// jète l'exception par défaut.
        
throw new Exception('2 n\'est pas autorisé en tant que paramètre', 6);

        break;

      default:
        
// Aucune exception, l'objet sera créé.
        
$this->var = $avalue;
        break;
    }
  }
}

// Exemple 1
try {
  
$o = new TestException(TestException::THROW_CUSTOM);
}
catch (MyException $e) {            // Devrait être attrapée
  
echo "Capture mon exception\n", $e;
  
$e->customFunction();
}
catch (Exception $e) {              // Sauté
  
echo "Capture l'exception par défaut\n", $e;
}

// Continue l'exécution
var_dump($o);
echo
"\n\n";


//Exemple 2
try {
  
$o = new TestException(TestException::THROW_DEFAULT);
}
catch (MyException $e) {            // Ne correspond pas à ce type
  
echo "Capture mon exception\n", $e;
  
$e->customFunction();
}
catch (Exception $e) {              // Devrait être attrapée
  
echo "Capture l'exception par défaut\n", $e;
}

// Continue l'exécution
var_dump($o);
echo
"\n\n";


// Exemple 3
try {
  
$o = new TestException(TestException::THROW_CUSTOM);
}
catch (Exception $e) {              // Devrait être attrapée
  
echo "Capture l'exception par défaut\n", $e;
}

// Continue l'exécution
var_dump($o);
echo
"\n\n";


// Exemple 4
try {
  
$o = new TestException();
}
catch (Exception $e) {              // sauté, aucune exception
  
echo "Capture l'exception par défaut\n", $e;
}

// Continue l'exécution
var_dump($o);
echo
"\n\n";
?>