Changeset 6017

Timestamp:

02/05/12 19:56:14 (4 months ago)

Author:

vain

Message:

• isolated getWhereDebugWasCalled()

File:

• trunk/core/debug/debug.core.php (modified) (7 diffs)

trunk/core/debug/debug.core.php

@@ -130 +130 @@
         exit;
     }
-    
+
     /**
      * Displays the content of a variable with var_dump.
@@ -146 +146 @@
 
         /**
-         * if xdebug is on and overloaded the var_dump function, 
+         * if xdebug is on and overloaded the var_dump function,
          * then the output is already properly escaped and prepared for direct output.
          * if xdebug is off, we need to apply escaping ourself.
@@ -159 +159 @@
         # output the content of the buffer
         echo $var_dump;
-        
+
         if($stop === true)
         {
@@ -169 +169 @@
      * Debug logs the output of $var to the firebug console
      *
-     * @param mixed $var
-     * @param $firebugmethod log,info,warn, error
-     * @param $backtrace boolean Enables tracing of the origin of the debug call (adds a seconds fb msg).
+     * @param mixed $var The variable to debug.
+     * @param $firebugmethod The firebug method to call (log,info,warn, error). Defaults to "log".
+     *
      * @return Content of $var will be returned via Header and is displayed in the FireBugConsole.
      */
@@ -184 +184 @@
         $firephp = FirePHP::getInstance(true);
 
-        # get callstack and log the origin of the call to Clansuite_Debug::firebug()
-        $backtrace_array = array();
-        $backtrace_array = debug_backtrace();
-
-        # check if debug origin was inside class/method or function, adjust message
-        $classname = '';
-        if(isset($backtrace_array[1]['class']) == false)
-        {
-            $classname = '';
-        }
-        else
-        {
-            $classname = $backtrace_array[1]['class'];
-        }
-
-        $infomsg = sprintf('You are debugging like fire in %s->%s() on line "%s" in file "%s".',
-                $classname, $backtrace_array[1]['function'],
-                $backtrace_array[0]['line'], $backtrace_array[0]['file']);
-
-        $firephp->info($infomsg);
-
-        unset($infomsg, $backtrace_array);
+        /**
+         * Adds an info message about the position of the firebug call (origin).
+         * This is very helpful, if you spread Debug::firebug() calls all over your code.
+         */
+        $firephp->info(self::getWhereDebugWasCalled());
 
         # debug the var
         $firephp->{$firebugmethod}($var);
+    }
+
+    /**
+     * Returns the position of a call.
+     *
+     * This is used in combination with Clansuite_Debug::firebug(),
+     * to determine the origin of the call.
+     *
+     * @param type $level default 1.
+     * @return string Message with origin of the debug call.
+     */
+    public static function getWhereDebugWasCalled($level = 1)
+    {
+        $trace  = array();
+        $file = $line = $function = $class = $object = '';
+
+        $trace  = debug_backtrace();
+        $file       = $trace[$level]['file'];
+        $line       = $trace[$level]['line'];
+        $function   = $trace[$level]['function'];
+        $class      = $trace[$level]['class'];
+
+        return sprintf('You are debugging like fire in %s->%s() on line "%s" in file "%s".',
+                $class, $function, $line, $file);
     }
 
@@ -296 +303 @@
     {
         self::printR(parse_ini_file(get_cfg_var('cfg_file_path'), true));
-    }    
+    }
 
     /**
@@ -307 +314 @@
         echo 'http wrapper: '. in_array('http', $w) ? 'yes':'no'. NL;
         echo 'https wrapper: '. in_array('https', $w) ? 'yes':'no'. NL;
-        echo 'wrappers: '. self::printR($w);        
+        echo 'wrappers: '. self::printR($w);
     }
 
     /**
      * Returns a list of all registered event listeners
-     * @return array 
+     * @return array
      */
     public static function getRegisteredEventListeners()