Print PHP Call Stack

Question

I m looking for a way to print the call stack in PHP    Bonus points if the function flushes the IO buffer

User · Answer

Backtrace dumps a whole lot of garbage that you don't need. It takes is very long, difficult to read. All you usuall ever want is "what called what from where?" Here is a simple static function solution. I usually put it in a class called 'debug', which contains all of my debugging utility functions.

class debugUtils {
    public static function callStack($stacktrace) {
        print str_repeat("=", 50) ."\n";
        $i = 1;
        foreach($stacktrace as $node) {
            print "$i. ".basename($node['file']) .":" .$node['function'] ."(" .$node['line'].")\n";
            $i++;
        }
    } 
}

You call it like this:

debugUtils::callStack(debug_backtrace());

And it produces output like this:

==================================================
 1. DatabaseDriver.php::getSequenceTable(169)
 2. ClassMetadataFactory.php::loadMetadataForClass(284)
 3. ClassMetadataFactory.php::loadMetadata(177)
 4. ClassMetadataFactory.php::getMetadataFor(124)
 5. Import.php::getAllMetadata(188)
 6. Command.php::execute(187)
 7. Application.php::run(194)
 8. Application.php::doRun(118)
 9. doctrine.php::run(99)
 10. doctrine::include(4)
==================================================

User · Answer

You might want to look into debug backtrace  or perhaps debug print backtrace

User · Answer

See debug print backtrace  I guess you can call flush afterwards if you want

User · Answer

Strange that noone posted this way   debug print backtrace DEBUG BACKTRACE IGNORE ARGS     This actually prints backtrace without the garbage - just what method was called and where

User · Answer

Use debug backtrace to get a backtrace of what functions and methods had been called and what files had been included that led to the point where debug backtrace has been called

User · Answer

If you want a stack trace which looks very similar to how php formats the exception stack trace than use this function I wrote    function debug backtrace string          stack            i   1       trace   debug backtrace        unset  trace 0      Remove call to this function from stack trace     foreach  trace as  node             stack       i    node  file          node  line                   if isset  node  class                    stack     node  class      - gt                        stack     node  function            PHP EOL           i              return  stack       This will return a stack trace formatted like this     1 C  Inetpub sitename com modules sponsors class php 306   filePathCombine    2 C  Inetpub sitename com modules sponsors class php 294   Process- gt  deleteImageFile    3 C  Inetpub sitename com VPanel modules sponsors class php 70   Process- gt  deleteImage    4 C  Inetpub sitename com modules sponsors process php 24   Process- gt  delete

User · Answer

More readable than debug backtrace      e   new  Exception  var dump  e- gt getTraceAsString       2  usr share php PHPUnit Framework TestCase php 626   SeriesHelperTest- gt setUp    3  usr share php PHPUnit Framework TestResult php 666   PHPUnit Framework TestCase- gt runBare    4  usr share php PHPUnit Framework TestCase php 576   PHPUnit Framework TestResult- gt run Object SeriesHelperTest    5  usr share php PHPUnit Framework TestSuite php 757   PHPUnit Framework TestCase- gt run Object PHPUnit Framework TestResult    6  usr share php PHPUnit Framework TestSuite php 733   PHPUnit Framework TestSuite- gt runTest Object SeriesHelperTest   Object PHPUnit Framework TestResult    7  usr share php PHPUnit TextUI TestRunner php 305   PHPUnit Framework TestSuite- gt run Object PHPUnit Framework TestResult   false  Array  Array  false   8  usr share php PHPUnit TextUI Command php 188   PHPUnit TextUI TestRunner- gt doRun Object PHPUnit Framework TestSuite   Array   9  usr share php PHPUnit TextUI Command php 129   PHPUnit TextUI Command- gt run Array  true   10  usr bin phpunit 53   PHPUnit TextUI Command  main    11  main

User · Answer

phptrace is a great tool to print PHP stack anytime when you want without installing any extensions    There are two major function of phptrace  first  print call stack of PHP which need not install anything  second  trace php execution flows which needs to install the extension it supplies   as follows       phptrace -p 3130 -s               phptrace -p  lt PID gt  -s phptrace 0 2 0 release candidate  published by infra webcore team process id   3130 script filename    home xxx opt nginx webapp block php  0x7f27b9a99dc8   sleep  home xxx opt nginx webapp block php 6  0x7f27b9a99d08   say  home xxx opt nginx webapp block php 3  0x7f27b9a99c50   run  home xxx opt nginx webapp block php 10

User · Answer

If you want to generate a backtrace  you are looking for debug backtrace and or debug print backtrace    The first one will  for instance  get you an array like this one  quoting the manual     array 2     0   gt  array 4          file     gt  string 10    tmp a php        line     gt  int 10        function     gt  string 6   a test        args    gt      array 1           0    gt   amp string 6   friend           1   gt  array 4          file     gt  string 10    tmp b php        line     gt  int 2        args     gt      array 1           0    gt  string 10    tmp a php              function     gt  string 12   include once           They will apparently not flush the I O buffer  but you can do that yourself  with flush and or ob flush    see the manual page of the first one to find out why the  and or   -

User · Answer

To log the trace   e   new Exception  error log var export  e- gt getTraceAsString    true      Thanks  Tobiasz

User · Answer

please take a look at this utils class  may be helpful   Usage     lt  php    first caller     Who  callme        list the entire list of calls    Who  followme      Source class  https   github com augustowebd utils blob master Who php

User · Answer

I have adapted Don Briggs s answer above to use internal error logging instead of public printing  which may be your big concern when working on a live server  Also  added few more modifications like option to include full file path instead of basic name  because  there could be files with same name in different paths   and also  for those who require it  a complete node stack output   class debugUtils       public static function callStack  stacktrace            error log str repeat      100             i   1          foreach  stacktrace as  node                   uncomment next line to debug entire node stack                error log print r  node  true                error log   i           file      node  file              function       node  function             line       node  line                         i                      error log str repeat      100                 call debug stack debugUtils  callStack debug backtrace

User · Answer

var dump debug backtrace       Does that do what you want

User · Answer

debug backtrace

User · Answer

Walltearer s solution is excellent  particularly if enclosed in a  pre  tag    lt pre gt   lt  php debug print backtrace DEBUG BACKTRACE IGNORE ARGS     gt   lt  pre gt    - which sets out the calls on separate lines  neatly numbered

[php] Print PHP Call Stack

Examples related to php

Examples related to stack-trace

Examples related to error-logging