PHP 8.3.4 Released!

Исключения

Содержание

Модель исключений PHP напоминает модель исключений других языков программирования. PHP умеет выбрасывать — throw — и ловить — catch — исключения. Код заключают в блок try, чтобы упростить обработку вероятных исключений. Каждому блоку try указывают как минимум один блок catch или finally.

Исключение будет «всплывать» по стеку вызовов функций, пока не найдёт блок catch, если функция выбросила исключение, а в текущей области видимости функции, которая её вызвала, нет блока catch. PHP выполнит каждый блок finally, который встретит по пути. Программа завершается фатальной ошибкой, когда стек вызовов не встречает блок catch и разворачивается до глобальной области видимости, если разработчик не установил глобальный обработчик исключений.

В коде допустимо выбрасывать только объект исключения, тип которого при проверке оператором instanceof соответствует интерфейсу Throwable. Попытка выбросить объект, который не выполняет это условие, приведёт к фатальной ошибке PHP.

С PHP 8.0.0 ключевое слово throw стало выражением, которое разрешили записывать в контексте выражения. В предыдущих версиях это слово было инструкцией и её записывали в отдельной строке.

catch

Блок catch определяет, как реагировать на исключение, которое выбросил код. Блок catch определяет один или больше типов исключений или ошибок, которые он обрабатывает, и необязательную переменную, которой блок присвоит исключение. До PHP 8.0.0 переменную требовалось указывать. Объект исключения обработает первый блок catch, с которым столкнутся исключение или ошибка того типа или подтипа, который ожидает блок.

Блоки catch записывают один за другим, чтобы перехватывать исключения разных классов. Нормальное выполнение, когда блок try не выбросил исключение, продолжится после последнего блока catch, который определили в последовательности. Внутри блока catch допустимо выбрасывать, а точнее — повторно выбрасывать исключения через ключевое слово throw. PHP продолжит выполнение кода после блока catch, который сработал, если внутри блока не выбросили исключение.

При появлении исключения PHP не выполнит код, который идёт за инструкцией, а попытается найти первый подходящий блок catch. PHP выдаст фатальную ошибку с сообщением Uncaught Exception ..., если исключение не поймали и через функцию set_exception_handler() не определили обработчик исключений.

С PHP 7.1.0 в блоке catch допустимо указывать исключения через символ вертикальной черты |. Это полезно, когда разные исключения из разных иерархий классов обрабатывают одинаково.

С PHP 8.0.0 имя переменной для исключения, которое поймал блок, необязательно. PHP выполнит блок catch, но у блока не будет доступа к объекту, который выбросил код, если переменную не указали.

finally

Блок finally также допустимо указывать после или вместо блоков catch. PHP выполнит код в блоке finally после блоков try и catch, независимо от того, выбросил ли код исключение, и до возобновления нормального выполнения.

Заслуживает внимания взаимодействие между блоком finally и инструкцией return. PHP выполнит блок finally, даже если встретит внутри блоков try или catch инструкцию return. Больше того, когда PHP встречает инструкцию return, он вычисляет её, но вернёт результат после выполнения блока finally. Кроме того, PHP вернёт значение из блока finally, если блок finally тоже содержит инструкцию return.

Глобальный обработчик исключений

Глобальный обработчик исключений, если обработчик установили, перехватит исключение, если исключению разрешили всплывать до глобальной области видимости. Функция set_exception_handler() устанавливает функцию, которую PHP вызовет вместо блока catch, если в коде не вызвали другие блоки. Эффект по существу такой же, как если бы всю программу обернули в блок try-catch с этой функцией в качестве catch.

Примечания

Замечание:

Внутренние функции PHP чаще сообщают об ошибках через отчёт об ошибках, только современные объектно-ориентированные модули работают с исключениями. При этом ошибки легко переводятся в исключения через класс ErrorException. Эта техника, однако, работает только с нефатальными ошибками.

Пример #1 Преобразование отчётов об ошибках в исключения

<?php

function exceptions_error_handler($severity, $message, $filename, $lineno) {
throw new
ErrorException($message, 0, $severity, $filename, $lineno);
}

set_error_handler('exceptions_error_handler');

?>

Примеры

Пример #2 Выброс исключения

<?php

function inverse($x) {
if (!
$x) {
throw new
Exception('Деление на ноль.');
}
return
1 / $x;
}

