vendor/symfony/http-kernel/Debug/FileLinkFormatter.php line 88

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\HttpKernel\Debug;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpFoundation\RequestStack;
  16. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  18. /**
  19.  * Formats debug file links.
  20.  *
  21.  * @author Jérémy Romey <jeremy@free-agent.fr>
  22.  *
  23.  * @final
  24.  */
  25. class FileLinkFormatter
  26. {
  27.     private const FORMATS = [
  28.         'textmate' => 'txmt://open?url=file://%f&line=%l',
  29.         'macvim' => 'mvim://open?url=file://%f&line=%l',
  30.         'emacs' => 'emacs://open?url=file://%f&line=%l',
  31.         'sublime' => 'subl://open?url=file://%f&line=%l',
  32.         'phpstorm' => 'phpstorm://open?file=%f&line=%l',
  33.         'atom' => 'atom://core/open/file?filename=%f&line=%l',
  34.         'vscode' => 'vscode://file/%f:%l',
  35.     ];
  37.     private $fileLinkFormat;
  38.     private $requestStack;
  39.     private $baseDir;
  40.     private $urlFormat;
  42.     /**
  43.      * @param string|array|null $fileLinkFormat
  44.      * @param string|\Closure   $urlFormat      the URL format, or a closure that returns it on-demand
  45.      */
  46.     public function __construct($fileLinkFormat = null, RequestStack $requestStack = null, string $baseDir = null, $urlFormat = null)
  47.     {
  48.         if (!\is_array($fileLinkFormat) && $fileLinkFormat = (self::FORMATS[$fileLinkFormat] ?? $fileLinkFormat) ?: \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format')) {
  49.             $i = strpos($f = $fileLinkFormat, '&', max(strrpos($f, '%f'), strrpos($f, '%l'))) ?: \strlen($f);
  50.             $fileLinkFormat = [substr($f, 0, $i)] + preg_split('/&([^>]++)>/', substr($f, $i), -1, \PREG_SPLIT_DELIM_CAPTURE);
  51.         }
  53.         $this->fileLinkFormat = $fileLinkFormat;
  54.         $this->requestStack = $requestStack;
  55.         $this->baseDir = $baseDir;
  56.         $this->urlFormat = $urlFormat;
  57.     }
  59.     public function format(string $file, int $line)
  60.     {
  61.         if ($fmt = $this->getFileLinkFormat()) {
  62.             for ($i = 1; isset($fmt[$i]); ++$i) {
  63.                 if (str_starts_with($file, $k = $fmt[$i++])) {
  64.                     $file = substr_replace($file, $fmt[$i], 0, \strlen($k));
  65.                     break;
  66.                 }
  67.             }
  69.             return strtr($fmt[0], ['%f' => $file, '%l' => $line]);
  70.         }
  72.         return false;
  73.     }
  75.     /**
  76.      * @internal
  77.      */
  78.     public function __sleep(): array
  79.     {
  80.         $this->fileLinkFormat = $this->getFileLinkFormat();
  82.         return ['fileLinkFormat'];
  83.     }
  85.     /**
  86.      * @internal
  87.      */
  88.     public static function generateUrlFormat(UrlGeneratorInterface $router, string $routeName, string $queryString): ?string
  89.     {
  90.         try {
  91.             return $router->generate($routeName).$queryString;
  92.         } catch (\Throwable $e) {
  93.             return null;
  94.         }
  95.     }
  97.     private function getFileLinkFormat()
  98.     {
  99.         if ($this->fileLinkFormat) {
  100.             return $this->fileLinkFormat;
  101.         }
  103.         if ($this->requestStack && $this->baseDir && $this->urlFormat) {
  104.             $request = $this->requestStack->getMainRequest();
  106.             if ($request instanceof Request && (!$this->urlFormat instanceof \Closure || $this->urlFormat = ($this->urlFormat)())) {
  107.                 return [
  108.                     $request->getSchemeAndHttpHost().$this->urlFormat,
  109.                     $this->baseDir.\DIRECTORY_SEPARATOR, '',
  110.                 ];
  111.             }
  112.         }
  114.         return null;
  115.     }
  116. }