Back to Debug class

Method xdebuglink

public static string
(mixed $file, mixed $line = '')
Replaces the Joomla! root with "JROOT" to improve readability.
Parameters
  • string $file The full path to the file.
  • string $line The line number.
Returns
  • string
Since
  • 3.7.0
-
  • \InvalidArgumentException
Class: Debug
Project: Joomla

Method xdebuglink - Source code

/**
 * Replaces the Joomla! root with "JROOT" to improve readability.
 * Formats a link with a special value xdebug.file_link_format
 * from the php.ini file.
 *
 * @param   string  $file  The full path to the file.
 * @param   string  $line  The line number.
 *
 * @return  string
 *
 * @throws  \InvalidArgumentException
 *
 * @since   3.7.0
 */
public static function xdebuglink($file, $line = '')
{
    if (static::$xdebugLinkFormat === null) {
        static::$xdebugLinkFormat = ini_get('xdebug.file_link_format');
    }
    $link = str_replace(JPATH_ROOT, 'JROOT', Path::clean($file));
    $link .= $line ? ':' . $line : '';
    if (static::$xdebugLinkFormat) {
        $href = static::$xdebugLinkFormat;
        $href = str_replace('%f', $file, $href);
        $href = str_replace('%l', $line, $href);
        $html = HTMLHelper::_('link', $href, $link);
    } else {
        $html = $link;
    }
    return $html;
}