Move IDE file link formats from FrameworkExtension to FileLinkFormatter

MatTheCat · MatTheCat · commit 0928dcf02e96 · 2021-04-30T14:55:51.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -213,20 +213,11 @@ public function load(array $configs, ContainerBuilder $container)
 
         if (!$container->hasParameter('debug.file_link_format')) {
             if (!$container->hasParameter('templating.helper.code.file_link_format')) {
-                $links = [
-                    'textmate' => 'txmt://open?url=file://%%f&line=%%l',
-                    'macvim' => 'mvim://open?url=file://%%f&line=%%l',
-                    'emacs' => 'emacs://open?url=file://%%f&line=%%l',
-                    'sublime' => 'subl://open?url=file://%%f&line=%%l',
-                    'phpstorm' => 'phpstorm://open?file=%%f&line=%%l',
-                    'atom' => 'atom://core/open/file?filename=%%f&line=%%l',
-                    'vscode' => 'vscode://file/%%f:%%l',
-                ];
                 $ide = $config['ide'];
                 // mark any env vars found in the ide setting as used
                 $container->resolveEnvPlaceholders($ide);
 
-                $container->setParameter('templating.helper.code.file_link_format', str_replace('%', '%%', ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format')) ?: ($links[$ide] ?? $ide));
+                $container->setParameter('templating.helper.code.file_link_format', str_replace('%', '%%', ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format')) ?: $ide);
             }
             $container->setParameter('debug.file_link_format', '%templating.helper.code.file_link_format%');
         }
diff --git a/src/Symfony/Component/HttpKernel/Debug/FileLinkFormatter.php b/src/Symfony/Component/HttpKernel/Debug/FileLinkFormatter.php
@@ -24,6 +24,16 @@
  */
 class FileLinkFormatter
 {
+    private const FORMATS = [
+        'textmate' => 'txmt://open?url=file://%f&line=%l',
+        'macvim' => 'mvim://open?url=file://%f&line=%l',
+        'emacs' => 'emacs://open?url=file://%f&line=%l',
+        'sublime' => 'subl://open?url=file://%f&line=%l',
+        'phpstorm' => 'phpstorm://open?file=%f&line=%l',
+        'atom' => 'atom://core/open/file?filename=%f&line=%l',
+        'vscode' => 'vscode://file/%f:%l',
+    ];
+
     private $fileLinkFormat;
     private $requestStack;
     private $baseDir;
@@ -34,7 +44,7 @@ class FileLinkFormatter
      */
     public function __construct($fileLinkFormat = null, RequestStack $requestStack = null, string $baseDir = null, $urlFormat = null)
     {
-        $fileLinkFormat = $fileLinkFormat ?: ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');
+        $fileLinkFormat = (self::FORMATS[$fileLinkFormat] ?? $fileLinkFormat) ?: ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');
         if ($fileLinkFormat && !\is_array($fileLinkFormat)) {
             $i = strpos($f = $fileLinkFormat, '&', max(strrpos($f, '%f'), strrpos($f, '%l'))) ?: \strlen($f);
             $fileLinkFormat = [substr($f, 0, $i)] + preg_split('/&([^>]++)>/', substr($f, $i), -1, \PREG_SPLIT_DELIM_CAPTURE);
diff --git a/src/Symfony/Component/HttpKernel/Tests/Debug/FileLinkFormatterTest.php b/src/Symfony/Component/HttpKernel/Tests/Debug/FileLinkFormatterTest.php
@@ -51,4 +51,13 @@ public function testWhenNoFileLinkFormatAndRequest()
 
         $this->assertSame('http://www.example.org/_profiler/open?file=file.php&line=3#line3', $sut->format($file, 3));
     }
+
+    public function testIdeFileLinkFormat()
+    {
+        $file = __DIR__.\DIRECTORY_SEPARATOR.'file.php';
+
+        $sut = new FileLinkFormatter('atom');
+
+        $this->assertSame("atom://core/open/file?filename=$file&line=3", $sut->format($file, 3));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -51,4 +51,13 @@ public function testWhenNoFileLinkFormatAndRequest()`
`51`	`51`
`52`	`52`	`$this->assertSame('http://www.example.org/_profiler/open?file=file.php&line=3#line3', $sut->format($file, 3));`
`53`	`53`	`}`
	`54`	`+`
	`55`	`+ public function testIdeFileLinkFormat()`
	`56`	`+ {`
	`57`	`+ $file = __DIR__.\DIRECTORY_SEPARATOR.'file.php';`
	`58`	`+`
	`59`	`+ $sut = new FileLinkFormatter('atom');`
	`60`	`+`
	`61`	`+ $this->assertSame("atom://core/open/file?filename=$file&line=3", $sut->format($file, 3));`
	`62`	`+ }`
`54`	`63`	`}`