* * This source file is subject to the MIT license that is bundled * with this source code in the file LICENSE. */ /** * CodeHelper. * * @author Fabien Potencier */ class CodeHelper extends Helper { protected $fileLinkFormat; protected $rootDir; /** * Constructor. * * @param string $fileLinkFormat The format for links to source files * @param string $rootDir The project root directory */ public function __construct($fileLinkFormat, $rootDir) { $this->fileLinkFormat = null !== $fileLinkFormat ? $fileLinkFormat : ini_get('xdebug.file_link_format'); $this->rootDir = str_replace('\\', '/', $rootDir).'/'; } /** * Formats an array as a string. * * @param array $args The argument array * * @return string */ public function formatArgsAsText($args) { $result = array(); foreach ($args as $key => $value) { if (is_object($value)) { $formattedValue = sprintf("object('%s')", get_class($value)); } elseif (is_array($value)) { $formattedValue = sprintf("array(%s)", $this->formatArgs($value)); } elseif (is_string($value)) { $formattedValue = sprintf("'%s'", $value); } elseif (null === $value) { $formattedValue = 'null'; } elseif (false === $value) { $formattedValue = 'false'; } elseif (true === $value) { $formattedValue = 'true'; } else { $formattedValue = $value; } $result[] = is_int($key) ? $formattedValue : sprintf("'%s' => %s", $key, $formattedValue); } return implode(', ', $result); } public function abbrClass($class) { $parts = explode('\\', $class); $short = array_pop($parts); return sprintf("%s", $class, $short); } public function abbrMethod($method) { list($class, $method) = explode('::', $method); $parts = explode('\\', $class); $short = array_pop($parts); return sprintf("%s::%s", $class, $short, $method); } /** * Formats an array as a string. * * @param array $args The argument array * * @return string */ public function formatArgs($args) { $result = array(); foreach ($args as $key => $value) { if (is_object($value)) { $class = get_class($value); $parts = explode('\\', $class); $short = array_pop($parts); $formattedValue = sprintf("object(%s)", $class, $short); } elseif (is_array($value)) { $formattedValue = sprintf("array(%s)", $this->formatArgs($value)); } elseif (is_string($value)) { $formattedValue = sprintf("'%s'", $value); } elseif (null === $value) { $formattedValue = 'null'; } elseif (false === $value) { $formattedValue = 'false'; } elseif (true === $value) { $formattedValue = 'true'; } else { $formattedValue = $value; } $result[] = is_int($key) ? $formattedValue : sprintf("'%s' => %s", $key, $formattedValue); } return implode(', ', $result); } /** * Returns an excerpt of a code file around the given line number. * * @param string $file A file path * @param int $line The selected line number * * @return string An HTML string */ public function fileExcerpt($file, $line) { if (is_readable($file)) { $content = preg_split('#
#', highlight_file($file, true)); $lines = array(); for ($i = max($line - 3, 1), $max = min($line + 3, count($content)); $i <= $max; $i++) { $lines[] = ''.$content[$i - 1].''; } return '

'.implode("\n", $lines).'

'; } } /** * Formats a file path. * * @param string $file An absolute file path * @param integer $line The line number * @param string $format The output format (txt or html) * @param string $text Use this text for the link rather than the file path * * @return string */ public function formatFile($file, $line) { if (0 === strpos($file, $this->rootDir)) { $file = str_replace($this->rootDir, '', str_replace('\\', '/', $file)); $file = sprintf('kernel.root_dir/%s', $this->rootDir, $file); } if (!$this->fileLinkFormat) { return "$file line $line"; } $link = strtr($this->fileLinkFormat, array('%f' => $file, '%l' => $line)); return sprintf('%s line %s', $link, $file, $line); } public function formatFileFromText($text) { $that = $this; return preg_replace_callback('/(called|defined) in (.*?)(?: on)? line (\d+)/', function ($match) use ($that) { return $match[1].' in '.$that->formatFile($match[2], $match[3]); }, $text); } /** * Returns the canonical name of this helper. * * @return string The canonical name */ public function getName() { return 'code'; } }