debug_backtrace
(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
debug_backtrace — 產生一條回溯跟蹤(backtrace)
說明
debug_backtrace(int
$options = DEBUG_BACKTRACE_PROVIDE_OBJECT, int $limit = 0): arraydebug_backtrace() 產生一條 PHP 的回溯跟蹤(backtrace)。
參數
-
options -
截至 5.3.6，這個參數是以下選項的位掩碼：
在 5.3.6 之前，僅僅能使用的值是debug_backtrace() 選項 DEBUG_BACKTRACE_PROVIDE_OBJECT 是否填充 "object" 的索引。 DEBUG_BACKTRACE_IGNORE_ARGS 是否忽略 "args" 的索引，包括所有的 function/method 的參數，能夠節省記憶體開銷。 true或者false，分別等於是否設定DEBUG_BACKTRACE_PROVIDE_OBJECT選項。 -
limit -
截至 5.4.0，這個參數能夠用於限制返回堆疊幀的數量。 預設為 (
limit=0) ，返回所有的堆疊幀。
返回值
返回一個包含眾多關聯陣列的 array。 以下為有可能返回的元素：
| 名字 | 型別 | 說明 |
|---|---|---|
| function | string | 目前的函式名，參見： __FUNCTION__。 |
| line | integer | 目前的行號。參見： __LINE__。 |
| file | string | 目前的檔名。參見： __FILE__。 |
| class | string | 目前 class 的名稱。參見 __CLASS__ |
| object | object | 目前的 object。 |
| type | string | 目前呼叫的型別。如果是一個方法，會返回 "->"。如果是一個靜態方法，會返回 "::"。 如果是一個函式呼叫，則返回空。 |
| args | array | 如果在一個函式里，這會列出函式的參數。 如果是在一個被包含的檔案里，會列出包含的檔名。 |
更新日誌
| 版本 | 說明 |
|---|---|
| 5.4.0 |
新增了可選的參數 limit。
|
| 5.3.6 |
參數 provide_object 改成 options，並且增加了可選參數
DEBUG_BACKTRACE_IGNORE_ARGS。
|
| 5.2.5 |
新增了可選參數 provide_object。
|
| 5.1.1 | 新增了當前的 object 為可能返回的元素。 |
範例
示例 #1 debug_backtrace() 範例
<?php
// filename: /tmp/a.php
function a_test($str)
{
echo "\nHi: $str";
var_dump(debug_backtrace());
}
a_test('friend');
?>
<?php
// filename: /tmp/b.php
include_once '/tmp/a.php';
?>
執行 /tmp/b.php 返回的結果類似於以下：
Hi: friend
array(2) {
[0]=>
array(4) {
["file"] => string(10) "/tmp/a.php"
["line"] => int(10)
["function"] => string(6) "a_test"
["args"]=>
array(1) {
[0] => &string(6) "friend"
}
}
[1]=>
array(4) {
["file"] => string(10) "/tmp/b.php"
["line"] => int(2)
["args"] =>
array(1) {
[0] => string(10) "/tmp/a.php"
}
["function"] => string(12) "include_once"
}
}