Наследование исключений

Определенный пользователем класс исключения должен быть определен, как класс расширяющий (наследующий) встроенный класс Exception. Ниже приведены методы и свойства класса Exception, доступные дочерним классам.

Пример #1 Встроеный класс Exception

<?php
class Exception
{
    protected 
$message 'Unknown exception';   // Сообшение
    
private   $string;                          // Свойство для __toString
    
protected $code 0;                        // Код исключения, 
                                                // определяемый пользователем
    
protected $file;                            // Файл в котором было
                                                // выброшено исключение
    
protected $line;                            // Строка в которой было
                                                // выброшено исключение
    
private   $trace;                           // Трассировка вызовов методов и функций 
    
private   $previous;                        // Предыдущее исключение, для
                                                // вложенных блоков try

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

    final private function 
__clone();           // Запрещает клонировать исключения

    
final public  function getMessage();        // Возвращает сообшение исключения 
    
final public  function getCode();           // Код исключения
    
final public  function getFile();           // Файл, где выброшено исключение
    
final public  function getLine();           // Строка, выбросившая исключени
    
final public  function getTrace();          // Массив backtrace()
    
final public  function getPrevious();       // Предыдущее исключение
    
final public  function getTraceAsString();  // Трассировка вызовов как строка

    // Переопределяемое
    
public function __toString();               // форматированная строка для отображения
}
?>

Если класс, наследуемый от Exception переопределяет конструктор, необходимо вызвать в конструкторе parent::__construct(), чтобы быть уверенным, что все дынные будут доступны. Метод __toString() может быть переопределен, что бы обеспечить нужный вывод, когда объект преобразуется в строку.

Замечание:

Исключения нельзя клонировать. Попытка клонировать исключение приведет к неисправимой ошибке E_ERROR.

Пример #2 Наследование класса Exception (PHP 5.3.0+)

<?php
/**
 * Определим свой класс исключения
 */
class MyException extends Exception
{
    
// Переопределим исключение так, что параметр message станет обязательным
    
public function __construct($message$code 0Exception $previous null) {
        
// некоторый код 
    
        // убедитесь, что все передаваемые параметры верны
        
parent::__construct($message$code$previous);
    }

    
// Переопределим строковое представление объекта.
    
public function __toString() {
        return 
__CLASS__ ": [{$this->code}]: {$this->message}\n";
    }

    public function 
customFunction() {
        echo 
"Мы можем определять новые методы в наследуемом классе\n";
    }
}


/**
 * Создадим класс для тестирования исключения
 */
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:
                
// Бросаем собственное исключение
                
throw new MyException('1 - неправильный параметр'5);
                break;

            case 
self::THROW_DEFAULT:
                
// Бросаем встроеное исключение
                
throw new Exception('2 - недопустимый параметр'6);
                break;

            default: 
                
// Никаких исключений, объект будет создан.
                
$this->var $avalue;
                break;
        }
    }
}


// Example 1
try {
    
$o = new TestException(TestException::THROW_CUSTOM);
} catch (
MyException $e) {      // Will be caught
    
echo "Поймано собственное переопределенное исключение\n"$e;
    
$e->customFunction();
} catch (
Exception $e) {        // Будет пропущено.
    
echo "Поймано встроенное исключение\n"$e;
}

// Отсюда будет продолжено выполнение программы
var_dump($o); // Null
echo "\n\n";


// Example 2
try {
    
$o = new TestException(TestException::THROW_DEFAULT);
} catch (
MyException $e) {      // Тип исключения не совпадет
    
echo "Поймано переопределенное исключение\n"$e;
    
$e->customFunction();
} catch (
Exception $e) {        // Будет перехвачено
    
echo "Перехвачено встроенное исключение\n"$e;
}

// Отсюда будет продолжено выполнение программы
var_dump($o); // Null
echo "\n\n";


// Example 3
try {
    
$o = new TestException(TestException::THROW_CUSTOM);
} catch (
Exception $e) {        // Будет перехвачено.
    
echo "Поймано встроенное исключение\n"$e;
}

// Продолжение исполнения программы
var_dump($o); // Null
echo "\n\n";


// Example 4
try {
    
$o = new TestException();
} catch (
Exception $e) {        // Будет пропущено, т.к. исключение не выбрасывается
    
echo "Поймано встроенное исключение\n"$e;
}

// Продолжение выполнения программы
var_dump($o); // TestException
echo "\n\n";
?>

Замечание:

PHP 5 до версии 5.3.0 не поддерживает вложенные исключения. Если есть необходимость запустить вышеприведенный пример в указанных версиях PHP, то нужно заменить класс MyException.

<?php
/**
 * Определим свой класс исключения
 */
class MyException extends Exception
{
    
// Переопределим исключение так, что параметр message станет обязательным
    
public function __construct($message$code 0) {
        
// некоторый код 
    
        // убедитесь, что все передаваемые параметры верны
        
parent::__construct($message$code);
    }

    
// Переопределим строковое представление объекта.
    
public function __toString() {
        return 
__CLASS__ ": [{$this->code}]: {$this->message}\n";
    }

    public function 
customFunction() {
        echo 
"Мы можем определять новые методы в наследуемом классе\n";
    }
}
?>

Коментарии

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==)
            {
                throw new 
myCustomException("i didnt like it");
            }
        }
    }

   
$obj = new testException(9);
    try{
   
       
$obj->see();
    }
    catch(
myCustomException $e)
    {
        echo 
$e;
    }
?>
2009-01-17 03:32:00
http://php5.kiev.ua/manual/ru/language.exceptions.extending.html
Автор:
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.
2009-11-24 09:37:44
http://php5.kiev.ua/manual/ru/language.exceptions.extending.html
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 0Exception $previous null)
    {
       
parent::__construct($message$code);
       
        if (!
is_null($previous))
        {
           
$this -> previous $previous;
        }
    }
   
    public function 
getPrevious()
    {
        return 
$this -> previous;
    }
}

?>

Hope you find it useful.
2009-12-31 17:17:53
http://php5.kiev.ua/manual/ru/language.exceptions.extending.html
Автор:
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 0Exception $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).
2011-10-15 17:30:47
http://php5.kiev.ua/manual/ru/language.exceptions.extending.html
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')
        );
}

?>
2012-10-15 07:55:58
http://php5.kiev.ua/manual/ru/language.exceptions.extending.html
Автор:
Not mentioned in the class structure on top of this site are the following members:

<?php
/**
 * @var string
 */
protected $string;

/**
 * @var array
 */
protected $trace;

/**
 * @var Exception
 */
protected $previous;
?>

... and these methods:

<?php
/**
 * @return Exception|null
 */
final public function getPrevious();
?>
2014-05-25 21:57:17
http://php5.kiev.ua/manual/ru/language.exceptions.extending.html
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 0Exception $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>
2014-12-14 02:57:07
http://php5.kiev.ua/manual/ru/language.exceptions.extending.html
Автор:
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.
2015-09-15 14:25:11
http://php5.kiev.ua/manual/ru/language.exceptions.extending.html

    Поддержать сайт на родительском проекте КГБ