Rozszerzanie wyjątków

Użytkownik może zdefiniować klasę wyjątku poprzez rozszerzenie wbudowanej klasy Exception. Metody i właściwości poniżej pokazują co jest dostępne w klasie potomnej, która dziedziczy po wbudowanej klasie Exception.

Przykład #1 Wbudowana klasa Exception

<?php
class Exception extends Throwable
{
    protected 
$message 'Unknown exception';   // wiadomość wyjątku
    
private   $string;                          // metoda __toString
    
protected $code 0;                        // kod wyjątku zdefiniowany przez użytkownika
    
protected $file;                            // plik, w którym wystąpił wyjątek
    
protected $line;                            // linia, w której wystąpił wyjątek
    
private   $trace;                           // backtrace
    
private   $previous;                        // poprzedni wyjątek, jeżeli zostały one zagnieżdżone

    
public function __construct($message null$code 0Exception $previous null);

    final private function 
__clone();           // powstrzymuje przed klonowaniem wyjątków

    
final public  function getMessage();        // wiadomość wyjąku
    
final public  function getCode();           // kod wyjątku
    
final public  function getFile();           // nazwa pliku źródłowego
    
final public  function getLine();           // linia źródłowa
    
final public  function getTrace();          // tablica backtrace()
    
final public  function getPrevious();       // poprzedni wyjątek
    
final public  function getTraceAsString();  // ślad sformatowany jako łańcuch znaków

    // Nadpisywalne
    
public function __toString();               // sformatowany string gotowy do wyświetlenia
}
?>

Jeżeli rozszerzana jest wbudowana klasa Exception i nadpisywany jest konstruktor, to zdecydowanie zaleca się aby wywoływał on również parent::__construct(), aby mieć pewność że wszystkie dostępne dane zostały prawidłowo przypisane. Metoda __toString() może zostać nadpisana, aby określić własny format wyjścia, gdy obiekt jest prezentowany jako string.

Informacja:

Wyjątki nie mogą być klonowane. Próba sklonowania klasy Exception skończy się błędem krytycznym E_ERROR.

Przykład #2 Rozszerzanie klasy Exception (PHP 5.3.0+)

<?php
/**
 * Definiujemy własną klasę wyjątku
 */
class MyException extends Exception
{
    
// Zredefiniuj konstruktor tak, aby wiadomość wyjątku była obowiązkowa
    
public function __construct($message$code 0Exception $previous null) {
        
// jakiś kod
    
        // upewnij się, że wszystko jest przypisane poprawnie
        
parent::__construct($message$code$previous);
    }

    
// własna reprezentacja tekstowa obiektu
    
public function __toString() {
        return 
__CLASS__ ": [{$this->code}]: {$this->message}\n";
    }

    public function 
customFunction() {
        echo 
"Własna funkcja dla tego typu wyjątku\n";
    }
}


/**
 * Tworzymy klasę, aby przetestować wyjątek
 */
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:
                
// rzuć własny wyjątek
                
throw new MyException('Pierwszy parametr jest niepoprawny'5);
                break;

            case 
self::THROW_DEFAULT:
                
// throw default one.
                
throw new Exception('2 nie jest dozwolone jako parametr'6);
                break;

            default: 
                
// Brak wyjątku, zostnie stworzony obiekt.
                
$this->var $avalue;
                break;
        }
    }
}


// Przykład 1
try {
    
$o = new TestException(TestException::THROW_CUSTOM);
} catch (
MyException $e) {      // Będzie złapany
    
echo "Złapałem swój wyjątek\n"$e;
    
$e->customFunction();
} catch (
Exception $e) {        // Ten blok będzie pominięty
    
echo "Złapano domyślny wyjątek\n"$e;
}

// Kontynuuj wykonywanie skryptu
var_dump($o); // Null
echo "\n\n";


// Przykład 2
try {
    
$o = new TestException(TestException::THROW_DEFAULT);
} catch (
MyException $e) {      // Wyjątek nie pasuje do określonego typu
    
echo "Złapałem swój wyjątek\n"$e;
    
$e->customFunction();
} catch (
Exception $e) {        // Będzie złapany
    
echo "Złapano domyślny wyjątek\n"$e;
}

// Kontynuuj wykonywanie skryptu
var_dump($o); // Null
echo "\n\n";


// Przykład 3
try {
    
$o = new TestException(TestException::THROW_CUSTOM);
} catch (
Exception $e) {        // Będzie złapany
    
echo "Złapano domyślny wyjątek\n"$e;
}

// Kontynuuj wykonywanie skryptu
var_dump($o); // Null
echo "\n\n";


// Przykład 4
try {
    
$o = new TestException();
} catch (
Exception $e) {        // Blok ominięty, brak wyjątków
    
echo "Złapano domyślny wyjątek\n"$e;
}

