PHP 8.4.2 Released!

    Exceptions (Ausnahmen)

    Inhaltsverzeichnis

    PHP hat ein Exceptionmodell ähnlich dem anderer Programmiersprachen. Eine Exception kann in PHP ausgelöst (throw) und abgefangen (catch) werden. Um das Abfangen potentieller Exceptions zu ermöglichen, sollte der jeweilige Code von einem try-Block umschlossen werden. Jeder try-Block muss mindestens einen zugehörigen catch- oder finally-Block besitzen.

    Wenn eine Exception ausgelöst wird und der aktuelle Funktionsbereich keinen catch-Block hat, steigt die Exception im Aufrufstapel bis zur aufrufenden Funktion auf, bis sie einen passenden catch-Block findet. Alle finally-Blöcke, auf die sie unterwegs trifft, werden ausgeführt. Wenn der Aufrufstapel bis in den globalen Bereich abgewickelt ist, ohne auf einen passenden catch-Block zu stoßen, bricht das Programm mit einem fatalen Fehler ab, es sei denn, es wurde ein globaler Exception-Handler gesetzt.

    Das ausgelöste Objekt muss eine Instanz von (instanceof) Throwable sein. Der Versuch ein Objekt auszulösen, das das nicht ist, wird einen fatalen PHP-Fehler zur Folge haben.

    Seit PHP 8.0.0 ist das Schlüsselwort throw ein Ausdruck und kann in jedem Ausdruckskontext verwendet werden. In früheren Versionen war es eine Anweisung und musste in einer eigenen Zeile stehen.

    catch

    Ein catch-Block definiert, wie auf eine ausgelöste Exception reagiert werden soll. Ein catch-Block definiert eine oder mehrere Arten von Exceptions oder Fehlern, die er behandeln kann, und optional eine Variable, der die Exception zugewiesen werden soll (vor PHP 8.0.0 war die Variable erforderlich). Der erste catch-Block, auf den eine ausgelöste Exception oder ein Fehler trifft, der mit dem Typ des ausgelösten Objekts übereinstimmt, behandelt das Objekt.

    Mehrere catch-Blöcke können verwendet werden, um verschiedene Klassen von Exceptions abzufangen. Wenn innerhalb des try-Blocks keine Exception ausgelöst wird, wird die normale Programmausführung nach dem letzten in Folge definierten catch-Block fortgesetzt. Exceptions können innerhalb eines catch-Blocks ausgelöst (oder erneut ausgelöst) werden. Falls nicht, wird die Ausführung nach dem catch-Block, der ausgelöst wurde, fortgesetzt.

    Wenn eine Exception ausgelöst wird, führt PHP den Programmcode hinter der auslösenden Anweisung nicht aus, sondern versucht, den ersten passenden catch-Block zu finden. Falls eine Exception nicht abgefangen wird, wird ein fataler Fehler mit einer "Uncaught Exception ..."-Nachricht ausgegeben, sofern keine Behandlung mittels set_exception_handler() definiert wurde.

    Seit PHP 7.1.0 kann ein catch-Block mehrere Exceptions getrennt durch Pipe-Zeichen (|) angeben. Dies ist nützlich, wenn unterschiedliche Exceptions von unterschiedlichen Klassenhierarchien gleich behandelt werden sollen.

    Seit PHP 8.0.0 ist der Variablenname für eine abgefangene Exception optional. Wird er nicht angegeben, wird der catch-Block trotzdem ausgeführt, hat aber keinen Zugriff auf das ausgelöste Objekt.

    finally

    Ein finally-Block kann auch nach den catch-Blöcken oder stattdessen definiert werden. Egal, ob eine Exception ausgelöst wurde, wird der Code innerhalb des finally-Blocks immer nach den try- und catch-Blöcken ausgeführt, bevor die normale Ausführung fortgesetzt wird.

    Eine erwähnenswerte Wechselwirkung besteht zwischen dem finally-Block und einer return-Anweisung. Wird eine return-Anweisung innerhalb der try- oder catch-Blöcke angetroffen, wird der finally-Block dennoch ausgeführt. Außerdem wird die return-Anweisung ausgewertet, wenn sie angetroffen wird, aber das Ergebnis wird erst nach dem finally-Block zurückgegeben. Des Weiteren wird, wenn der finally-Block ebenfalls eine return-Anweisung enthält, der Wert aus dem finally-Block zurückgegeben.

    Der globale Exception-Handler

    Wenn eine Exception in den globalen Bereich aufsteigen darf, kann sie durch einen globalen Exception-Handler abgefangen werden, falls gesetzt. Die Funktion set_exception_handler() kann eine Funktion festlegen, die anstelle eines catch-Blocks aufgerufen wird, wenn kein anderer Block aufgerufen wird. Der Effekt ist im Wesentlichen derselbe, als ob das gesamte Programm in einen try-catch-Block mit dieser Funktion als catch verpackt wäre.

    Anmerkungen

    Hinweis:

    Interne PHP-Funktionen verwenden in den meisten Fällen Error-Reporting, nur moderne objektorientierte Erweiterungen nutzen Exceptions. Fehler können allerdings einfach mittels ErrorException in eine Exception umgewandelt werden. Diese Technik funktioniert jedoch nur bei nicht-fatalen Fehlern.

    Beispiel #1 Fehlermeldungen in Exceptions umwandeln

    <?php
    function exceptions_error_handler($severity, $message, $filename, $lineno) {
    throw new     ErrorException($message, 0, $severity, $filename, $lineno);
    }

    set_error_handler('exceptions_error_handler');
    ?>

    Tipp

    Die Standard PHP Library (SPL) bietet eine große Anzahl eingebauter Exceptions.

    Beispiele

    Beispiel #2 Eine Exception auslösen

    <?php
    function inverse($x) {
    if (!    $x) {
    throw new     Exception('Division durch Null.');
    }
    return     1/$x;
    }

    try {
    echo     inverse(5) . "\n";
    echo     inverse(0) . "\n";
    } catch (    Exception $e) {
    echo     'Exception abgefangen: ', $e->getMessage(), "\n";
    }

    // Ausführung fortsetzen
    echo "Hallo Welt\n";
    ?>

    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    0.2