try {
echo
inverse(5) . "\n";
echo
inverse(0) . "\n";
} catch (
Exception $e) {
echo
'PHP перехватил исключение: ', $e->getMessage(), "\n";
}

// Продолжить выполнение
echo "Привет, мир\n";

?>

Результат выполнения приведённого примера:

0.2
PHP перехватил исключение: Деление на ноль.
Привет, мир

Пример #3 Обработка исключений в блоке finally

<?php

function inverse($x) {
if (!
$x) {
throw new
Exception('Деление на ноль.');
}
return
1 / $x;
}

try {
echo
inverse(5) . "\n";
} catch (
Exception $e) {
echo
'PHP перехватил исключение: ', $e->getMessage(), "\n";
} finally {
echo
"Первый блок finally.\n";
}

try {
echo
inverse(0) . "\n";
} catch (
Exception $e) {
echo
'PHP перехватил исключение: ', $e->getMessage(), "\n";
} finally {
echo
"Второй блок finally.\n";
}

// Продолжить выполнение
echo "Привет, мир\n";

?>

Результат выполнения приведённого примера:

0.2
Первый блок finally.
PHP перехватил исключение: Деление на ноль.
Второй блок finally.
Привет, мир

Пример #4 Взаимодействие между блоками finally и return

<?php

function test() {
try {
throw new
Exception('foo');
} catch (
Exception $e) {
return
'catch';
} finally {
return
'finally';
}
}

echo
test();

?>

Результат выполнения приведённого примера:

finally

Пример #5 Вложенные исключения

<?php

class MyException extends Exception { }

class
Test {
public function
testing() {
try {
try {
throw new
MyException('foo!');
} catch (
MyException $e) {
// Повторный выброс исключения
throw $e;
}
} catch (
Exception $e) {
var_dump($e->getMessage());
}
}
}

$foo = new Test;
$foo->testing();

?>

Результат выполнения приведённого примера:

string(4) "foo!"

Пример #6 Обработка нескольких исключений в одном блоке catch

<?php

class MyException extends Exception { }

class
MyOtherException extends Exception { }

class
Test {
public function
testing() {
try {
throw new
MyException();
} catch (
MyException | MyOtherException $e) {
var_dump(get_class($e));
}
}
}

$foo = new Test;
$foo->testing();

?>

Результат выполнения приведённого примера:

string(11) "MyException"

Пример #7 Пример блока catch без переменной

Разрешено только в PHP 8.0.0 и более поздних версиях.

<?php

class SpecificException extends Exception {}

function
test() {
throw new
SpecificException('Ой!');
}

try {
test();
} catch (
SpecificException) {
print
"Функция выбросила исключение SpecificException, но детали исключения неважны.";
}

?>

Пример #8 Throw как выражение

Разрешено только в PHP 8.0.0 и более поздних версиях.

<?php

function test() {
do_something_risky() or throw new Exception('Всё сломалось');
}

try {
test();
} catch (
Exception $e) {
print
$e->getMessage();
}

?>
add a note

User Contributed Notes 15 notes

up
118
ask at nilpo dot com
14 years ago
If you intend on creating a lot of custom exceptions, you may find this code useful. I've created an interface and an abstract exception class that ensures that all parts of the built-in Exception class are preserved in child classes. It also properly pushes all information back to the parent constructor ensuring that nothing is lost. This allows you to quickly create new exceptions on the fly. It also overrides the default __toString method with a more thorough one.

<?php
interface IException
{
/* Protected methods inherited from Exception class */
public function getMessage(); // Exception message
public function getCode(); // User-defined Exception code
public function getFile(); // Source filename
public function getLine(); // Source line
public function getTrace(); // An array of the backtrace()
public function getTraceAsString(); // Formated string of trace

/* Overrideable methods inherited from Exception class */
public function __toString(); // formated string for display
public function __construct($message = null, $code = 0);
}

abstract class
CustomException extends Exception implements IException
{
protected
$message = 'Unknown exception'; // Exception message
private $string; // Unknown
protected $code = 0; // User-defined exception code
protected $file; // Source filename of exception
protected $line; // Source line of exception
private $trace; // Unknown

public function __construct($message = null, $code = 0)
{
if (!
$message) {
throw new
$this('Unknown '. get_class($this));
}
parent::__construct($message, $code);
}

public function
__toString()
{
return
get_class($this) . " '{$this->message}' in {$this->file}({$this->line})\n"
. "{$this->getTraceAsString()}";
}
}
?>

