PHP highlight_file 杂项函数



  • 定义和用法

    highlight_file - 语法高亮一个文件
  • 版本支持

    PHP4 PHP5 PHP7
    支持 支持 支持
    4.2.1 该函数现在也受 safe_mode 和 open_basedir 的限制和影响。
  • 语法

    highlight_file( string $filename [, bool $return = false ] )
    
    highlight_file() 使用PHP内置的语法高亮器所定义的颜色,打印输出或者返回 filename 文件中语法高亮版本的代码。许多服务器配置了自动高亮 phps 扩展的文件。 比如,访问 example.phps 会显示语法高亮后的文件。 添加以下一行代码到 httpd.conf 使此生效:
    AddType application/x-httpd-php-source .phps
    
  • 参数

    参数 必需的 描述
    filename 欲高亮文件的路径。
    return 设置该参数为 TRUE 使函数返回高亮后的代码。
  • 返回值

    如果 return 设置为 TRUE,高亮后的代码不会被打印输出,而是以字符串的形式返回。 高亮成功返回 TRUE,否则返回 FALSE。
    注意:应当注意在使用 highlight_file() 时,确认没有在不经意间泄漏敏感信息,类似密码或者其他任何具有潜在安全风险的信息。
    当使用了return 参数时,本函数使用其内部输出缓冲,因此不能在 ob_start() 回调函数的内部使用。
  • 示例

    function highlight_num($file)
    {
            $lines = implode(range(1, count(file($file))), '<br />');
            $content = highlight_file($file, true);
    
    
            echo '
        <style type="text/css">
            .num {
            float: left;
            color: gray;
            font-size: 13px;   
            font-family: monospace;
            text-align: right;
            margin-right: 6pt;
            padding-right: 6pt;
            border-right: 1px solid gray;}
    
            body {margin: 0px; margin-left: 5px;}
            td {vertical-align: top;}
            code {white-space: nowrap;}
        </style>';
    
    
    
            echo "<table><tr><td class=\"num\">\n$lines\n</td><td>\n$content\n</td></tr></table>";
    }
    highlight_num(__FILE__);
    
  • 相关页面

    highlight_string() - 字符串的语法高亮