decodelabs/enlighten

PHP源代码高亮工具

v0.9.1 2023-09-26 10:31 UTC

README

PHP from Packagist Latest Version Total Downloads GitHub Workflow Status PHPStan License

PHP源代码高亮工具

Enlighten 为调试系统提供了详尽且准确的 PHP 源代码高亮功能。

DecodeLabs 博客 上获取新闻和更新。

安装

使用 Composer 安装

composer require decodelabs/enlighten

用法

Enlighten 使用 PHP tokenizer 扩展,需要从文件中获取完整的源代码(包括 <?php 开头标记)。

它是 highlight_stringhighlight_file 的更彻底版本——语法被正确封装,名称实体根据其周围的标记进行解析以确定其 类型(函数名、类名等)。

Enlighten 还提供了提取代码特定部分并聚焦于特定行的功能。输出 HTML 中包含行号,有助于提高可读性。

use DecodeLabs\Enlighten\Highlighter;

$highlighter = new Highlighter();
echo $highlighter->highlight($phpSourceCode); // Highlight source code in memory
echo $highlighter->highlightFile($phpFile, 15, 35, 20); // Highlight specific lines (15 to 35) in file (focus on 20)

echo $highlighter->extract($phpSourceCode, 20); // Extract code around specific line
echo $highlighter->extractFromFile($phpFile, 20); // Extract code around specific line

许可

Enlighten 使用 MIT 许可证。有关完整许可证文本,请参阅 LICENSE