// Kontynuuj wykonywanie skryptu
var_dump($o); // TestException
echo "\n\n";
?>

Informacja:

Wersje PHP 5 poniżej PHP 5.3.0 nie wspierają zagnieżdżania wyjątku. Jeżeli chcesz uruchomić ten przykład, poniższy kod może być użyty jako zastępstwo dla klasy MyException.

<?php
/**
 * Define a custom exception class
 */
class MyException extends Exception
{
    
// Ponownie zdefiniuj konstruktor wyjątku, aby wiadomość ($message) nie była opcjonalna
    
public function __construct($message$code 0) {
        
// jakiś kod
    
        // upewnij się, że wszystko jest przypisane poprawnie
        
parent::__construct($message$code);
    }

    
// własna reprezentacja obiektu jako ciąg znaków
    
public function __toString() {
        return 
__CLASS__ ": [{$this->code}]: {$this->message}\n";
    }

    public function 
customFunction() {
        echo 
"Własna funkcja dla tego typu wyjątku\n";
    }
}
?>

add a note add a note

User Contributed Notes 8 notes

up
12
iamhiddensomewhere at gmail dot com
10 years ago
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.
up
4
sapphirepaw.org
10 years ago
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.
up
1
michaelrfairhurst at gmail dot com
7 years ago
Custom exception classes can allow you to write tests that prove your exceptions
are meaningful. Usually testing exceptions, you either assert the message equals
something in which case you can't change the message format without refactoring,
or not make any assertions at all in which case you can get misleading messages
later down the line. Especially if your $e->getMessage is something complicated
like a var_dump'ed context array.

The solution is to abstract the error information from the Exception class into
properties that can be tested everywhere except the one test for your formatting.

<?php

class TestableException extends Exception {

        private
$property;

        function
__construct($property) {

               
$this->property = $property;
               
parent::__construct($this->format($property));

        }

        function
format($property) {
                return
"I have formatted: " . $property . "!!";
        }

        function
getProperty() {
                return
$this->property;
        }

}

function
testSomethingThrowsTestableException() {
        try {
                throw new
TestableException('Property');
        } Catch (
TestableException $e) {
               
$this->assertEquals('Property', $e->getProperty());
        }
}

function
testExceptionFormattingOnlyOnce() {
       
$e = new TestableException;
       
$this->assertEquals('I have formatted: properly for the only required test!!',
               
$e->format('properly for the only required test')
        );
}

?>
up
0
Hayley Watson
1 year ago
Check the other SPL Exception classes and extend one of those if your intended exception is a subclass of one of those. This allows more finesse when catching.
up
-1
Dor
8 years ago
It's important to note that subclasses of the Exception class will be caught by the default Exception handler

<?php
   
   
/**
     * NewException
     * Extends the Exception class so that the $message parameter is now mendatory.
     *
     */
   
class NewException extends Exception {
       
//$message is now not optional, just for the extension.
       
public function __construct($message, $code = 0, Exception $previous = null) {
           
parent::__construct($message, $code, $previous);
        }
    }
   
   
/**
     * TestException
     * Tests and throws Exceptions.
     */
   
class TestException {
        const
NONE = 0;
        const
NORMAL = 1;
        const
CUSTOM = 2;
        public function
__construct($type = self::NONE) {
            switch (
$type) {
                case
1:
                    throw new
Exception('Normal Exception');
                    break;
                case
2:
                    throw new
NewException('Custom Exception');
                    break;
                default:
                    return
0; //No exception is thrown.
           
}
        }
    }
   
    try {
       
$t = new TestException(TestException::CUSTOM);
    }
    catch (
Exception $e) {
       
print_r($e); //Exception Caught
   
}
   
?>

Note that if an Exception is caught once, it won't be caught again (even for a more specific handler).
up
-8
florenxe
4 years ago
I just wanted to add that "extends" is same concept of "Inheritance" or "Prototyping in Javascript". So when you extend a class, you are simply inheriting the class's methods and properties. So you can create custom classes from existing classes like extending the array class.
up
-8
shaman_master at list dot ru
5 years ago
Use this example for not numeric codes:
<code>
<?php
class MyException extends Exception
{
   
/**
     * Creates a new exception.
     *
     * @param string       $message   Error message
     * @param mixed       $code         The exception code
     * @param Exception $previous  Previous exception
     * @return void
     */
   
public function __construct($message = '', $code = 0, Exception $previous = null)
    {
       
// Pass the message and integer code to the parent
       
parent::__construct((string)$message, (int)$code, $previous);

       
// @link http://bugs.php.net/39615 Save the unmodified code
       
$this->code = $code;
    }
}
</
code>
up
-21
paragdiwan at gmail dot com
11 years ago
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;
    }
?>
To Top