hvolschenk/cliphf

PHP CLI 格式化库。

v3.0.1 2016-12-06 20:49 UTC

This package is not auto-updated.

Last update: 2024-09-28 19:58:18 UTC


README

非常简单的 PHP CLI 格式化工具。

安装

Cliphf 可以通过 Github 上的仓库克隆,也可以通过 composer 安装。推荐使用 composer 安装,因为这样可以方便地接收更新。

Composer

$ php composer.phar require hvolschenk/cliphf

Git

$ git clone https://github.com/righteous-trespasser/cliphf.git

用法

输出

您可以使用 Output::format 静态方法格式化命令行输出。它只接受一个参数,即要格式化的字符串。您可以使用类似 HTML 的语法指定格式,如下例所示

use Hvolschenk\Cliphf;

Output::format('{italic}Checking config{/italic}...');
if ($something === true) {
  Output::format('{bold}{green}Done.{/green}{/bold}')
}

输入

捕获输入同样简单。您可以通过 CliPh-F 指定带有格式化标签的普通文本输入和密码输入

$name = Input::text('Please enter your name: ');
$password = Input::password('Secret password: ');

输入文本也可以进行格式化,并使用输出类来格式化文本

use Hvolschenk\Cliphf;

$name = Input::text('{bold}{underline}Dangerous input:{/underline}{/bold}');

规则

内置了 10 个文本样式规则和 8 种颜色。规则如下

  • blink
    • 创建闪烁文本
  • bold
    • 使用粗体字体突出显示文本
  • dim
    • 通过使颜色变暗来使文本变暗
  • hide
    • 创建隐藏文本(颜色与背景相同,不可突出显示)
  • invert
    • 反转背景和前景颜色
  • italic
    • 通过使文本斜体来强调文本
  • strikethrough
    • 在文本上画一条线
  • underline
    • 通过在文本下划线来引起注意
  • remove
    • 删除所有格式
  • break
    • 添加换行符

8 种颜色如下

  • black
  • blue
  • cyan
  • green
  • magenta
  • red
  • white
  • yellow