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


Определенный пользователем класс исключения должен быть определен, как класс расширяющий (наследующий) встроенный класс 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";
    }
}
?>