As previously noted exception linking was recently added (and what a god-send it is, it certainly makes layer abstraction (and, by association, exception tracking) easier).
Since <5.3 was lacking this useful feature I took some initiative and creating a custom exception class that all of my exceptions inherit from:
<?php
class SystemException extends Exception
{
private $previous;
public function __construct($message, $code = 0, Exception $previous = null)
{
parent::__construct($message, $code);
if (!is_null($previous))
{
$this -> previous = $previous;
}
}
public function getPrevious()
{
return $this -> previous;
}
}
?>
Hope you find it useful.
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 implements Throwable
{
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 = '', $code = 0, Throwable $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
// Remplaçable
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 clonées. Si vous tentez de cloner une exception, une erreur fatale (
E_ERROR) sera émise.
Exemple #2 Étendre 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, Throwable $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";
?>
add a note
User Contributed Notes 8 notes
iamhiddensomewhere at gmail dot com ¶
14 years ago
sapphirepaw.org ¶
14 years ago
Support for exception linking was added in PHP 5.3.0. The getPrevious() method and the $previous argument to the constructor are not available on any built-in exceptions in older versions of PHP.
michaelrfairhurst at gmail dot com ¶
11 years ago
Custom exception classes can allow you to write tests that prove your exceptions
are meaningful. Usually testing exceptions, you either assert the message equals
something in which case you can't change the message format without refactoring,
or not make any assertions at all in which case you can get misleading messages
later down the line. Especially if your $e->getMessage is something complicated
like a var_dump'ed context array.
The solution is to abstract the error information from the Exception class into
properties that can be tested everywhere except the one test for your formatting.
<?php
class TestableException extends Exception {
private $property;
function __construct($property) {
$this->property = $property;
parent::__construct($this->format($property));
}
function format($property) {
return "I have formatted: " . $property . "!!";
}
function getProperty() {
return $this->property;
}
}
function testSomethingThrowsTestableException() {
try {
throw new TestableException('Property');
} Catch (TestableException $e) {
$this->assertEquals('Property', $e->getProperty());
}
}
function testExceptionFormattingOnlyOnce() {
$e = new TestableException;
$this->assertEquals('I have formatted: properly for the only required test!!',
$e->format('properly for the only required test')
);
}
?>
Hayley Watson ¶
5 years ago
Check the other SPL Exception classes and extend one of those if your intended exception is a subclass of one of those. This allows more finesse when catching.
Dor ¶
12 years ago
It's important to note that subclasses of the Exception class will be caught by the default Exception handler
<?php
/**
* NewException
* Extends the Exception class so that the $message parameter is now mendatory.
*
*/
class NewException extends Exception {
//$message is now not optional, just for the extension.
public function __construct($message, $code = 0, Exception $previous = null) {
parent::__construct($message, $code, $previous);
}
}
/**
* TestException
* Tests and throws Exceptions.
*/
class TestException {
const NONE = 0;
const NORMAL = 1;
const CUSTOM = 2;
public function __construct($type = self::NONE) {
switch ($type) {
case 1:
throw new Exception('Normal Exception');
break;
case 2:
throw new NewException('Custom Exception');
break;
default:
return 0; //No exception is thrown.
}
}
}
try {
$t = new TestException(TestException::CUSTOM);
}
catch (Exception $e) {
print_r($e); //Exception Caught
}
?>
Note that if an Exception is caught once, it won't be caught again (even for a more specific handler).
shaman_master at list dot ru ¶
9 years ago
Use this example for not numeric codes:
<code>
<?php
class MyException extends Exception
{
/**
* Creates a new exception.
*
* @param string $message Error message
* @param mixed $code The exception code
* @param Exception $previous Previous exception
* @return void
*/
public function __construct($message = '', $code = 0, Exception $previous = null)
{
// Pass the message and integer code to the parent
parent::__construct((string)$message, (int)$code, $previous);
// @link http://bugs.php.net/39615 Save the unmodified code
$this->code = $code;
}
}
</code>
florenxe ¶
8 years ago
I just wanted to add that "extends" is same concept of "Inheritance" or "Prototyping in Javascript". So when you extend a class, you are simply inheriting the class's methods and properties. So you can create custom classes from existing classes like extending the array class.
paragdiwan at gmail dot com ¶
15 years ago
I have written similar simple custom exception class. Helpful for newbie.
<?php
/*
This is written for overriding the exceptions.
custom exception class
*/
error_reporting(E_ALL-E_NOTICE);
class myCustomException extends Exception
{
public function __construct($message, $code=0)
{
parent::__construct($message,$code);
}
public function __toString()
{
return "<b style='color:red'>".$this->message."</b>";
}
}
class testException
{
public function __construct($x)
{
$this->x=$x;
}
function see()
{
if($this->x==9 )
{
throw new myCustomException("i didnt like it");
}
}
}
$obj = new testException(9);
try{
$obj->see();
}
catch(myCustomException $e)
{
echo $e;
}
?>