Now you can create new exceptions in one line:

<?php
class TestException extends CustomException {}
?>

Here's a test that shows that all information is properly preserved throughout the backtrace.

<?php
function exceptionTest()
{
try {
throw new
TestException();
}
catch (
TestException $e) {
echo
"Caught TestException ('{$e->getMessage()}')\n{$e}\n";
}
catch (
Exception $e) {
echo
"Caught Exception ('{$e->getMessage()}')\n{$e}\n";
}
}

echo
'<pre>' . exceptionTest() . '</pre>';
?>

Here's a sample output:

Caught TestException ('Unknown TestException')
TestException 'Unknown TestException' in C:\xampp\htdocs\CustomException\CustomException.php(31)
#0 C:\xampp\htdocs\CustomException\ExceptionTest.php(19): CustomException->__construct()
#1 C:\xampp\htdocs\CustomException\ExceptionTest.php(43): exceptionTest()
#2 {main}
up
6
tianyiw at vip dot qq dot com
6 months ago
Easy to understand `finally`.
<?php
try {
try {
echo
"before\n";
1 / 0;
echo
"after\n";
} finally {
echo
"finally\n";
}
} catch (
\Throwable) {
echo
"exception\n";
}
?>
# Print:
before
finally
exception
up
80
Johan
12 years ago
Custom error handling on entire pages can avoid half rendered pages for the users:

<?php
ob_start
();
try {
/*contains all page logic
and throws error if needed*/
...
} catch (
Exception $e) {
ob_end_clean();
displayErrorPage($e->getMessage());
}
?>
up
22
Shot (Piotr Szotkowski)
15 years ago
‘Normal execution (when no exception is thrown within the try block, *or when a catch matching the thrown exception’s class is not present*) will continue after that last catch block defined in sequence.’

‘If an exception is not caught, a PHP Fatal Error will be issued with an “Uncaught Exception …” message, unless a handler has been defined with set_exception_handler().’

These two sentences seem a bit contradicting about what happens ‘when a catch matching the thrown exception’s class is not present’ (and the second sentence is actually correct).
up
13
daviddlowe dot flimm at gmail dot com
6 years ago
Starting in PHP 7, the classes Exception and Error both implement the Throwable interface. This means, if you want to catch both Error instances and Exception instances, you should catch Throwable objects, like this:

<?php

try {
throw new
Error( "foobar" );
// or:
// throw new Exception( "foobar" );
}
catch (
Throwable $e) {
var_export( $e );
}

?>
up
12
christof+php[AT]insypro.com
6 years ago
In case your E_WARNING type of errors aren't catchable with try/catch you can change them to another type of error like this:

<?php
set_error_handler
(function($errno, $errstr, $errfile, $errline){
if(
$errno === E_WARNING){
// make it more serious than a warning so it can be caught
trigger_error($errstr, E_ERROR);
return
true;
} else {
// fallback to default php error handler
return false;
}
});

try {
// code that might result in a E_WARNING
} catch(Exception $e){
// code to handle the E_WARNING (it's actually changed to E_ERROR at this point)
} finally {
restore_error_handler();
}
?>
up
21
Edu
10 years ago
The "finally" block can change the exception that has been throw by the catch block.

<?php
try{
try {
throw new
\Exception("Hello");
} catch(
\Exception $e) {
echo
$e->getMessage()." catch in\n";
throw
$e;
} finally {
echo
$e->getMessage()." finally \n";
throw new
\Exception("Bye");
}
} catch (
\Exception $e) {
echo
$e->getMessage()." catch out\n";
}
?>

The output is:

Hello catch in
Hello finally
Bye catch out
up
9
mlaopane at gmail dot com
6 years ago
<?php

/**
* You can catch exceptions thrown in a deep level function
*/

function employee()
{
throw new
\Exception("I am just an employee !");
}

function
manager()
{
employee();
}

function
boss()
{
try {
manager();
} catch (
\Exception $e) {
echo
$e->getMessage();
}
}

boss(); // output: "I am just an employee !"
up
11
Simo
8 years ago
#3 is not a good example. inverse("0a") would not be caught since (bool) "0a" returns true, yet 1/"0a" casts the string to integer zero and attempts to perform the calculation.
up
10
telefoontoestel at nospam dot org
9 years ago
When using finally keep in mind that when a exit/die statement is used in the catch block it will NOT go through the finally block.

