The controller and template file paths are now clickable links

Author: javiereguiluz

app/Resources/views/default/_source_code.html.twig

@@ -27,11 +27,16 @@
                 </div>
 
                 <div class="modal-body">
-                    <h3>Controller code <small class="pull-right">{{ controller_file_path }}</small></h3>
-                    <pre><code class="php">{{ controller_source_code }}</code></pre>
+                    {% if controller %}
+                        <h3>Controller code <small class="pull-right">{{ controller.file_path|format_file(controller.starting_line) }}</small></h3>
+                        <pre><code class="php">{{ controller.source_code }}</code></pre>
+                    {% else %}
+                        <h3>Controller code</h3>
+                        <pre><code>Not available</code></pre>
+                    {% endif %}
 
-                    <h3>Twig template code <small class="pull-right">{{ template_file_path }}</small></h3>
-                    <pre><code class="twig">{{ template_source_code }}</code></pre>
+                    <h3>Twig template code <small class="pull-right">{{ template.file_path|format_file(template.starting_line) }}</small></h3>
+                    <pre><code class="twig">{{ template.source_code }}</code></pre>
                 </div>
             </div>
         </div>

app/config/config.yml

@@ -11,6 +11,13 @@ imports:
 
 # Basic configuration for the Symfony framework features
 framework:
+    # Uncomment the 'ide' option to turn all of the file paths in an exception
+    # page into clickable links that open the given file using your favorite IDE.
+    # Supported values are 'textmate', 'macvim', 'emacs' and 'sublime' shortcuts
+    # and any custom configuration string, such as: "phpstorm://open?file=%%f&line=%%l"
+    # See http://symfony.com/doc/current/reference/configuration/framework.html#ide
+    ide: sublime
+
     # esi:             ~
     translator:      { fallback: "%locale%" }
     secret:          "%secret%"

app/config/services.yml

@@ -20,7 +20,7 @@ services:
 
     app.twig.source_code_extension:
         class:     AppBundle\Twig\SourceCodeExtension
-        arguments: ["@twig.loader"]
+        arguments: ["@twig.loader", "%kernel.root_dir%", "%templating.helper.code.file_link_format%"]
         tags:
             - { name: twig.extension }
 

src/AppBundle/Twig/SourceCodeExtension.php

@@ -25,10 +25,14 @@ class SourceCodeExtension extends \Twig_Extension
     protected $loader;
     protected $controller;
     protected $template;
+    protected $kernelRootDir;
+    protected $fileLinkFormat;
 
-    public function __construct(\Twig_LoaderInterface $loader)
+    public function __construct(\Twig_LoaderInterface $loader, $kernelRootDir, $fileLinkFormat)
     {
+        $this->kernelRootDir = $kernelRootDir;
         $this->loader = $loader;
+        $this->fileLinkFormat = $fileLinkFormat ?: ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');
     }
 
     public function setController($controller)
@@ -48,18 +52,16 @@ public function showSourceCode(\Twig_Environment $twig, $template)
         $this->template = $template;
 
         return $twig->render('default/_source_code.html.twig', array(
-            'controller_source_code' => $this->getControllerCode(),
-            'controller_file_path'   => $this->getControllerRelativePath(),
-            'template_source_code'   => $this->getTemplateCode(),
-            'template_file_path'     => $this->getTemplateRelativePath(),
+            'controller' => $this->getController(),
+            'template'   => $this->getTemplate(),
         ));
     }
 
-    private function getControllerCode()
+    private function getController()
     {
         // this happens for example for exceptions (404 errors, etc.)
         if (null === $this->controller) {
-            return 'Not available';
+            return;
         }
 
         $className = get_class($this->controller[0]);
@@ -70,42 +72,22 @@ private function getControllerCode()
         $methodCode = array_slice($classCode, $method->getStartline() - 1, $method->getEndLine() - $method->getStartline() + 1);
         $controllerCode = '    '.$method->getDocComment()."\n".implode('', $methodCode);
 
-        return $this->unindentCode($controllerCode);
-    }
-
-    private function getControllerRelativePath()
-    {
-        // this happens for example for exceptions (404 errors, etc.)
-        if (null === $this->controller) {
-            return '';
-        }
-
-        $className = get_class($this->controller[0]);
-        $class = new \ReflectionClass($className);
-
-        $absolutePath = $class->getFilename();
-        $pathParts = explode(DIRECTORY_SEPARATOR.'src'.DIRECTORY_SEPARATOR, $absolutePath);
-        $relativePath = 'src'.DIRECTORY_SEPARATOR.$pathParts[1];
-
-        return $relativePath;
+        return array(
+            'file_path' => $class->getFilename(),
+            'starting_line' => $method->getStartline(),
+            'source_code' => $this->unindentCode($controllerCode)
+        );
     }
 
-    private function getTemplateCode()
+    private function getTemplate()
     {
-        return $this->loader->getSource($this->template->getTemplateName());
-    }
+        $templateName = $this->template->getTemplateName();
 
-    /**
-     * The logic implemented in this method is solely developed for the Symfony
-     * Demo application and cannot be used as a general purpose solution.
-     * Specifically, this logic won't work for templates that use a namespaced path
-     * (e.g. @WebProfiler/Collector/time.html.twig) or any loader different from
-     * Twig_Loader_Filesystem (e.g. TwigBundle:Exception:exception.txt.twig notation
-     * or an anonymous template created by the {% embed %} tag).
-     */
-    private function getTemplateRelativePath()
-    {
-        return 'app/Resources/views/'.$this->template->getTemplateName();
+        return array(
+            'file_path' => $this->kernelRootDir.'/Resources/views/'.$templateName,
+            'starting_line' => 1,
+            'source_code' => $this->loader->getSource($templateName),
+        );
     }
 
     /**