是否有可能在php中获取调用者上下文的魔术常量?

时间:2011-11-20 19:20:12

标签: php constants

我想创建一个调试函数来转储有关执行上下文的信息以及其他一些信息。

在debug.php中,我有一个函数可以转储作为参数传递的任何内容。我感兴趣的是一种调用dump函数的方法,例如example.php,并让它返回文件名,行号和调用上下文的函数名。

1. <?php
2. function my_function(){
3.   $var = 'My example';
4.   dump( $var );
5. }
6. ?>

使用example.php

我想输出上面的函数:“example.php,my_function,4:我的例子”。

有没有这样做(没有传递__FILE____FUNCTION____LINE__)作为参数?

3 个答案:

答案 0 :(得分:4)

是的,您可以使用debug_backtrace()

它以相反的顺序返回所有调用者和文件(跟踪包含文件)的数组(最后一个祖先)。所以调用者将是数组中的第一个:

$caller_info = next(debug_backtrace());

答案 1 :(得分:2)

PHP的debug_backtrace()

print_r(debug_backtrace());

backtrace的输出是一个关联数组数组,用于命名您正在寻找的这些常量。对于this sample code,数组debug_backtrace()返回如下所示:

Array
(
    [0] => Array
        (
            [file] => /t.php
            [line] => 9
            [function] => abc
            [args] => Array
                (
                    [0] => a
                )

        )

)

答案 2 :(得分:0)

我也使用debug_backtrace,我尝试处理不同的场景,这可能看起来太耗时或不好主意,但对我来说(构建我自己的小型mvc非常有帮助)。要处理的方案示例:

    退出调用者上下文时,
  • __我的类的析构被自动调用
  • 我的类的方法/销毁被自动调用因为被声明为会话处理程序
  • 我的方法/函数是从全局上下文(而不是从其他函数/方法)调用的。
  • 等。

所有这些场景都会影响debug_backtrace带来的结果,我的调试功能(定义如下)会尝试处理这些场景。

每个函数/方法都是这样定义的

function my_func(){if(__DEBUG){dbg(debug_backtrace(),__CLASS__);}

然后当我想生成最终代码时,我可以运行一个简单的脚本来替换if语句,例如

a="if(__DEBUG){dbg(debug_backtrace(),__CLASS__);}"
b="//replace_what_ever"
dir="/var/www/mydir/"

find $dir -name \*.inc -exec sed -i "s/$a/$b/g" {} \;
find $dir -name \*.php -exec sed -i "s/$a/$b/g" {} \;

至于调试函数,它可以放在脚本的最后,让我们说就是和index.php一样但是如果你已经为会话处理程序定义了一个自己的类,那么最后一个命令就在里面执行该类的析构函数。

因此,在大多数情况下,当出现问题时,您的调试功能会让您知道。但是在致命错误上,打印由调试函数创建/存储(存储在某个数组,这里是$ dbg_log)中的结果的行将无法打印(例如,print命令放在index.php的末尾)!对于这种情况,您需要一个手动处理程序(仅用于致命错误)来打印结果数组,这就是我的工作方式:

register_shutdown_function('handleShutdown');
//Catch fatal errors
function handleShutdown() {
    $error = error_get_last();
    global $dbg_log;
    echo "<pre>";
    if(
            $error['type'] === E_COMPILE_ERROR or
            $error['type'] === E_ERROR or
            $error['type'] === E_PARSE or
            $error['type'] === E_CORE_ERROR or
            $error['type'] === E_CORE_WARNING or
            $error['type'] === E_RECOVERABLE_ERROR

    )//we need to catch fatal errors under debug
    {
        //print_r($error); if you like
        $dbg_log[] = " Tip: Start backward, the failing function (line) cannot echo a text put at the end of the function!";
        $last = count($dbg_log)-1;
        for($i=$last;$i>-1;$i--){
            echo "$i: {$dbg_log[$i]} \n<br>";
        }
    }
}

$ dbg_log用于收集在全局上下文中定义的所有这些信息(见下文)。

现在这是我的调试功能:

define('__DEBUG', true); // Easily switch from/to debug mode
$dbg_log = array(); // Keep log of function calling sequence for debuging purposes
 function dbg($tr, $callee_class){
     global $dbg_log;
    // If the file of the caller exists
    if(isset($tr[0]['file'])){
        $caller = $caller=$tr[0]["file"].':'.$tr[0]["line"]; // Then we can get its name and calling line
        // If the caller is a function then it was a callee before so $tr[1] should exists
        if(isset($tr[1])){
            // If the caller is a class method
            if(isset($tr[1]["class"])){
                $caller = $tr[1]["class"]."whenever->".$caller=$tr[1]["function"].':'.$caller;
            }
            // Else
            else{
                $caller = $tr[1]["function"].$caller;
            }
        }
    }
    // Else this is an auto call by php compiler
    else{
        $caller = 'auto';
    }
    // Log the debug info
    $dbg_log[] = 'Started: '.$callee_class.'::'.$tr[0]['function'].' by '.$caller;
}

$ tr(trace)数组包含debug_backtrace的结果,因为它们存在于被调用者函数内部。另一件需要提及的是,在成为来电者之前,来电者始终是一个人!

这些是真实的(对你没用,但是提供的所有信息都是显而易见的)$ dbg_log数组的输出给出的结果(在致命错误或正常退出时):

27: Started: Framework\registry::get by App\View\WebWindowOne->__construct:/var/www/MyProject/protected/view/WebWindowOne/WebWindowOne.php:36 

26: Started: App\View\WebWindowOne::__construct by Application->AppStart:/var/www/MyProject/protected/Web_Application.php:240 

25: Started: Application::AppStart by Application->__construct:/var/www/MyProject/protected/Web_Application.php:150 

24: Started: Framework\riskManager::__construct by Application->{closure}:/var/www/MyProject/protected/Web_Application.php:52 

对于您定义的每个函数/方法,有很多信息,行号,类等,只需很少的努力(只需使用此function my_func(){if(__DEBUG){dbg(debug_backtrace(),__CLASS__);})。