PHP Conference Japan 2024

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

Пользовательский класс исключения определяют путём расширения встроенного класса Exception. Ниже показаны методы и свойства класса Exception, которые доступны дочерним классам.

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

<?php

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

public function __construct($message = '', $code = 0, Throwable $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(); // Отформатированная строка для отображения
}

?>

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

Замечание:

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

Пример #2 Наследование класса Exception

<?php

/**
* Определим класс исключения
*/
class MyException extends Exception
{
// Переопределим исключение так, что параметр message станет обязательным
public function __construct($message, $code = 0, Throwable $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:
// Без исключения, PHP создаст объект
$this->var = $avalue;
break;
}
}
}

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

// Продолжить выполнение
var_dump($o); // Null
echo "\n\n";


// Пример 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";


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

// Продолжить выполнение
var_dump($o); // Null
echo "\n\n";


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

// Продолжить выполнение
var_dump($o); // TestException
echo "\n\n";

?>
Добавить

Примечания пользователей 6 notes

up
17
iamhiddensomewhere at gmail dot com
14 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
6
Hayley Watson
5 years 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
5
michaelrfairhurst at gmail dot com
12 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
4
sapphirepaw.org
15 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
Dor
13 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
-4
shaman_master at list dot ru
9 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>
To Top