<?php
try {
echo
"try block<br />";
throw new
Exception("test");
} catch (
Exception $ex) {
echo
"catch block<br />";
} finally {
echo
"finally block<br />";
}

// try block
// catch block
// finally block
?>

<?php
try {
echo
"try block<br />";
throw new
Exception("test");
} catch (
Exception $ex) {
echo
"catch block<br />";
exit(
1);
} finally {
echo
"finally block<br />";
}

// try block
// catch block
?>
up
8
Tom Polomsk
9 years ago
Contrary to the documentation it is possible in PHP 5.5 and higher use only try-finally blocks without any catch block.
up
6
Sawsan
12 years ago
the following is an example of a re-thrown exception and the using of getPrevious function:

<?php

$name
= "Name";

//check if the name contains only letters, and does not contain the word name

try
{
try
{
if (
preg_match('/[^a-z]/i', $name))
{
throw new
Exception("$name contains character other than a-z A-Z");
}
if(
strpos(strtolower($name), 'name') !== FALSE)
{
throw new
Exception("$name contains the word name");
}
echo
"The Name is valid";
}
catch(
Exception $e)
{
throw new
Exception("insert name again",0,$e);
}
}

catch (
Exception $e)
{
if (
$e->getPrevious())
{
echo
"The Previous Exception is: ".$e->getPrevious()->getMessage()."<br/>";
}
echo
"The Exception is: ".$e->getMessage()."<br/>";
}

?>
up
-1
lscorionjs at gmail dot com
1 year ago
<?php

try {
$str = 'hi';
throw new
Exception();
} catch (
Exception) {
var_dump($str);
} finally {
var_dump($str);
}

?>

Output:
string(2) "hi"
string(2) "hi"
up
-1
ilia-yats at ukr dot net
1 year ago
Note some undocumented details about exceptions thrown from 'finally' blocks.

When exception is thrown from 'finally' block, it overrides the original not-caught (or re-thrown) exception. So the behavior is similar to 'return': value returned from 'finally' overrides the one returned earlier. And the original exception is automatically appended to the exceptions chain, i.e. becomes 'previous' for the new one. Example:
<?php
try {
try {
throw new
Exception('thrown from try');
} finally {
throw new
Exception('thrown from finally');
}
} catch(
Exception $e) {
echo
$e->getMessage();
echo
PHP_EOL;
echo
$e->getPrevious()->getMessage();
}

// will output:
// thrown from finally
// thrown from try
?>

Example with re-throwing:
<?php
try {
try {
throw new
Exception('thrown from try');
} catch (
Exception $e) {
throw new
Exception('thrown from catch');
} finally {
throw new
Exception('thrown from finally');
}
} catch(
Exception $e) {
echo
$e->getMessage();
echo
PHP_EOL;
echo
$e->getPrevious()->getMessage();
}

// will output:
// thrown from finally
// thrown from catch
?>

The same happens even if explicitly pass null as previous exception:
<?php
try {
try {
throw new
Exception('thrown from try');
} finally {
throw new
Exception('thrown from finally', null, null);
}
} catch(
Exception $e) {
echo
$e->getMessage();
echo
PHP_EOL;
echo
$e->getPrevious()->getMessage();
}

// will output:
// thrown from finally
// thrown from try
?>

Also it is possible to pass previous exception explicitly, the 'original' one will be still appended to the chain, e.g.:
<?php
try {
try {
throw new
Exception('thrown from try');
} finally {
throw new
Exception(
'thrown from finally',
null,
new
Exception('Explicitly set previous!')
);
}
} catch(
Exception $e) {
echo
$e->getMessage();
echo
PHP_EOL;
echo
$e->getPrevious()->getMessage();
echo
PHP_EOL;
echo
$e->getPrevious()->getPrevious()->getMessage();
}

// will output:
// thrown from finally
// Explicitly set previous!
// thrown from try
?>

This seems to be true for versions 5.6-8.2.
up
-1
jlherren
1 month ago
As noted elsewhere, throwing an exception from the `finally` block will replace a previously thrown exception. But the original exception is magically available from the new exception's `getPrevious()`.

<?php
try {
try {
throw new
RuntimeException('Exception A');
} finally {
throw new
RuntimeException('Exception B');
}
}
catch (
Throwable $exception) {
echo
$exception->getMessage(), "\n";
// 'previous' is magically available!
echo $exception->getPrevious()->getMessage(), "\n";
}
?>

Will print:

Exception B
Exception A
To Top