Class yii\helpers\BaseConsole

将返回一个使用给定 ANSI 样式格式化的字符串。

返回 ANSI 格式代码。

返回没有 ANSI 颜色代码的字符串长度。

将 ANSI 格式的字符串转换为 HTML。

Note: 目前不支持 xTerm 256 位颜色。

输出一种 ANSI 格式代码，它影响以后打印的任何文本的格式。

参见：

• ansiFormatCode()
• endAnsiFormat()

清除行，光标当前是通过发送 ANSI 控制代码 EL 带有参数 2 到终端。 不会改变光标位置。

通过将参数为 0 的 ANSI 控制代码 EL 发送到终端，将文本从光标位置清除到行尾。 不会改变光标位置。

通过向终端发送带有变量 1 的 ANSI 控制码 EL，将文本从光标位置清除到行的开始位置。 不会改变光标位置。

通过发送参数带有 2 的 ANSI 控制代码 ED 到终端来清除整个屏幕内容。 不会改变光标位置。 Note: ANSI.SYS 能够实现在 windows 中将坐标位置重置到屏幕左上角。

通过发送参数带有 0 的 ANSI 控制代码 ED 发送到终端，将文本从光标清除到屏幕末端。 不会改变光标位置。

通过发送参数带有 1 的 ANSI 控制代码 ED 发送到终端，将文本从光标处清除到屏幕的开头。 不会改变光标位置。

请用户输入 y 或 n 进行确认。

一个典型的用法如下：

if (Console::confirm("Are you sure?")) {
    echo "user typed yes\n";
} else {
    echo "user typed no\n";
}

重置之前方法 beginAnsiFormat() 设置的任何 ANSI 格式。 在此之后的任何输出都将具有默认的文本格式。 这等于调用。

echo Console::ansiFormatCode([Console::RESET])

通过 startProgress() 结束已启动的进度条。

参见：

• startProgress()
• updateProgress()

打印文本到 STDERR 并附加回车信息（PHP_EOL）。

生成验证错误的摘要。

当字符串被解析时如果包含转义符 % 则它们不会通过 renderColoredString() 解释为颜色代码。

返回终端屏幕大小。

使用如下：

list($width, $height) = ConsoleHelper::getScreenSize();

通过向终端发送 ANSI DECTCEM 代码 ?25l 来隐藏光标。 使用 showCursor() 将它带回来。 应用程序退出时不要忘记显示光标。退出后光标可能会隐藏在终端中。

请求用户输入。当用户键入回车时结束（PHP_EOL）。 可选，它还提供了一个提示。

如果控制台在 windows 上运行，则返回 true。

通过应用一些 ANSI 格式，将 Markdown 转换为在控制台环境中更好的可读性。

通过向终端发送 ANSI 控制代码 CUB，将终端光标向后移动。 如果光标已经在屏幕边缘，则不会有任何效果。

通过向终端发送 ANSI 控制代码 CUD 将终端光标向下移动。 如果光标已经在屏幕边缘，则不会有任何效果。

通过向终端发送 ANSI 控制代码 CUF，将终端光标向前移动。 如果光标已经在屏幕边缘，则不会有任何效果。

通过向终端发送 ANSI 控制代码 CNL，将终端光标移动到下一行的开头。

通过向终端发送 ANSI 控制代码 CPL，将终端光标移动到前一行的开头。

通过发送 ANSI 控制码 CUP 或 CHA 到终端，将光标移动到列和行给定的绝对位置。

通过向终端发送 ANSI 控制代码 CUU 将终端光标向上移动。 如果光标已经在屏幕边缘，则不会有任何效果。

打印带有回车信息的 STDOUT 文本（PHP_EOL）。

提示用户输入并验证。

将字符串转换成 ansi 格式，用 ansi 控制代码模式 %y 替换成（黄色）。

与 https://github.com/pear/Console_Color2/blob/master/Console/Color2.php 使用几乎相同的语法 这张转换表如下： （在一些终端上 'bold' 意思是 'light'）。它几乎与 irssi 使用的转换表相同。

             text      text            background
 ------------------------------------------------
 %k %K %0    black     dark grey       black
 %r %R %1    red       bold red        red
 %g %G %2    green     bold green      green
 %y %Y %3    yellow    bold yellow     yellow
 %b %B %4    blue      bold blue       blue
 %m %M %5    magenta   bold magenta    magenta
 %p %P       magenta (think: purple)
 %c %C %6    cyan      bold cyan       cyan
 %w %W %7    white     bold white      white

 %F     Blinking, Flashing
 %U     Underline
 %8     Reverse
 %_,%9  Bold

 %n     Resets the color
 %%     A single %

通过将 ANSI 控制代码 RCP 发送到终端，恢复 saveCursorPosition() 保存的光标位置。

将 ANSI 控制代码 SCP 发送到终端，保存当前光标位置。 可以使用 restoreCursorPosition() 恢复位置。

通过向终端发送 ANSI 控制码 SD，向下滚动整个页面。 在顶部添加新行。ANSI 不支持这种方法。windows 中使用的 SYS。

通过向终端发送 ANSI 控制码 SU，将整个页面向上滚动。 在底部添加了新行。ANSI 不支持这种方法。windows 中使用的 SYS。

给用户一个选项进行选择。 输入 '?' 则给出可供选择的选项及其选项列表对应的说明解释。

当光标被 hideCursor() 隐藏时，将通过发送 ANSI DECTCEM 代码 ?25h 再次显示光标。

开始在屏幕上显示进度条。

这进度条将被 updateProgress() 进行更新并且通过 endProgress() 进行结束。

下面的示例显示了进度条的简单用法：

Console::startProgress(0, 1000);
for ($n = 1; $n <= 1000; $n++) {
    usleep(1000);
    Console::updateProgress($n, 1000);
}
Console::endProgress();

像 Git 克隆一样进步（只显示状态信息）：

Console::startProgress(0, 1000, 'Counting objects: ', false);
for ($n = 1; $n <= 1000; $n++) {
    usleep(1000);
    Console::updateProgress($n, 1000);
}
Console::endProgress("done." . PHP_EOL);

参见：

• startProgress()
• updateProgress()
• endProgress()

将字符串打印到 STDERR。

从 STDIN 获取输入，并为 EOL 返回右侧被截取后的字符串

打印字符串到 STDOUT。

如果流支持彩色化则返回 true。如果流不支持则 ANSI 颜色被禁用。

• 不含 ansicon 窗口
• 非 tty 控制台

从字符串中剥离 ANSI 控制代码

使用 startProgress() 更新已启动的进度条。

参见：

• startProgress()
• endProgress()

自动缩进以适合屏幕大小

如果无法检测到屏幕大小，或者缩进大于屏幕尺寸，则文本不会被换行。

第一行将被 not 定义，因此 Console::wrapText("Lorem ipsum dolor sit amet.", 4) 会产生以下输出，给定屏幕宽度为 16 个字符：

Lorem ipsum
    dolor sit
    amet.

返回 xterm 背景颜色的 ansi 格式代码。

您可以将它的返回值传递给一个格式化方法： ansiFormat()，ansiFormatCode()，beginAnsiFormat()。

参见 http://en.wikipedia.org/wiki/Talk:ANSI_escape_code#xterm-256colors.

返回 xterm 前景颜色的 ansi 格式代码。

您可以将这个函数的返回值传递给以下格式方法之一： ansiFormat()，ansiFormatCode()，beginAnsiFormat()。

参见 http://en.wikipedia.org/wiki/Talk:ANSI_escape_code#xterm-256colors.