Class yii\helpers\Console

继承yii\helpers\Console » yii\helpers\BaseConsole
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/helpers/Console.php

控制台助手为命令行相关任务提供了有用的方法, 例如获取输入或格式化/着色输出.

公共方法

隐藏继承的方法

方法描述定义在
ansiColorizedSubstr() 返回带有由开始和长度参数指定的字符串的ANSI颜色代码的部分. yii\helpers\BaseConsole
ansiFormat() 将返回一个使用给定ANSI样式格式化的字符串. yii\helpers\BaseConsole
ansiFormatCode() 返回ANSI格式的代码. yii\helpers\BaseConsole
ansiStrlen() 返回没有ANSI颜色代码的字符串的长度. yii\helpers\BaseConsole
ansiStrwidth() 返回不带ANSI颜色代码的字符串的宽度. yii\helpers\BaseConsole
ansiToHtml() ANSI格式的字符串转换为HTML. yii\helpers\BaseConsole
beginAnsiFormat() 输出一种ANSI格式的代码, 它会影响以后打印的任何文本格式. yii\helpers\BaseConsole
clearLine() 清除行, 通过将带有参数2ANSI控制代码EL发送到终端, 光标当前处于打开状态. yii\helpers\BaseConsole
clearLineAfterCursor() 通过将带有参数0ANSI控制代码EL发送到终端, 将文本从光标位置清除到行尾. yii\helpers\BaseConsole
clearLineBeforeCursor() 通过将带有参数1ANSI控制代码EL发送到终端, 将文本从光标位置清除到行首. yii\helpers\BaseConsole
clearScreen() 通过将带有参数2ANSI控制代码ED发送到终端, 来清除整个屏幕内容. yii\helpers\BaseConsole
clearScreenAfterCursor() 通过将带有参数0ANSI控制代码ED发送到终端, 将文本从光标位置清除到屏幕的末尾. yii\helpers\BaseConsole
clearScreenBeforeCursor() 通过将带有参数1ANSI控制代码ED发送到终端, 将文本从光标位置清除到屏幕的开头. yii\helpers\BaseConsole
confirm() 要求用户通过键入yn来确认. 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 控制代码?25l来隐藏光标. yii\helpers\BaseConsole
input() 请求用户输入. 当用户键入回车符(PHP_EOL)时结束. yii\helpers\BaseConsole
isRunningOnWindows() 如果控制台在windows上运行, 则返回true. yii\helpers\BaseConsole
markdownToAnsi() 通过应用一些ANSI格式, 将Markdown转换为在控制台环境中更好的可读性. yii\helpers\BaseConsole
moveCursorBackward() 通过向终端发送 ANSI 控制代码 CUU, 将终端光标向后移动. yii\helpers\BaseConsole
moveCursorDown() 通过向终端发送 ANSI 控制代码 CUU, 将终端光标向下移动. yii\helpers\BaseConsole
moveCursorForward() 通过向终端发送 ANSI 控制代码 CUU, 将终端光标向前移动. yii\helpers\BaseConsole
moveCursorNextLine() 通过向终端发送 ANSI 控制代码 CUU, 将终端光标移动到下一行的开头. yii\helpers\BaseConsole
moveCursorPrevLine() 通过向终端发送 ANSI 控制代码 CUU 将终端光标移动到上一行的开头. yii\helpers\BaseConsole
moveCursorTo() 通过向终端发送 ANSI 控制代码 CUU, 将终端光标移动到列和行给出的绝对位置. yii\helpers\BaseConsole
moveCursorUp() 通过向终端发送 ANSI 控制代码 CUU, 将终端光标向上移动. yii\helpers\BaseConsole
output() 打印带有回车信息(PHP_EOL)的STDOUT文本. yii\helpers\BaseConsole
prompt() 提示用户输入并验证它. yii\helpers\BaseConsole
renderColoredString() 将字符串转换为ansi格式, 通过用ansi控制代码替换%y(黄色)等模式. yii\helpers\BaseConsole
restoreCursorPosition() 通过向终端发送 ANSI 控制代码 RCP, 将光标位置恢复到用 saveCursorPosition() 保存的位置. yii\helpers\BaseConsole
saveCursorPosition() 通过向终端发送 ANSI 控制代码 SCP, 来保存当前光标位置. yii\helpers\BaseConsole
scrollDown() 通过向终端发送 ANSI 控制代码 SD, 将整个页面向下滚动. yii\helpers\BaseConsole
scrollUp() 通过向终端发送 ANSI 控制代码 SU, 将整个页面向上滚动. yii\helpers\BaseConsole
select() 为用户提供可供选择的选项. 输入?则给出可供选择的选项及其选项列表的对应的说明解释. yii\helpers\BaseConsole
showCursor() 当光标被 hideCursor() 隐藏后, 通过向终端发送 ANSI 控制代码?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