Exception abgefangen: Division durch Null
Hallo Welt

    Beispiel #3 Exceptionbehandlung mit einem finally-Block

    <?php
    function inverse($x) {
    if (!    $x) {
    throw new     Exception('Division durch Null.');
    }
    return     1/$x;
    }

    try {
    echo     inverse(5) . "\n";
    } catch (    Exception $e) {
    echo     'Exception abgefangen: ', $e->getMessage(), "\n";
    } finally {
    echo     "Erstes finally.\n";
    }

    try {
    echo     inverse(0) . "\n";
    } catch (    Exception $e) {
    echo     'Exception abgefangen: ', $e->getMessage(), "\n";
    } finally {
    echo     "Zweites finally.\n";
    }

    // Ausführung fortsetzen
    echo "Hallo Welt\n";
    ?>

    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    0.2
Erstes finally.
Exception abgefangen: Division durch Null.
Zweites finally.
Hallo Welt

    Beispiel #4 Wechselwirkung zwischen dem finally-Block und return

    <?php

    function test() {
    try {
    throw new     Exception('foo');
    } catch (    Exception $e) {
    return     'catch';
    } finally {
    return     'finally';
    }
    }

    echo     test();
    ?>

    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    finally

    Beispiel #5 Verschachtelte Exceptions

    <?php

    class MyException extends Exception { }

    class     Test {
    public function     testing() {
    try {
    try {
    throw new     MyException('foo!');
    } catch (    MyException $e) {
    // Exception erneut auslösen
    throw $e;
    }
    } catch (    Exception $e) {
    var_dump($e->getMessage());
    }
    }
    }

    $foo = new Test;
    $foo->testing();

    ?>

    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    string(4) "foo!"

    Beispiel #6 Behandlung mehrerer Exceptions in einem Catch-Block

    <?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();

    ?>

    Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

    string(11) "MyException"

    Beispiel #7 Catch-Block ohne Angabe einer Variablen

    Erst ab PHP 8.0.0 erlaubt.

    <?php

    class SpecificException extends Exception {}

    function     test() {
    throw new     SpecificException('Oopsie');
    }

    try {
    test();
    } catch (    SpecificException) {
    print     "Eine SpecificException wurde ausgelöst, aber die Details interessieren uns nicht.";
    }
    ?>

    Beispiel #8 Als Ausdruck Auslösen

    Erst ab PHP 8.0.0 erlaubt.

    <?php

    function test() {
    do_something_risky() or throw new Exception('Es hat nicht funktioniert');
    }

    try {
    test();
    } catch (    Exception $e) {
    print     $e->getMessage();
    }
    ?>

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 13 notes

    up
    127
    ask at nilpo dot com
    15 years ago
    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}
    up
    12
    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
    up
    79
    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());
    }
    ?>
    up
    8
    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
    up
    24
    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).
    up
    15
    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();
    }
    ?>
    up
    27
    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
    up
    15
    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 );
    }

    ?>
    up
    15
    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.
    up
    16
    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
    ?>
    up
    11
    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 !"
    up
    8
    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.
    up
    9
    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/>";
    }

    ?>
    ＋add a note
    To Top