PHP-Console-Color 控制台颜色库使用教程

前言

在开发命令行应用时，为输出内容添加颜色和样式可以显著提升用户体验和可读性。PHP-Console-Color 是一个专门用于在终端中输出彩色文本的 PHP 库，它提供了简单易用的 API 来设置文本颜色、背景色和各种文本样式。

环境准备

在使用 PHP-Console-Color 之前，你需要确保：

1. PHP 5.3 或更高版本
2. 通过 Composer 安装该库
3. 终端支持 ANSI 颜色代码（大多数现代终端都支持）

基本使用

首先，我们需要初始化 ConsoleColor 对象：

$consoleColor = new JakubOnderka\PhpConsoleColor\ConsoleColor();

检测终端支持情况

在开始使用前，最好先检测当前终端对颜色和样式的支持情况：

echo "Colors are supported: " . ($consoleColor->isSupported() ? 'Yes' : 'No') . "\n";
echo "256 colors are supported: " . ($consoleColor->are256ColorsSupported() ? 'Yes' : 'No') . "\n\n";

应用文本样式

库提供了一系列预定义的文本样式，可以通过 getPossibleStyles() 方法获取所有可用样式：

if ($consoleColor->isSupported()) {
    foreach ($consoleColor->getPossibleStyles() as $style) {
        echo $consoleColor->apply($style, $style) . "\n";
    }
}

这段代码会输出所有支持的样式示例，每种样式都会以该样式本身显示其名称。

256 色模式

如果终端支持 256 色模式，我们可以使用更丰富的颜色选择：

前景色（文本颜色）

if ($consoleColor->are256ColorsSupported()) {
    echo "Foreground colors:\n";
    for ($i = 1; $i <= 255; $i++) {
        echo $consoleColor->apply("color_$i", str_pad($i, 6, ' ', STR_PAD_BOTH));

        if ($i % 15 === 0) {
            echo "\n";
        }
    }
}

这段代码会显示 1-255 号颜色的示例，每行显示 15 个颜色。

背景色

同样地，我们也可以设置背景颜色：

echo "\nBackground colors:\n";
for ($i = 1; $i <= 255; $i++) {
    echo $consoleColor->apply("bg_color_$i", str_pad($i, 6, ' ', STR_PAD_BOTH));

    if ($i % 15 === 0) {
        echo "\n";
    }
}

实际应用示例

在实际项目中，你可以这样使用颜色来增强输出：

// 错误信息 - 红色
echo $consoleColor->apply('red', "Error: File not found\n");

// 警告信息 - 黄色
echo $consoleColor->apply('yellow', "Warning: Configuration incomplete\n");

// 成功信息 - 绿色
echo $consoleColor->apply('green', "Success: Operation completed\n");

// 强调文本 - 加粗
echo $consoleColor->apply('bold', "Important notice:\n");

高级用法

除了预定义样式，你还可以组合多种样式：

// 红色背景上的白色加粗文本
echo $consoleColor->apply(['white', 'bold', 'bg_red'], "Critical error!\n");

注意事项

1. 在使用颜色前总是检查终端支持情况
2. 不要过度使用颜色，保持输出的可读性
3. 考虑色盲用户的体验，不要仅依靠颜色传递信息
4. 在日志文件中，颜色代码可能会显示为乱码，应考虑禁用

结语

PHP-Console-Color 为 PHP 命令行应用提供了简单而强大的颜色支持，通过合理使用可以大大提升用户体验。记住适度使用颜色，并始终提供不依赖颜色的替代信息传达方式。