PHP中debug_backtrace函数详解

debug_backtrace() 是 PHP 中的一个内置函数，用于生成一个回溯（backtrace）数组，该数组包含了当前代码执行的轨迹。这个函数在调试和错误处理时非常有用，因为它可以帮助开发者了解函数调用的上下文、文件名、行号等信息。

基本语法

debug_backtrace([int $options = DEBUG_BACKTRACE_PROVIDE_OBJECT], int $limit = 0);

参数说明：

• $options (可选):

  • 一个整数，通过位运算符定义了返回信息的详细程度。可用的选项包括：
    • DEBUG_BACKTRACE_PROVIDE_OBJECT (1): 若设此位，则在回溯数组中包含调用方法的对象实例。
    • DEBUG_BACKTRACE_IGNORE_ARGS (2): 若设此位，则不收集函数或方法调用的参数信息。
  • 组合使用示例:
    • 不带参数debug_backtrace()或debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT) 或 debug_backtrace(1) ，填充object和args。
    • 使用 debug_backtrace(0) ，填充args，忽略object（PHP 5.6.0后默认提供参数信息）。
    • debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS) 或 debug_backtrace(2) 忽略args和默认忽略object。
    • debug_backtrace(DEBUG_BACKTRACE_PROVIDE_OBJECT|DEBUG_BACKTRACE_IGNORE_ARGS) 或 debug_backtrace(3) 填充object，忽略args。

• $limit (可选): 限制返回的堆栈帧数量。默认值为0，意味着返回完整的调用堆栈。

返回值： 返回一个关联数组的数组，每个元素代表堆栈中的一个层级，包含但不限于以下键：

• function: 当前函数或方法名。
• line: 发生调用的行号。
• file: 文件名。
• class: 类名（如果适用）。
• object: 调用方法的对象实例（如果设置了DEBUG_BACKTRACE_PROVIDE_OBJECT）。
• type: 调用类型，如 "->" 表示对象方法，"::" 表示静态方法，空字符串表示普通函数调用。
• args: 函数或方法调用的参数数组。

示例：

<?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/a.php 文件中，并被另一个文件（例如 /tmp/b.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"
  }
}