PHP Doku:: Exceptions erweitern - language.exceptions.extending.html

Verlauf / Chronik / History: (1) anzeigen

Sie sind hier:
Doku-StartseitePHP-HandbuchSprachreferenzAusnahmebehandlungExceptions erweitern

Ein Service von Reinhard Neidl - Webprogrammierung.

Ausnahmebehandlung

<<Ausnahmebehandlung

Referenzen in PHP>>

Exceptions erweitern

Eine benutzerdefinierte Exceptionklasse kann durch Ableitung von der eingebauten Exceptionklasse erstellt werden. Die unten angegebenen Methoden und Eigenschaften zeigen, was innerhalb der Kindklasse von der eingebauten Exceptionklasse verfügbar ist.

Beispiel #1 Die eingebaute Exceptionklasse

<?php
class Exception
{
    protected 
$message 'Unknown exception';   // Exceptionmitteilung
    
protected $code 0;                        // Benutzerdefinierte Fehlernummer
    
protected $file;                            // Quelldateiname der Exception
    
protected $line;                            // Quelldateizeile der Exception

    
function __construct($message null$code 0);

    final function 
getMessage();                // Mitteilung der Exception
    
final function getCode();                   // Fehlercode der Exception
    
final function getFile();                   // Quelldateiname
    
final function getLine();                   // Quelldateizeile
    
final function getTrace();                  // Array zum Rückverfolgen
    
final function getTraceAsString();          // Formatierter String der
                                                // Rückverfolgung

    /* Überschreibbar */
    
function __toString();                       // Formatierter String für
                                                 // Ausgabe
}
?>

Wenn eine Klasse die eingebaute Exceptionklasse erweitert und den Konstruktor neu definiert, ist es dringend empfohlen, dass der Konstruktor der Klasse parent::__construct() aufruft, um sicherzustellen, dass alle verfügbaren Daten korrekt zugewiesen wurden. Die __toString()-Methode kann überschrieben werden, um eine maßgeschneiderte Ausgabe anzubieten, wenn das Objekt durch eine Zeichenkette repräsentiert werden soll.

Beispiel #2 Die Exceptionklasse erweitern

<?php
/**
 * Eine maßgeschneiderte Exceptionklasse definieren
 */
class MyException extends Exception
{
    
// Die Exceptionmitteilung neu definieren, damit diese nicht optional ist
    
public function __construct($message$code 0) {
        
// etwas Code

        // sicherstellen, dass alles korrekt zugewiesen wird
        
parent::__construct($message$code);
    }

    
// maßgeschneiderte Stringdarstellung des Objektes
    
public function __toString() {
        return 
__CLASS__ ": [{$this->code}]: {$this->message}\n";
    }

    public function 
customFunction() {
        echo 
"Eine eigene Funktion dieses Exceptiontyps\n";
    }
}


/**
 * Erzeuge eine Klasse, um die Exception zu testen
 */
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:
                
// eigene Exception werfen
                
throw new MyException('1 ist ein ungültiger Parameter'5);
                break;

            case 
self::THROW_DEFAULT:
                
// Vorgabe werfen
                
throw new Exception('2 ist kein zugelassener Parameter'6);
                break;

            default:
                
// Keine Exception, das Objekt wird erzeugt
                
$this->var $avalue;
                break;
        }
    }
}


// Beispiel 1
try {
    
$o = new TestException(TestException::THROW_CUSTOM);
} catch (
MyException $e) {      // Wird gefangen
    
echo "Meine Exception gefangen\n"$e;
    
$e->customFunction();
} catch (
Exception $e) {        // Übersprungen
    
echo "Standardexception gefangen\n"$e;
}

// Ausführung fortsetzen
var_dump($o);
echo 
"\n\n";


// Beispiel 2
try {
    
$o = new TestException(TestException::THROW_DEFAULT);
} catch (
MyException $e) {      // Dieser Typ passt nicht
    
echo "Meine Exception gefangen\n"$e;
    
$e->customFunction();
} catch (
Exception $e) {        // Wird gefangen
    
echo "Standardexception gefangen\n"$e;
}

// Ausführung fortsetzen
var_dump($o);
echo 
"\n\n";


// Beispiel 3
try {
    
$o = new TestException(TestException::THROW_CUSTOM);
} catch (
Exception $e) {        // Wird gefangen
    
echo "Standardexception gefangen\n"$e;
}

// Ausführung fortsetzen
var_dump($o);
echo 
"\n\n";


// Beispiel 4
try {
    
$o = new TestException();
} catch (
Exception $e) {        // Übersprungen, keine Exception ausgelöst
    
echo "Standardexception gefangen\n"$e;
}

// Ausführung fortsetzen
var_dump($o);
echo 
"\n\n";
?>

4 BenutzerBeiträge:
- Beiträge aktualisieren...
joechrz at gmail dot com
19.02.2010 0:18
It's important to note some unexpected behavior when overriding the __toString method of an Exception.  The default PHP exception handler will truncate the result of the __toString method to the number of bytes specified by log_errors_max_len in php.ini. 

To get around this problem, you need to either change the value of log_errors_max_len:

<?php
   
// recommended: disable error logging
    // so the log files don't become bloated from huge
    // exception strings
   
ini_set('log_errors','off');

   
// log_errors_max_len = infinite length
   
ini_set("log_errors_max_len",0);
?>

or specify a custom exception handler:
<?php
   
function long_exception_handler($exception) {
       
// for compatibility, call __toString
       
echo $exception->__toString();
    }
   
set_exception_handler('long_exception_handler');
?>
iamhiddensomewhere at gmail dot com
1.01.2010 0:17
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.
sapphirepaw.org
24.11.2009 16:37
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.
paragdiwan at gmail dot com
17.01.2009 10:32
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;
    }
?>



PHP Powered Diese Seite bei php.net
The PHP manual text and comments are covered by the Creative Commons Attribution 3.0 License © the PHP Documentation Group - Impressum - mail("TO:Reinhard Neidl",...)