Added ability to config the trace file and line number

CHANGELOG.md

@@ -21,6 +21,7 @@ Yii Framework 2 debug extension Change Log
 - Enh #97: Added AJAX requests handling (bashkarev)
 - Bug #61: Fixed toolbar not to be cached by using renderDynamic (dynasource)
 - Bug #160: Remove height as it prevents the background from stretching, causing unreadable overlapping texts over background (dynasource)
+- Enh #162: Added ability to config the trace file and line number (thiagotalma)
 
 2.0.6 March 17, 2016
 --------------------

Module.php

@@ -91,6 +91,23 @@ class Module extends \yii\base\Module implements BootstrapInterface
      * You may want to enable the debug logs if you want to investigate how the debug module itself works.
      */
     public $enableDebugLogs = false;
+    /**
+     * @var mixed the string with placeholders to be be substituted or an anonymous function that returns the trace line string.
+     * The placeholders are {file}, {line} and {text} and the string should be as follows,
+     *
+     * `File: {file} - Line: {line} - Text: {text}`
+     *
+     * The signature of the anonymous function should be as follows,
+     *
+     * ```php
+     * function($trace, $panel) {
+     *     // compute line string
+     *     return $line;
+     * }
+     * ```
+     * @since 2.0.7
+     */
+    public $traceLink;
 
     /**
      * @var string Yii logo URL

Panel.php

@@ -114,4 +114,28 @@ public function getUrl($additionalParams = null)
 
         return Url::toRoute($route);
     }
+
+    /**
+     * @param array $options The array with trace
+     *
+     * @return string the trace line
+     * @since 2.0.7
+     */
+    public function traceLink($options)
+    {
+        if (!isset($options['text'])) {
+            $options['text'] = "{$options['file']}:{$options['line']}";
+        }
+        if ($this->module->traceLink === null) {
+            return $options['text'];
+        }
+        if (is_callable($this->module->traceLink)) {
+            return call_user_func($this->module->traceLink, $options, $this);
+        }
+        if (is_string($this->module->traceLink)) {
+            return strtr($this->module->traceLink, ['{file}' => $options['file'], '{line}' => $options['line'], '{text}' => $options['text']]);
+        }
+
+        return null;
+    }
 }

README.md

@@ -53,3 +53,25 @@ return [
 
 You will see a debugger toolbar showing at the bottom of every page of your application.
 You can click on the toolbar to see more detailed debug information.
+
+
+Open Files in IDE
+-----
+
+You can create a link to open files in your favorite IDE with this configuration:
+
+```php
+return [
+    'bootstrap' => ['debug'],
+    'modules' => [
+        'debug' => [
+            'class' => 'yii\debug\Module',
+            'traceLink' => '<a href="phpstorm://open?url={file}&line={line}">{file}:{line}</a>',
+        ],
+        // ...
+    ],
+    ...
+];
+```
+
+You must make some changes to your OS, see this example: https://github.com/aik099/PhpStormProtocol

views/default/panels/db/detail.php

@@ -57,8 +57,8 @@
                 if (!empty($data['trace'])) {
                     $query .= Html::ul($data['trace'], [
                         'class' => 'trace',
-                        'item' => function ($trace) {
-                            return "<li>{$trace['file']} ({$trace['line']})</li>";
+                        'item' => function ($trace) use ($panel) {
+                            return '<li>' . $panel->traceLink($trace) . '</li>';
                         },
                     ]);
                 }
@@ -75,7 +75,7 @@
 
                 return $query;
             },
-            'format' => 'html',
+            'format' => 'raw',
             'options' => [
                 'width' => '60%',
             ],

views/default/panels/log/detail.php

@@ -55,19 +55,19 @@
         'category',
         [
             'attribute' => 'message',
-            'value' => function ($data) {
+            'value' => function ($data) use ($panel) {
                 $message = Html::encode(is_string($data['message']) ? $data['message'] : VarDumper::export($data['message']));
                 if (!empty($data['trace'])) {
                     $message .= Html::ul($data['trace'], [
                         'class' => 'trace',
-                        'item' => function ($trace) {
-                            return "<li>{$trace['file']} ({$trace['line']})</li>";
+                        'item' => function ($trace) use ($panel) {
+                            return '<li>' . $panel->traceLink($trace) . '</li>';
                         }
                     ]);
                 };
                 return $message;
             },
-            'format' => 'html',
+            'format' => 'raw',
             'options' => [
                 'width' => '50%',
             ],