If you intend on creating a lot of custom exceptions, you may find this code useful. I've created an interface and an abstract exception class that ensures that all parts of the built-in Exception class are preserved in child classes. It also properly pushes all information back to the parent constructor ensuring that nothing is lost. This allows you to quickly create new exceptions on the fly. It also overrides the default __toString method with a more thorough one.
<?php
interface IException
{
/* Protected methods inherited from Exception class */
public function getMessage(); // Exception message
public function getCode(); // User-defined Exception code
public function getFile(); // Source filename
public function getLine(); // Source line
public function getTrace(); // An array of the backtrace()
public function getTraceAsString(); // Formated string of trace
/* Overrideable methods inherited from Exception class */
public function __toString(); // formated string for display
public function __construct($message = null, $code = 0);
}
abstract class CustomException extends Exception implements IException
{
protected $message = 'Unknown exception'; // Exception message
private $string; // Unknown
protected $code = 0; // User-defined exception code
protected $file; // Source filename of exception
protected $line; // Source line of exception
private $trace; // Unknown
public function __construct($message = null, $code = 0)
{
if (!$message) {
throw new $this('Unknown '. get_class($this));
}
parent::__construct($message, $code);
}
public function __toString()
{
return get_class($this) . " '{$this->message}' in {$this->file}({$this->line})\n"
. "{$this->getTraceAsString()}";
}
}
?>
Now you can create new exceptions in one line:
<?php
class TestException extends CustomException {}
?>
Here's a test that shows that all information is properly preserved throughout the backtrace.
<?php
function exceptionTest()
{
try {
throw new TestException();
}
catch (TestException $e) {
echo "Caught TestException ('{$e->getMessage()}')\n{$e}\n";
}
catch (Exception $e) {
echo "Caught Exception ('{$e->getMessage()}')\n{$e}\n";
}
}
echo '<pre>' . exceptionTest() . '</pre>';
?>
Here's a sample output:
Caught TestException ('Unknown TestException')
TestException 'Unknown TestException' in C:\xampp\htdocs\CustomException\CustomException.php(31)
#0 C:\xampp\htdocs\CustomException\ExceptionTest.php(19): CustomException->__construct()
#1 C:\xampp\htdocs\CustomException\ExceptionTest.php(43): exceptionTest()
#2 {main}
Les exceptions
Sommaire
PHP a une gestion des exceptions similaire à ce qu'offrent les autres
langages de programmation.
Une exception peut être lancée ("throw") et attrapée
("catch") dans PHP. Le code devra être entouré
d'un bloc try pour faciliter la saisie d'une exception
potentielle. Chaque try doit avoir au moins
un bloc catch ou finally correspondant.
Si une exception est lancée et que la portée courante de la fonction n'a pas
de block catch, l'exception "remontera" la pile d'appel de la fonction appelante
jusqu'à trouver un bloc catch correspondant. Tous les blocs finally rencontrés
seront exécutés. Si la pile d'appel est déroulée jusqu'à la portée globale sans
rencontrer de bloc catch correspondant, le programme sera terminé avec
une erreur fatale sauf si un gestionnaire global d'exception a été défini.
L'objet lancé doit être une instanceof Throwable.
Tenter de lancer un objet qui ne l'est pas résultera en une erreur fatale émise par PHP.
À partir de PHP 8.0.0, le mot clé throw est une expression et peut être
utilisé dans n'importe quel contexte d'expressions. Dans les versions
antérieures c'était une déclaration qui devait être sur sa propre ligne.
catch
Un bloc catch définit comment réagir à une exception qui a été lancée.
Un bloc catch définit un ou plusieurs types d'exceptions ou erreurs qu'il peut
gérer, et optionnellement une variable dans laquelle assigner l'exception.
(Cette variable était requise dans les versions antérieures à PHP 8.0.0)
Le premier bloc catch qu'une exception ou erreur lancée rencontre et qui correspond au
type de l'objet lancé gérera l'objet.
Plusieurs blocs catch peuvent être utilisés pour attraper différentes
classes d'exceptions. L'exécution normale (lorsqu'aucune exception n'est lancée
dans le bloc try) continue après le dernier
bloc catch défini dans la séquence. Les exceptions
peuvent être lancées (throw) ou relancées dans un bloc catch. Sinon,
l'exécution continuera après le bloc catch qui a été déclenché.
Lorsqu'une exception est lancée, le code suivant le traitement ne sera pas
exécuté et PHP tentera de trouver le premier bloc catch correspondant.
Si une exception n'est pas attrapée, une erreur fatale issue de PHP sera
envoyée avec un message "Uncaught Exception ..."
indiquant que l'exception n'a pu être attrapée à moins qu'un gestionnaire
d'exceptions ne soit défini avec la fonction
set_exception_handler().
À partir de PHP 7.1, un block catch peut spécifier plusieurs exceptions à
l'aide du caratère pipe (|). Ceci est utile lorsque
différentes exceptions de hiérarchies de classes différentes sont traitées
de la même manière.
À partir de PHP 8.0.0, le nom de variable pour l'exception attrapée est
optionnel. Si non spécifié, le bloc catch sera toujours exécuté mais
n'aura pas accès à l'objet lancé.
finally
Un bloc finally peut aussi être
spécifié après des blocs catch. Le code à l'intérieur
du bloc finally sera toujours exécuté après les blocs
try et catch, indépendamment du fait qu'une
exception a été lancée, avant de continuer l'exécution normale.
Une interaction notable est entre un bloc finally et une déclaration
return.
Si une déclaration return est rencontrée à l'intérieur des blocs try
ou catch, le bloc finally sera quand même exécuté. De plus,
la déclaration return est évaluée quand elle est rencontrée, mais le
résultat sera retourné après que le bloc finally soit exécuté.
Additionnellement, si le bloc finally contient aussi une déclaration
return la valeur du bloc finally est retournée.
Global exception handler
Si une exception est autorisée à remonter jusqu'à la portée globale, elle peut
être attrapée par un gestionnaire d'exceptions global si il a été défini. La fonction
set_exception_handler() peut définir une fonction qui sera
appelée à la place d'un block catch si aucun autre block n'est invoqué.
L'effet est essentiellement identique à entourer le programme entier dans un
block try-catch avec cette fonction en tant que catch.
Notes
Note:
Les fonctions internes de PHP utilisent principalement l' Error reporting, seules les extensions orientées objet utilisent les exceptions. Quoiqu'il en soit, des erreurs peuvent facilement être traduites en exceptions avec ErrorException. Cependant, cette technique ne fonctionne que pour les erreurs non fatales.
Exemple #1 Convertir l'error reporting en exceptions
<?php
function exceptions_error_handler($severity, $message, $filename, $lineno) {
throw new ErrorException($message, 0, $severity, $filename, $lineno);
}
set_error_handler('exceptions_error_handler');
?>
Astuce
La bibliothèque standard PHP (SPL) fournit un bon nombre d'exceptions additionnelles.
Exemples
Exemple #2 Lancer une exception
<?php
function inverse($x) {
if (!$x) {
throw new Exception('Division par zéro.');
}
return 1/$x;
}
try {
echo inverse(5) . "\n";
echo inverse(0) . "\n";
} catch (Exception $e) {
echo 'Exception reçue : ', $e->getMessage(), "\n";
}
// Continue execution
echo "Bonjour le monde !\n";
?>L'exemple ci-dessus va afficher :
0.2 Exception reçue : Division par zéro. Bonjour le monde !
Exemple #3 Gestion de l'exception avec un bloc finally
<?php
function inverse($x) {
if (!$x) {
throw new Exception('Division par zéro.');
}
return 1/$x;
}
try {
echo inverse(5) . "\n";
} catch (Exception $e) {
echo 'Exception reçue : ', $e->getMessage(), "\n";
} finally {
echo "Première fin.\n";
}
try {
echo inverse(0) . "\n";
} catch (Exception $e) {
echo 'Exception reçue : ', $e->getMessage(), "\n";
} finally {
echo "Seconde fin.\n";
}
// On continue l'exécution
echo "Bonjour le monde !\n";
?>L'exemple ci-dessus va afficher :
0.2 Première fin. Exception reçue : Division par zéro. Seconde fin. Bonjour le monde !
Exemple #4 Interaction entre le bloc finally et return
<?php
function test() {
try {
throw new Exception('foo');
} catch (Exception $e) {
return 'catch';
} finally {
return 'finally';
}
}
echo test();
?>L'exemple ci-dessus va afficher :
finally
Exemple #5 Héritage d'une exception
<?php
class MyException extends Exception { }
class Test {
public function testing() {
try {
try {
throw new MyException('foo!');
} catch (MyException $e) {
// on la relance
throw $e;
}
} catch (Exception $e) {
var_dump($e->getMessage());
}
}
}
$foo = new Test;
$foo->testing();
?>L'exemple ci-dessus va afficher :
string(4) "foo!"
Exemple #6 Gestion des exceptions de capture multiple
<?php
class MyException extends Exception { }
class MyOtherException extends Exception { }
class Test {
public function testing() {
try {
throw new MyException();
} catch (MyException | MyOtherException $e) {
var_dump(get_class($e));
}
}
}
$foo = new Test;
$foo->testing();
?>L'exemple ci-dessus va afficher :
string(11) "MyException"
Exemple #7 Omettre la variable attrapé
Seulement permis dans PHP 8.0.0 et ultérieur.
<?php
function test() {
throw new SpecificException('Oopsie');
}
try {
test();
} catch (SpecificException) {
print "A SpecificException was thrown, but we don't care about the details.";
}
?>Exemple #8 Throw en tant qu'expression
Seulement permis dans PHP 8.0.0 et ultérieur.
<?php
class SpecificException extends Exception {}
function test() {
do_something_risky() or throw new Exception('It did not work');
}
try {
test();
} catch (Exception $e) {
print $e->getMessage();
}
?>
add a note
User Contributed Notes 15 notes
ask at nilpo dot com ¶
15 years ago
tianyiw at vip dot qq dot com ¶
1 year ago
Easy to understand `finally`.
<?php
try {
try {
echo "before\n";
1 / 0;
echo "after\n";
} finally {
echo "finally\n";
}
} catch (\Throwable) {
echo "exception\n";
}
?>
# Print:
before
finally
exception
Johan ¶
13 years ago
Custom error handling on entire pages can avoid half rendered pages for the users:
<?php
ob_start();
try {
/*contains all page logic
and throws error if needed*/
...
} catch (Exception $e) {
ob_end_clean();
displayErrorPage($e->getMessage());
}
?>
Shot (Piotr Szotkowski) ¶
16 years ago
‘Normal execution (when no exception is thrown within the try block, *or when a catch matching the thrown exception’s class is not present*) will continue after that last catch block defined in sequence.’
‘If an exception is not caught, a PHP Fatal Error will be issued with an “Uncaught Exception …” message, unless a handler has been defined with set_exception_handler().’
These two sentences seem a bit contradicting about what happens ‘when a catch matching the thrown exception’s class is not present’ (and the second sentence is actually correct).
jlherren ¶
11 months ago
As noted elsewhere, throwing an exception from the `finally` block will replace a previously thrown exception. But the original exception is magically available from the new exception's `getPrevious()`.
<?php
try {
try {
throw new RuntimeException('Exception A');
} finally {
throw new RuntimeException('Exception B');
}
}
catch (Throwable $exception) {
echo $exception->getMessage(), "\n";
// 'previous' is magically available!
echo $exception->getPrevious()->getMessage(), "\n";
}
?>
Will print:
Exception B
Exception A
daviddlowe dot flimm at gmail dot com ¶
7 years ago
Starting in PHP 7, the classes Exception and Error both implement the Throwable interface. This means, if you want to catch both Error instances and Exception instances, you should catch Throwable objects, like this:
<?php
try {
throw new Error( "foobar" );
// or:
// throw new Exception( "foobar" );
}
catch (Throwable $e) {
var_export( $e );
}
?>
christof+php[AT]insypro.com ¶
7 years ago
In case your E_WARNING type of errors aren't catchable with try/catch you can change them to another type of error like this:
<?php
set_error_handler(function($errno, $errstr, $errfile, $errline){
if($errno === E_WARNING){
// make it more serious than a warning so it can be caught
trigger_error($errstr, E_ERROR);
return true;
} else {
// fallback to default php error handler
return false;
}
});
try {
// code that might result in a E_WARNING
} catch(Exception $e){
// code to handle the E_WARNING (it's actually changed to E_ERROR at this point)
} finally {
restore_error_handler();
}
?>
Edu ¶
11 years ago
The "finally" block can change the exception that has been throw by the catch block.
<?php
try{
try {
throw new \Exception("Hello");
} catch(\Exception $e) {
echo $e->getMessage()." catch in\n";
throw $e;
} finally {
echo $e->getMessage()." finally \n";
throw new \Exception("Bye");
}
} catch (\Exception $e) {
echo $e->getMessage()." catch out\n";
}
?>
The output is:
Hello catch in
Hello finally
Bye catch out
mlaopane at gmail dot com ¶
6 years ago
<?php
/**
* You can catch exceptions thrown in a deep level function
*/
function employee()
{
throw new \Exception("I am just an employee !");
}
function manager()
{
employee();
}
function boss()
{
try {
manager();
} catch (\Exception $e) {
echo $e->getMessage();
}
}
boss(); // output: "I am just an employee !"
Simo ¶
9 years ago
#3 is not a good example. inverse("0a") would not be caught since (bool) "0a" returns true, yet 1/"0a" casts the string to integer zero and attempts to perform the calculation.
telefoontoestel at nospam dot org ¶
10 years ago
When using finally keep in mind that when a exit/die statement is used in the catch block it will NOT go through the finally block.
<?php
try {
echo "try block<br />";
throw new Exception("test");
} catch (Exception $ex) {
echo "catch block<br />";
} finally {
echo "finally block<br />";
}
// try block
// catch block
// finally block
?>
<?php
try {
echo "try block<br />";
throw new Exception("test");
} catch (Exception $ex) {
echo "catch block<br />";
exit(1);
} finally {
echo "finally block<br />";
}
// try block
// catch block
?>
Tom Polomsk ¶
10 years ago
Contrary to the documentation it is possible in PHP 5.5 and higher use only try-finally blocks without any catch block.
Sawsan ¶
13 years ago
the following is an example of a re-thrown exception and the using of getPrevious function:
<?php
$name = "Name";
//check if the name contains only letters, and does not contain the word name
try
{
try
{
if (preg_match('/[^a-z]/i', $name))
{
throw new Exception("$name contains character other than a-z A-Z");
}
if(strpos(strtolower($name), 'name') !== FALSE)
{
throw new Exception("$name contains the word name");
}
echo "The Name is valid";
}
catch(Exception $e)
{
throw new Exception("insert name again",0,$e);
}
}
catch (Exception $e)
{
if ($e->getPrevious())
{
echo "The Previous Exception is: ".$e->getPrevious()->getMessage()."<br/>";
}
echo "The Exception is: ".$e->getMessage()."<br/>";
}
?>
lscorionjs at gmail dot com ¶
1 year ago
<?php
try {
$str = 'hi';
throw new Exception();
} catch (Exception) {
var_dump($str);
} finally {
var_dump($str);
}
?>
Output:
string(2) "hi"
string(2) "hi"
ilia-yats at ukr dot net ¶
1 year ago
Note some undocumented details about exceptions thrown from 'finally' blocks.
When exception is thrown from 'finally' block, it overrides the original not-caught (or re-thrown) exception. So the behavior is similar to 'return': value returned from 'finally' overrides the one returned earlier. And the original exception is automatically appended to the exceptions chain, i.e. becomes 'previous' for the new one. Example:
<?php
try {
try {
throw new Exception('thrown from try');
} finally {
throw new Exception('thrown from finally');
}
} catch(Exception $e) {
echo $e->getMessage();
echo PHP_EOL;
echo $e->getPrevious()->getMessage();
}
// will output:
// thrown from finally
// thrown from try
?>
Example with re-throwing:
<?php
try {
try {
throw new Exception('thrown from try');
} catch (Exception $e) {
throw new Exception('thrown from catch');
} finally {
throw new Exception('thrown from finally');
}
} catch(Exception $e) {
echo $e->getMessage();
echo PHP_EOL;
echo $e->getPrevious()->getMessage();
}
// will output:
// thrown from finally
// thrown from catch
?>
The same happens even if explicitly pass null as previous exception:
<?php
try {
try {
throw new Exception('thrown from try');
} finally {
throw new Exception('thrown from finally', null, null);
}
} catch(Exception $e) {
echo $e->getMessage();
echo PHP_EOL;
echo $e->getPrevious()->getMessage();
}
// will output:
// thrown from finally
// thrown from try
?>
Also it is possible to pass previous exception explicitly, the 'original' one will be still appended to the chain, e.g.:
<?php
try {
try {
throw new Exception('thrown from try');
} finally {
throw new Exception(
'thrown from finally',
null,
new Exception('Explicitly set previous!')
);
}
} catch(Exception $e) {
echo $e->getMessage();
echo PHP_EOL;
echo $e->getPrevious()->getMessage();
echo PHP_EOL;
echo $e->getPrevious()->getPrevious()->getMessage();
}
// will output:
// thrown from finally
// Explicitly set previous!
// thrown from try
?>
This seems to be true for versions 5.6-8.2.
