(PHP 4 >= 4.0.1, PHP 5)
set_error_handler — 設置一個用戶定義的錯誤處理函數
說明
mixed set_error_handler ( callable$error_handler
[, int $error_types
= E_ALL | E_STRICT
] )
設置一個用戶的函數(error_handler
)來處理腳本中出現的錯誤。
本函數可以用你自己定義的方式來處理運行中的錯誤, 例如,在應用程序中嚴重錯誤發生時,或者在特定條件下觸發了一個錯誤(使用 trigger_error()),你需要對數據/文件做清理回收。
重要的是要記住 error_types
里指定的錯誤類型都會繞過 PHP 標準錯誤處理程序,
除非回調函數返回了 FALSE
。
error_reporting() 設置將不會起到作用而你的錯誤處理函數繼續會被調用
—— 不過你仍然可以獲取 error_reporting 的當前值,并做適當處理。
需要特別注意的是帶 @ error-control
operator 前綴的語句發生錯誤時,這個值會是 0。
同時注意,在需要時你有責任使用 die()。 如果錯誤處理程序返回了,腳本將會繼續執行發生錯誤的后一行。
以下級別的錯誤不能由用戶定義的函數來處理:
E_ERROR
、 E_PARSE
、
E_CORE_ERROR
、 E_CORE_WARNING
、
E_COMPILE_ERROR
、
E_COMPILE_WARNING
,和在
調用 set_error_handler() 函數所在文件中產生的大多數
E_STRICT
。
如果錯誤發生在腳本執行之前(比如文件上傳時),將不會 調用自定義的錯誤處理程序因為它尚未在那時注冊。
參數
error_handler
用戶的函數需要接受兩個參數:錯誤碼和描述錯誤的 string。 另外有可能提供三個可選參數:發生錯誤的文件名、發生錯誤的行號 以及發生錯誤的上下文(一個指向錯誤發生時活動符號表的 array)。 該函數可以表示為:
handler
( int $errno
, string $errstr
[, string $errfile
[, int $errline
[, array $errcontext
]]] )
errno
第一個參數 errno
,包含了錯誤的級別,是一個 integer。
errstr
第二個參數 errstr
,包含了錯誤的信息,是一個 string。
errfile
第三個參數是可選的,errfile
,
包含了發生錯誤的文件名,是一個 string。
errline
第四個參數是一個可選項, errline
,
包含了錯誤發生的行號,是一個 integer。
errcontext
第五個可選參數, errcontext
,
是一個指向錯誤發生時活動符號表的 array。
也就是說,errcontext
會包含錯誤觸發處作用域內所有變量的數組。
用戶的錯誤處理程序不應該修改錯誤上下文(context)。
如果函數返回 FALSE
,標準錯誤處理處理程序將會繼續調用。
error_types
就像error_reporting 的 ini 設置能夠控制錯誤的顯示一樣,
此參數能夠用于屏蔽 error_handler
的觸發。
如果沒有該掩碼,
無論 error_reporting 是如何設置的,
error_handler
都會在每個錯誤發生時被調用。
返回值
如果之前有定義過錯誤處理程序,則返回該程序名稱的 string;如果是內置的錯誤處理程序,則返回 NULL
。
如果你指定了一個無效的回調函數,同樣會返回 NULL
。
如果之前的錯誤處理程序是一個類的方法,此函數會返回一個帶類和方法名的索引數組(indexed array)。
更新日志
版本
說明
5.2.0
錯誤處理器必須返回 FALSE
來顯示
$php_errormsg。
5.0.0
引入 error_types
參數。
4.3.0
除了一個函數名,也可以使用一個包含對象引用和方法名的數組來作為
error_handler
。
4.0.2
為用戶的 error_handler
引入三個可選參數,
分別是文件名、行號和上下文(context)。
范例
Example #1 用 set_error_handler() 和 trigger_error() 進行錯誤處理
以下示例展示了通過觸發錯誤并以用戶自定義的程序來進行內部異常的處理。
<?php
// error handler function
function myErrorHandler($errno, $errstr, $errfile, $errline)
{
if (!(error_reporting() & $errno)) {
// This error code is not included in error_reporting
return;
}
switch ($errno) {
case E_USER_ERROR:
echo "<b>My ERROR</b> [$errno] $errstr<br />n";
echo " Fatal error on line $errline in file $errfile";
echo ", PHP " . PHP_VERSION . " (" . PHP_OS . ")<br />n";
echo "Aborting...<br />n";
exit(1);
break;
case E_USER_WARNING:
echo "<b>My WARNING</b> [$errno] $errstr<br />n";
break;
case E_USER_NOTICE:
echo "<b>My NOTICE</b> [$errno] $errstr<br />n";
break;
default:
echo "Unknown error type: [$errno] $errstr<br />n";
break;
}
/* Don't execute PHP internal error handler */
return true;
}
// function to test the error handling
function scale_by_log($vect, $scale)
{
if (!is_numeric($scale) || $scale <= 0) {
trigger_error("log(x) for x <= 0 is undefined, you used: scale = $scale", E_USER_ERROR);
}
if (!is_array($vect)) {
trigger_error("Incorrect input vector, array of values expected", E_USER_WARNING);
return null;
}
$temp = array();
foreach($vect as $pos => $value) {
if (!is_numeric($value)) {
trigger_error("Value at position $pos is not a number, using 0 (zero)", E_USER_NOTICE);
$value = 0;
}
$temp[$pos] = log($scale) * $value;
}
return $temp;
}
// set to the user defined error handler
$old_error_handler = set_error_handler("myErrorHandler");
// trigger some errors, first define a mixed array with a non-numeric item
echo "vector an";
$a = array(2, 3, "foo", 5.5, 43.3, 21.11);
print_r($a);
// now generate second array
echo "----nvector b - a notice (b = log(PI) * a)n";
/* Value at position $pos is not a number, using 0 (zero) */
$b = scale_by_log($a, M_PI);
print_r($b);
// this is trouble, we pass a string instead of an array
echo "----nvector c - a warningn";
/* Incorrect input vector, array of values expected */
$c = scale_by_log("not array", 2.3);
var_dump($c); // NULL
// this is a critical error, log of zero or negative number is undefined
echo "----nvector d - fatal errorn";
/* log(x) for x <= 0 is undefined, you used: scale = $scale" */
$d = scale_by_log($a, -2.5);
var_dump($d); // Never reached
?>
以上例程的輸出類似于:
vector a Array ( [0] => 2 [1] => 3 [2] => foo [3] => 5.5 [4] => 43.3 [5] => 21.11 ) ---- vector b - a notice (b = log(PI) * a) <b>My NOTICE</b> [1024] Value at position 2 is not a number, using 0 (zero)<br /> Array ( [0] => 2.2894597716988 [1] => 3.4341896575482 [2] => 0 [3] => 6.2960143721717 [4] => 49.566804057279 [5] => 24.165247890281 ) ---- vector c - a warning <b>My WARNING</b> [512] Incorrect input vector, array of values expected<br /> NULL ---- vector d - fatal error <b>My ERROR</b> [256] log(x) for x <= 0 is undefined, you used: scale = -2.5<br /> Fatal error on line 35 in file trigger_error.php, PHP 5.2.1 (FreeBSD)<br /> Aborting...<br />
參見
ErrorException error_reporting() - 設置應該報告何種 PHP 錯誤 restore_error_handler() - 還原之前的錯誤處理函數 trigger_error() - 產生一個用戶級別的 error/warning/notice 信息 error level constants callback 類型的信息