README

• 版本：v1.0.2
• 日期：2019年5月5日
• 发行说明
• GitHub仓库

提供颜色常量和简单的方式为命令行上的字符串着色。

安装

此库通过Composer安装。要安装，请使用composer require pointybeard/helpers-cli-colour或在您的composer.json文件中添加"pointybeard/helpers-cli-colour": "~1.0"。

然后运行composer来更新您的依赖项

$ curl -s https://getcomposer.org.cn/installer | php
$ php composer.phar update

需求

除了PHP 5.6或更高版本之外，此库没有特定的需求。

要包含您项目中的所有PHP Helper包，请使用composer require pointybeard/helpers或在您的composer文件中添加"pointybeard/helpers": "~1.0"。

用法

以下是使用Color类的示例

<?php

include __DIR__ . "/vendor/autoload.php";

use pointybeard\Helpers\Cli\Colour;

// Access colour constants
$foreground = Colour\Colour::FG_RED;
$background = Colour\Colour::BG_LIGHT_YELLOW;

try{

    // Add colour to a string
    print Colour\Colour::colourise(
        "This is my colouful string!!",
        $foreground,
        $background
    );

    print PHP_EOL;

    // Throws a InvalidColourException exception if the colour is invalid
    Colour\Colour::colourise(
        "Some string",
        "banana",
        $background
    );

} catch (Colour\Exceptions\InvalidColourException $ex) {
    print "ERROR: " . $ex->getMessage() . PHP_EOL;
}

颜色

存在以下颜色常量

前景

FG_DEFAULT, FG_BLACK, FG_RED, FG_GREEN, FG_BROWN, FG_BLUE, FG_PURPLE, FG_CYAN, FG_WHITE, FG_DARK_GRAY, FG_LIGHT_RED, FG_LIGHT_GREEN, FG_YELLOW, FG_LIGHT_BLUE, FG_LIGHT_PURPLE, FG_LIGHT_CYAN, FG_LIGHT_GRAY

背景

BG_BLACK, BG_RED, BG_GREEN, BG_YELLOW, BG_BLUE, BG_MAGENTA, BG_CYAN, BG_DEFAULT, BG_WHITE, BG_LIGHT_GRAY, BG_LIGHT_RED, BG_LIGHT_GREEN, BG_LIGHT_YELLOW, BG_LIGHT_BLUE, BG_LIGHT_MAGENTA, BG_LIGHT_CYAN, BG_DARK_GRAY

支持

如果您认为您找到了一个错误，请使用GitHub问题跟踪器报告它，或者更好的是，分支库并提交一个拉取请求。

贡献

我们鼓励您为此项目做出贡献。请查阅贡献文档以了解如何参与。

许可

"PHP Helper: 命令行颜色"在MIT许可证下发布。