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
private $string; // __toString-Cache
protected $code = 0; // Benutzerdefinierte Fehlernummer
protected $file; // Quelldateiname der Exception
protected $line; // Quelldateizeile der Exception
private $trace; // Rückverfolgung
private $previous; // Vorherige Exception, falls verschachtelte Exception
public function __construct($message = null, $code = 0, Exception $previous = null);
final private function __clone(); // Verhindert klonen von Exceptions
final public function getMessage(); // Mitteilung der Exception
final public function getCode(); // Fehlercode der Exception
final public function getFile(); // Quelldateiname
final public function getLine(); // Quelldateizeile
final public function getTrace(); // Array zum Rückverfolgen
final public function getPrevious(); // Vorherige Exception
final public function getTraceAsString(); // Formatierter String der Rückverfolgung
// Überschreibbar
public 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.
Hinweis:
Exceptions können nicht geklont werden. Der Versuch eine Exception zu klonen wird einen fatalen
E_ERROR-Fehler zur Folge haben.
Beispiel #2 Die Exceptionklasse erweitern (PHP 5.3.0+)
<?php
/**
* Eine maßgeschneiderte Exceptionklasse definieren
*/
class MyException extends Exception
{
// Die Exception neu definieren, damit die Mitteilung nicht optional ist
public function __construct($message, $code = 0, Exception $previous = null) {
// etwas Code
// sicherstellen, dass alles korrekt zugewiesen wird
parent::__construct($message, $code, $previous);
}
// 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); // Null
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); // Null
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); // Null
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); // TestException
echo "\n\n";
?>
Hinweis:
PHP 5-Versionen vor PHP 5.3.0 unterstützen keine verschachtelten Exceptions. Für das Beispiel kann der folgende Code-Schnipsel als Ersatz für die Klasse MyException verwendet werden.
<?php
/**
* Eine maßgeschneiderte Exceptionklasse definieren
*/
class MyException extends Exception
{
// Die Exception neu definieren, damit die Mitteilung 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";
}
}
?>