Manuel PHP - Exceptions étendues

Exceptions étendues

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

Exemple #1 La classe Exception interne

<?php
class Exception
{
  protected $message = 'Exception inconnue'; // message de l'exception
  private   $string;						// __toString cache
  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
  private   $trace;						 // backtrace
  private   $previous;					  // exception précédente (depuis PHP 5.3)

  public function __construct($message = null, $code = 0, Exception $previous = null);

  final private function __clone();		 // Inhibe le clonage des exceptions.

  final public function getMessage();			  // message de l'exception
  final public function getCode();				 // code de l'exception
  final public function getFile();				 // nom du fichier source
  final public function getLine();				 // ligne du fichier source
  final public function getTrace();				// un tableau de backtrace()
  final public function getPrevious();			 // exception précédente (depuis PHP 5.3)
  final public function getTraceAsString();		// chaîne formatée de trace

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

Si une classe étend la classe Exception interne et redéfinit 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.

Note:
Les exceptions ne peuvent pas être clônées. Si vous tentez de clôner une exception, une erreur fatale (E_ERROR) sera émise.

Exemple #2 Étendre la classe Exception (PHP 5.3.0+)

<?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, Exception $previous = null) {

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

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

  // chaîne personnalisée 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:
		// lance une exception personnalisée
		throw new MyException('1 est un paramètre invalide', 5);
		break;

	  case self::THROW_DEFAULT:
		// lance 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); // Null
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); // Null
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); // Null
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); // TestException
echo "\n\n";
?>

Note:

Dans PHP, avant PHP 5.3.0 les exceptions ne pouvaient être nichées. Le code suivant montre un exemple d'extension de la classe d'Exception avant PHP 5.3.0.

<?php
/**
 * Définition d'une classe d'exception personnalisée
 */
class MyException extends Exception
{
	// Redéfinition du constructeur pour rendre le message obligatoire
	public function __construct($message, $code = 0) {
		// du code ici
	
		// Appel du parent
		parent::__construct($message, $code);
	}

	// Représentation de l'objet sous forme de chaine personnalisée
	public function __toString() {
		return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
	}

	public function customFunction() {
		echo "Une méthode personnalisée pour cette exception\n";
	}
}
?>

Les exceptions

Generators

Manuel PHP