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}
Wyjątki
Spis treści
Model wyjątków w PHP jest podobny do tego z innych języków programowania. W PHP wyjątek może być rzucony (throw) i złapany (catch). Kod może zostać otoczony blokiem try, aby ułatwić łapanie potencjalnych wyjątków. Każdy try musi mieć przynajmniej jeden odpowiadający mu blok catch lub finally.
Rzucany obiekt musi być instancją klasy Exception lub klasy dziedziczącej po Exception. Próba rzucenia innego obiektu spowoduje wygenerowanie błędu PHP.
catch
Można użyć wielu bloków catch, aby złapać róne klasy wyjątków. Normalne wykonywanie (kiedy w bloku try nie jest rzucany żaden wyjątek) będzie kontynuowane po ostatnim bloku catch w sekwencji. Można rzucać (lub rzucać ponownie) wyjątki w bloku catch.
Kiedy rzucany jest wyjątek, kod po wyrażeniu nie zostanie wykonany, a PHP spróbuje znaleźć pierwszy pasujący blok catch. Jeżeli wyjątek nie zostanie złapany, zostanie wygenerowany PHP Fatal Error z wiadomością "Uncaught Exception ...", o ile nie zdefiniowano własnej obsługi przez set_exception_handler().
W PHP 7.1 i późniejszych blok catch może opisywać kilka wyjątków, używając znaku poziomej kreski (|). Jest to przydatne gdy różne wyjątki, z róznych hierarchii klas, są obsługiwane w ten sam sposób.
finally
W PHP 5.5 i późniejszych można także określić blok finally po lub w zamian bloków catch. Kod w bloku finally będzie wykonany zawsze po blokach try i catch, niezależnie od tego czy wyjątek został rzucony, a zanim zostanie wznowione normalne wykonywanie skryptu.
Notatki
Informacja:
Funkcje wbudowane w PHP używają głównie raportowania błędów, tylko nowoczesne rozszrzenia zorientowane obiektowo korzystają z wyjątków. Jednakże błędy mogą być łatwo przetłumaczone na na wyjątki dzięki ErrorException.
Wskazówka
Biblioteka standardowa PHP (SPL) udostępnia sporą ilość wbudowanych wyjątków.
Przykłady
Przykład #3 Rzucanie wyjątku
<?php
function inverse($x) {
if (!$x) {
throw new Exception('Dzielenie przez zero.');
}
return 1/$x;
}
try {
echo inverse(5) . "\n";
echo inverse(0) . "\n";
} catch (Exception $e) {
echo 'Złapany wyjątek: ', $e->getMessage(), "\n";
}
// Kontynuuj wykonywanie
echo "Witaj, świecie\n";
?>
Powyższy przykład wyświetli:
0.2 Złapany wyjątek: Dzielenie przez zero. Witaj, świecie
Przykład #4 Obsługa wyjątków z blokiem finally
<?php
function inverse($x) {
if (!$x) {
throw new Exception('Dzielenie przez zero.');
}
return 1/$x;
}
try {
echo inverse(5) . "\n";
} catch (Exception $e) {
echo 'Złapany wyjątek: ', $e->getMessage(), "\n";
} finally {
echo "Pierwszy blok finally.\n";
}
try {
echo inverse(0) . "\n";
} catch (Exception $e) {
echo 'Złapany wyjątek: ', $e->getMessage(), "\n";
} finally {
echo "Drugi blok finally.\n";
}
// Kontynuuj wykonywanie
echo "Witaj świecie\n";
?>
Powyższy przykład wyświetli:
0.2 Pierwszy blok finally. Złapany wyjątek: Dzielenie przez zero. Drugi blok finally. Witaj, świecie
Przykład #5 Zagnieżdżony wyjątek
<?php
class MyException extends Exception { }
class Test {
public function testing() {
try {
try {
throw new MyException('foo!');
} catch (MyException $e) {
// rzuć go ponownie
throw $e;
}
} catch (Exception $e) {
var_dump($e->getMessage());
}
}
}
$foo = new Test;
$foo->testing();
?>
Powyższy przykład wyświetli:
string(4) "foo!"
Przykład #6 Obsługa wielu wyjątków w catch
<?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();
?>
Powyższy przykład wyświetli:
string(11) "MyException"
add a note
User Contributed Notes 12 notes
ask at nilpo dot com ¶
14 years ago
Johan ¶
12 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());
}
?>
christof+php[AT]insypro.com ¶
6 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();
}
?>
Shot (Piotr Szotkowski) ¶
15 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).
daviddlowe dot flimm at gmail dot com ¶
6 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 );
}
?>
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.
Edu ¶
10 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 !"
telefoontoestel at nospam dot org ¶
9 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
?>
Sawsan ¶
12 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/>";
}
?>
Daan ¶
2 years ago
I would like to emphasise that you can not rethrow an Exception inside a catch-block and expect that the next catch-block will handle it.
<?php
try {
throw new RuntimeException('error');
} catch (RuntimeException $e) {
throw $e;
} catch (Exception $e) {
// this will not be executed[
}
?>
Tom Polomsk ¶
9 years ago
Contrary to the documentation it is possible in PHP 5.5 and higher use only try-finally blocks without any catch block.
