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

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\ErrorHandler\ErrorRenderer\ErrorRendererInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\RequestStack;
  17. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  19. /**
  20.  * Formats debug file links.
  21.  *
  22.  * @author Jérémy Romey <jeremy@free-agent.fr>
  23.  *
  24.  * @final
  25.  */
  26. class FileLinkFormatter
  27. {
  28.     private array|false $fileLinkFormat;
  29.     private ?RequestStack $requestStack = null;
  30.     private ?string $baseDir = null;
  31.     private \Closure|string|null $urlFormat;
  33.     /**
  34.      * @param string|\Closure $urlFormat the URL format, or a closure that returns it on-demand
  35.      */
  36.     public function __construct(string|array $fileLinkFormat = null, RequestStack $requestStack = null, string $baseDir = null, string|\Closure $urlFormat = null)
  37.     {
  38.         $fileLinkFormat ??= $_SERVER['SYMFONY_IDE'] ?? '';
  39.         if (!\is_array($fileLinkFormat) && $fileLinkFormat = (ErrorRendererInterface::IDE_LINK_FORMATS[$fileLinkFormat] ?? $fileLinkFormat) ?: \ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format') ?: false) {
  40.             $i = strpos($f = $fileLinkFormat, '&', max(strrpos($f, '%f'), strrpos($f, '%l'))) ?: \strlen($f);
  41.             $fileLinkFormat = [substr($f, 0, $i)] + preg_split('/&([^>]++)>/', substr($f, $i), -1, \PREG_SPLIT_DELIM_CAPTURE);
  42.         }
  44.         $this->fileLinkFormat = $fileLinkFormat;
  45.         $this->requestStack = $requestStack;
  46.         $this->baseDir = $baseDir;
  47.         $this->urlFormat = $urlFormat;
  48.     }
  50.     public function format(string $file, int $line)
  51.     {
  52.         if ($fmt = $this->getFileLinkFormat()) {
  53.             for ($i = 1; isset($fmt[$i]); ++$i) {
  54.                 if (str_starts_with($file, $k = $fmt[$i++])) {
  55.                     $file = substr_replace($file, $fmt[$i], 0, \strlen($k));
  56.                     break;
  57.                 }
  58.             }
  60.             return strtr($fmt[0], ['%f' => $file, '%l' => $line]);
  61.         }
  63.         return false;
  64.     }
  66.     /**
  67.      * @internal
  68.      */
  69.     public function __sleep(): array
  70.     {
  71.         $this->fileLinkFormat = $this->getFileLinkFormat();
  73.         return ['fileLinkFormat'];
  74.     }
  76.     /**
  77.      * @internal
  78.      */
  79.     public static function generateUrlFormat(UrlGeneratorInterface $router, string $routeName, string $queryString): ?string
  80.     {
  81.         try {
  82.             return $router->generate($routeName).$queryString;
  83.         } catch (\Throwable) {
  84.             return null;
  85.         }
  86.     }
  88.     private function getFileLinkFormat(): array|false
  89.     {
  90.         if ($this->fileLinkFormat) {
  91.             return $this->fileLinkFormat;
  92.         }
  94.         if ($this->requestStack && $this->baseDir && $this->urlFormat) {
  95.             $request = $this->requestStack->getMainRequest();
  97.             if ($request instanceof Request && (!$this->urlFormat instanceof \Closure || $this->urlFormat = ($this->urlFormat)())) {
  98.                 return [
  99.                     $request->getSchemeAndHttpHost().$this->urlFormat,
  100.                     $this->baseDir.\DIRECTORY_SEPARATOR, '',
  101.                 ];
  102.             }
  103.         }
  105.         return false;
  106.     }
  107. }