没有命名空间的类 yii yii\base yii\behaviors yii\caching yii\captcha yii\console yii\console\controllers yii\console\widgets yii\data yii\db yii\db\conditions yii\db\cubrid yii\db\cubrid\conditions yii\db\mssql yii\db\mssql\conditions yii\db\mysql yii\db\oci yii\db\oci\conditions yii\db\pgsql yii\db\sqlite yii\db\sqlite\conditions yii\di yii\filters yii\filters\auth yii\grid yii\helpers yii\i18n yii\log yii\mail yii\mutex yii\rbac yii\rest yii\test yii\validators yii\web yii\widgets

Class yii\helpers\Console

所有类 | 方法 | 常量
继承yii\helpers\Console » yii\helpers\BaseConsole
可用版本自2.0
源码 https://github.com/yiichina/yii2/blob/api/framework/helpers/Console.php

控制台帮助程序为与命令行相关的任务提供了有用的方法， 例如获取输入、格式化和着色输出。

公共方法

隐藏继承的方法

方法描述被定义在
ansiFormat() 将返回一个使用给定 ANSI 样式格式化的字符串。 yii\helpers\BaseConsole
ansiFormatCode() 返回 ANSI 格式代码。 yii\helpers\BaseConsole
ansiStrlen() 返回没有 ANSI 颜色代码的字符串长度。 yii\helpers\BaseConsole
ansiToHtml() 将 ANSI 格式的字符串转换为 HTML。 yii\helpers\BaseConsole
beginAnsiFormat() 输出一种 ANSI 格式代码，它影响以后打印的任何文本的格式。 yii\helpers\BaseConsole
clearLine() 清除行，光标当前是通过发送 ANSI 控制代码 EL 带有参数 2 到终端。 不会改变光标位置。 yii\helpers\BaseConsole
clearLineAfterCursor() 通过将参数为 0 的 ANSI 控制代码 EL 发送到终端，将文本从光标位置清除到行尾。 不会改变光标位置。 yii\helpers\BaseConsole
clearLineBeforeCursor() 通过向终端发送带有变量 1 的 ANSI 控制码 EL，将文本从光标位置清除到行的开始位置。 不会改变光标位置。 yii\helpers\BaseConsole
clearScreen() 通过发送参数带有 2 的 ANSI 控制代码 ED 到终端来清除整个屏幕内容。 不会改变光标位置。 Note: ANSI.SYS 能够实现在 windows 中将坐标位置重置到屏幕左上角。 yii\helpers\BaseConsole
clearScreenAfterCursor() 通过发送参数带有 0 的 ANSI 控制代码 ED 发送到终端，将文本从光标清除到屏幕末端。 不会改变光标位置。 yii\helpers\BaseConsole
clearScreenBeforeCursor() 通过发送参数带有 1 的 ANSI 控制代码 ED 发送到终端，将文本从光标处清除到屏幕的开头。 不会改变光标位置。 yii\helpers\BaseConsole
confirm() 请用户输入 y 或 n 进行确认。 yii\helpers\BaseConsole
endAnsiFormat() 重置之前方法 beginAnsiFormat() 设置的任何 ANSI 格式。 在此之后的任何输出都将具有默认的文本格式。 这等于调用。 yii\helpers\BaseConsole
endProgress() 通过 startProgress() 结束已启动的进度条。 yii\helpers\BaseConsole
error() 打印文本到 STDERR 并附加回车信息（PHP_EOL）。 yii\helpers\BaseConsole
errorSummary() 生成验证错误的摘要。 yii\helpers\BaseConsole
escape() 当字符串被解析时如果包含转义符 % 则它们不会通过 renderColoredString() 解释为颜色代码。 yii\helpers\BaseConsole
getScreenSize() 返回终端屏幕大小。 yii\helpers\BaseConsole
hideCursor() 通过向终端发送 ANSI DECTCEM 代码 ?25l 来隐藏光标。 使用 showCursor() 将它带回来。 应用程序退出时不要忘记显示光标。退出后光标可能会隐藏在终端中。 yii\helpers\BaseConsole
input() 请求用户输入。当用户键入回车时结束（PHP_EOL）。 可选，它还提供了一个提示。 yii\helpers\BaseConsole
isRunningOnWindows() 如果控制台在 windows 上运行，则返回 true。 yii\helpers\BaseConsole
markdownToAnsi() 通过应用一些 ANSI 格式，将 Markdown 转换为在控制台环境中更好的可读性。 yii\helpers\BaseConsole
moveCursorBackward() 通过向终端发送 ANSI 控制代码 CUB，将终端光标向后移动。 如果光标已经在屏幕边缘，则不会有任何效果。 yii\helpers\BaseConsole
moveCursorDown() 通过向终端发送 ANSI 控制代码 CUD 将终端光标向下移动。 如果光标已经在屏幕边缘，则不会有任何效果。 yii\helpers\BaseConsole
moveCursorForward() 通过向终端发送 ANSI 控制代码 CUF，将终端光标向前移动。 如果光标已经在屏幕边缘，则不会有任何效果。 yii\helpers\BaseConsole
moveCursorNextLine() 通过向终端发送 ANSI 控制代码 CNL，将终端光标移动到下一行的开头。 yii\helpers\BaseConsole
moveCursorPrevLine() 通过向终端发送 ANSI 控制代码 CPL，将终端光标移动到前一行的开头。 yii\helpers\BaseConsole
moveCursorTo() 通过发送 ANSI 控制码 CUP 或 CHA 到终端，将光标移动到列和行给定的绝对位置。 yii\helpers\BaseConsole
moveCursorUp() 通过向终端发送 ANSI 控制代码 CUU 将终端光标向上移动。 如果光标已经在屏幕边缘，则不会有任何效果。 yii\helpers\BaseConsole
output() 打印带有回车信息的 STDOUT 文本（PHP_EOL）。 yii\helpers\BaseConsole
prompt() 提示用户输入并验证。 yii\helpers\BaseConsole
renderColoredString() 将字符串转换成 ansi 格式，用 ansi 控制代码模式 %y 替换成（黄色）。 yii\helpers\BaseConsole
restoreCursorPosition() 通过将 ANSI 控制代码 RCP 发送到终端，恢复 saveCursorPosition() 保存的光标位置。 yii\helpers\BaseConsole
saveCursorPosition() 将 ANSI 控制代码 SCP 发送到终端，保存当前光标位置。 可以使用 restoreCursorPosition() 恢复位置。 yii\helpers\BaseConsole
scrollDown() 通过向终端发送 ANSI 控制码 SD，向下滚动整个页面。 在顶部添加新行。ANSI 不支持这种方法。windows 中使用的 SYS。 yii\helpers\BaseConsole
scrollUp() 通过向终端发送 ANSI 控制码 SU，将整个页面向上滚动。 在底部添加了新行。ANSI 不支持这种方法。windows 中使用的 SYS。 yii\helpers\BaseConsole
select() 给用户一个选项进行选择。 输入 '?' 则给出可供选择的选项及其选项列表对应的说明解释。 yii\helpers\BaseConsole
showCursor() 当光标被 hideCursor() 隐藏时，将通过发送 ANSI DECTCEM 代码 ?25h 再次显示光标。 yii\helpers\BaseConsole
startProgress() 开始在屏幕上显示进度条。 yii\helpers\BaseConsole
stderr() 将字符串打印到 STDERR。 yii\helpers\BaseConsole
stdin() 从 STDIN 获取输入，并为 EOL 返回右侧被截取后的字符串 yii\helpers\BaseConsole
stdout() 打印字符串到 STDOUT。 yii\helpers\BaseConsole
streamSupportsAnsiColors() 如果流支持彩色化则返回 true。如果流不支持则 ANSI 颜色被禁用。 yii\helpers\BaseConsole
stripAnsiFormat() 从字符串中剥离 ANSI 控制代码 yii\helpers\BaseConsole
updateProgress() 使用 startProgress() 更新已启动的进度条。 yii\helpers\BaseConsole
wrapText() 自动缩进以适合屏幕大小 yii\helpers\BaseConsole
xtermBgColor() 返回 xterm 背景颜色的 ansi 格式代码。 yii\helpers\BaseConsole
xtermFgColor() 返回 xterm 前景颜色的 ansi 格式代码。 yii\helpers\BaseConsole

