vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/CodeHelper.php line 14

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\Bundle\FrameworkBundle\Templating\Helper;
  14. @trigger_error('The '.CodeHelper::class.' class is deprecated since version 4.3 and will be removed in 5.0; use Twig instead.', \E_USER_DEPRECATED);
  16. use Symfony\Component\HttpKernel\Debug\FileLinkFormatter;
  17. use Symfony\Component\Templating\Helper\Helper;
  19. /**
  20.  * @author Fabien Potencier <fabien@symfony.com>
  21.  *
  22.  * @internal since Symfony 4.2
  23.  *
  24.  * @deprecated since version 4.3, to be removed in 5.0; use Twig instead.
  25.  */
  26. class CodeHelper extends Helper
  27. {
  28.     protected $fileLinkFormat;
  29.     protected $rootDir; // to be renamed $projectDir in 5.0
  30.     protected $charset;
  32.     /**
  33.      * @param string|FileLinkFormatter $fileLinkFormat The format for links to source files
  34.      * @param string                   $projectDir     The project root directory
  35.      * @param string                   $charset        The charset
  36.      */
  37.     public function __construct($fileLinkFormat, string $projectDir, string $charset)
  38.     {
  39.         $this->fileLinkFormat = $fileLinkFormat ?: ini_get('xdebug.file_link_format') ?: get_cfg_var('xdebug.file_link_format');
  40.         $this->rootDir = str_replace('\\', '/', $projectDir).'/';
  41.         $this->charset = $charset;
  42.     }
  44.     /**
  45.      * Formats an array as a string.
  46.      *
  47.      * @param array $args The argument array
  48.      *
  49.      * @return string
  50.      */
  51.     public function formatArgsAsText(array $args)
  52.     {
  53.         return strip_tags($this->formatArgs($args));
  54.     }
  56.     public function abbrClass($class)
  57.     {
  58.         $parts = explode('\\', $class);
  59.         $short = array_pop($parts);
  61.         return sprintf('<abbr title="%s">%s</abbr>', $class, $short);
  62.     }
  64.     public function abbrMethod($method)
  65.     {
  66.         if (false !== strpos($method, '::')) {
  67.             [$class, $method] = explode('::', $method, 2);
  68.             $result = sprintf('%s::%s()', $this->abbrClass($class), $method);
  69.         } elseif ('Closure' === $method) {
  70.             $result = sprintf('<abbr title="%s">%1$s</abbr>', $method);
  71.         } else {
  72.             $result = sprintf('<abbr title="%s">%1$s</abbr>()', $method);
  73.         }
  75.         return $result;
  76.     }
  78.     /**
  79.      * Formats an array as a string.
  80.      *
  81.      * @param array $args The argument array
  82.      *
  83.      * @return string
  84.      */
  85.     public function formatArgs(array $args)
  86.     {
  87.         $result = [];
  88.         foreach ($args as $key => $item) {
  89.             if ('object' === $item[0]) {
  90.                 $parts = explode('\\', $item[1]);
  91.                 $short = array_pop($parts);
  92.                 $formattedValue = sprintf('<em>object</em>(<abbr title="%s">%s</abbr>)', $item[1], $short);
  93.             } elseif ('array' === $item[0]) {
  94.                 $formattedValue = sprintf('<em>array</em>(%s)', \is_array($item[1]) ? $this->formatArgs($item[1]) : $item[1]);
  95.             } elseif ('string' === $item[0]) {
  96.                 $formattedValue = sprintf("'%s'", htmlspecialchars($item[1], \ENT_QUOTES, $this->getCharset()));
  97.             } elseif ('null' === $item[0]) {
  98.                 $formattedValue = '<em>null</em>';
  99.             } elseif ('boolean' === $item[0]) {
  100.                 $formattedValue = '<em>'.strtolower(var_export($item[1], true)).'</em>';
  101.             } elseif ('resource' === $item[0]) {
  102.                 $formattedValue = '<em>resource</em>';
  103.             } else {
  104.                 $formattedValue = str_replace("\n", '', var_export(htmlspecialchars((string) $item[1], \ENT_QUOTES, $this->getCharset()), true));
  105.             }
  107.             $result[] = \is_int($key) ? $formattedValue : sprintf("'%s' => %s", $key, $formattedValue);
  108.         }
  110.         return implode(', ', $result);
  111.     }
  113.     /**
  114.      * Returns an excerpt of a code file around the given line number.
  115.      *
  116.      * @param string $file A file path
  117.      * @param int    $line The selected line number
  118.      *
  119.      * @return string|null An HTML string
  120.      */
  121.     public function fileExcerpt($file, $line)
  122.     {
  123.         if (is_readable($file)) {
  124.             if (\extension_loaded('fileinfo')) {
  125.                 $finfo = new \finfo();
  127.                 // Check if the file is an application/octet-stream (eg. Phar file) because highlight_file cannot parse these files
  128.                 if ('application/octet-stream' === $finfo->file($file, \FILEINFO_MIME_TYPE)) {
  129.                     return '';
  130.                 }
  131.             }
  133.             // highlight_file could throw warnings
  134.             // see https://bugs.php.net/25725
  135.             $code = @highlight_file($file, true);
  136.             // remove main code/span tags
  137.             $code = preg_replace('#^<code.*?>\s*<span.*?>(.*)</span>\s*</code>#s', '\\1', $code);
  138.             $content = explode('<br />', $code);
  140.             $lines = [];
  141.             for ($i = max($line - 3, 1), $max = min($line + 3, \count($content)); $i <= $max; ++$i) {
  142.                 $lines[] = '<li'.($i == $line ? ' class="selected"' : '').'><code>'.self::fixCodeMarkup($content[$i - 1]).'</code></li>';
  143.             }
  145.             return '<ol start="'.max($line - 3, 1).'">'.implode("\n", $lines).'</ol>';
  146.         }
  148.         return null;
  149.     }
  151.     /**
  152.      * Formats a file path.
  153.      *
  154.      * @param string $file An absolute file path
  155.      * @param int    $line The line number
  156.      * @param string $text Use this text for the link rather than the file path
  157.      *
  158.      * @return string
  159.      */
  160.     public function formatFile($file, $line, $text = null)
  161.     {
  162.         $flags = \ENT_QUOTES | \ENT_SUBSTITUTE;
  164.         if (null === $text) {
  165.             $file = trim($file);
  166.             $fileStr = $file;
  167.             if (0 === strpos($fileStr, $this->rootDir)) {
  168.                 $fileStr = str_replace(['\\', $this->rootDir], ['/', ''], $fileStr);
  169.                 $fileStr = htmlspecialchars($fileStr, $flags, $this->charset);
  170.                 $fileStr = sprintf('<abbr title="%s">kernel.project_dir</abbr>/%s', htmlspecialchars($this->rootDir, $flags, $this->charset), $fileStr);
  171.             }
  173.             $text = sprintf('%s at line %d', $fileStr, $line);
  174.         }
  176.         if (false !== $link = $this->getFileLink($file, $line)) {
  177.             return sprintf('<a href="%s" title="Click to open this file" class="file_link">%s</a>', htmlspecialchars($link, $flags, $this->charset), $text);
  178.         }
  180.         return $text;
  181.     }
  183.     /**
  184.      * Returns the link for a given file/line pair.
  185.      *
  186.      * @param string $file An absolute file path
  187.      * @param int    $line The line number
  188.      *
  189.      * @return string A link of false
  190.      */
  191.     public function getFileLink($file, $line)
  192.     {
  193.         if ($fmt = $this->fileLinkFormat) {
  194.             return \is_string($fmt) ? strtr($fmt, ['%f' => $file, '%l' => $line]) : $fmt->format($file, $line);
  195.         }
  197.         return false;
  198.     }
  200.     public function formatFileFromText($text)
  201.     {
  202.         return preg_replace_callback('/in ("|&quot;)?(.+?)\1(?: +(?:on|at))? +line (\d+)/s', function ($match) {
  203.             return 'in '.$this->formatFile($match[2], $match[3]);
  204.         }, $text);
  205.     }
  207.     /**
  208.      * {@inheritdoc}
  209.      */
  210.     public function getName()
  211.     {
  212.         return 'code';
  213.     }
  215.     protected static function fixCodeMarkup($line)
  216.     {
  217.         // </span> ending tag from previous line
  218.         $opening = strpos($line, '<span');
  219.         $closing = strpos($line, '</span>');
  220.         if (false !== $closing && (false === $opening || $closing < $opening)) {
  221.             $line = substr_replace($line, '', $closing, 7);
  222.         }
  224.         // missing </span> tag at the end of line
  225.         $opening = strpos($line, '<span');
  226.         $closing = strpos($line, '</span>');
  227.         if (false !== $opening && (false === $closing || $closing > $opening)) {
  228.             $line .= '</span>';
  229.         }
  231.         return $line;
  232.     }
  233. }