kuria/php-highlighter

PHP代码高亮器

v3.0.2 2023-12-07 17:34 UTC

This package is auto-updated.

Last update: 2024-09-06 12:14:41 UTC


README

PHP代码高亮器。

https://travis-ci.cn/kuria/php-highlighter.svg?branch=master

内容

特性

  • 高亮文件或字符串
  • 高亮特定行范围
  • 标记活动行
  • 生成带对应行号的有序列表(<ol>

要求

  • PHP 7.1+

使用方法

代码高亮

  • PhpHighlighter::file() - 高亮PHP文件
  • PhpHighlighter::code() - 高亮PHP代码字符串
<?php

use Kuria\PhpHighlighter\PhpHighlighter;

$php = <<<'PHP'
<?php

echo "Hello world!";

PHP;

echo PhpHighlighter::code($php);

输出

<ol>
<li><span style="color: #0000BB">&lt;?php</span></li>
<li></li>
<li><span style="color: #007700">echo&nbsp;</span><span style="color: #DD0000">"Hello&nbsp;world!"</span><span style="color: #007700">;</span></li>
<li></li>
</ol>

注意

在PHP 8.3中,highlight_file()highlight_string()函数(内部使用)的输出(已更改)。

如果您使用的是PHP 8.3或更高版本,输出将包含普通空格而不是&nbsp;实体。您可以在CSS中使用white-space: pre;来修复此问题。

标记活动行

可以使用第二个参数指定活动行。

活动行将具有class="active"属性。

<?php

echo PhpHighlighter::code($php, 3);

指定行范围

可以使用第三个参数指定行范围。

示例行范围

  • NULL - 高亮所有行
  • [20, 30] - 高亮从20到30的行(绝对值)
  • [-5, 5] - 高亮活动行周围的5行(需要活动行)
  • [0, 0] - 只高亮活动行(需要活动行)
<?php

echo PhpHighlighter::code($php, 3, [-1, 1]);