常量

隐藏继承的常量

常量值描述被定义在
BG_BLACK 40 yii\helpers\BaseConsole
BG_BLUE 44 yii\helpers\BaseConsole
BG_CYAN 46 yii\helpers\BaseConsole
BG_GREEN 42 yii\helpers\BaseConsole
BG_GREY 47 yii\helpers\BaseConsole
BG_PURPLE 45 yii\helpers\BaseConsole
BG_RED 41 yii\helpers\BaseConsole
BG_YELLOW 43 yii\helpers\BaseConsole
BOLD 1 yii\helpers\BaseConsole
CONCEALED 8 yii\helpers\BaseConsole
CROSSED_OUT 9 yii\helpers\BaseConsole
ENCIRCLED 52 yii\helpers\BaseConsole
FG_BLACK 30 yii\helpers\BaseConsole
FG_BLUE 34 yii\helpers\BaseConsole
FG_CYAN 36 yii\helpers\BaseConsole
FG_GREEN 32 yii\helpers\BaseConsole
FG_GREY 37 yii\helpers\BaseConsole
FG_PURPLE 35 yii\helpers\BaseConsole
FG_RED 31 yii\helpers\BaseConsole
FG_YELLOW 33 yii\helpers\BaseConsole
FRAMED 51 yii\helpers\BaseConsole
ITALIC 3 yii\helpers\BaseConsole
NEGATIVE 7 yii\helpers\BaseConsole
NORMAL 0 yii\helpers\BaseConsole
OVERLINED 53 yii\helpers\BaseConsole
RESET 0 yii\helpers\BaseConsole
UNDERLINE 4 yii\helpers\BaseConsole