Spec-Zone.ru › Yii 2.0

Класс yii\helpers\Console

Все классы | Методы | Константы
Наследование yii\helpers\Console » yii\helpers\BaseConsole
Доступно начиная с версии 2.0
Исходный код https://github.com/yiisoft/yii2/blob/master/framework/helpers/Console.php

Помощник Console предоставляет полезные методы для задач, связанных с командной строкой, такие как ввод данных или форматирование и раскрашивание вывода.

Публичные методы

Метод Описание Определено в
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() Очищает текст от позиции курсора до конца строки, отправив терминалу ANSI-код EL с аргументом 0. yii\helpers\BaseConsole
clearLineBeforeCursor() Очищает текст от позиции курсора до начала строки, отправив терминалу ANSI-код EL с аргументом 1. yii\helpers\BaseConsole
clearScreen() Очищает всё содержимое экрана, отправив терминалу ANSI-код ED с аргументом 2. yii\helpers\BaseConsole
clearScreenAfterCursor() Очищает текст от курсора до конца экрана, отправив терминалу ANSI-код ED с аргументом 0. yii\helpers\BaseConsole
clearScreenBeforeCursor() Очищает текст от курсора до начала экрана, отправив терминалу ANSI-код ED с аргументом 1. yii\helpers\BaseConsole
confirm() Запрашивает подтверждение пользователя, введя y или n. yii\helpers\BaseConsole
endAnsiFormat() Сбрасывает любой формат ANSI, установленный предыдущим методом beginAnsiFormat(). Любой вывод после этого будет иметь стандартный формат текста. yii\helpers\BaseConsole
endProgress() Завершает полосу прогресса, начатую методом startProgress(). yii\helpers\BaseConsole
error() Выводит текст в STDERR, дополненный возвратом каретки (PHP_EOL). yii\helpers\BaseConsole
escape() Экранирует %, чтобы они не интерпретировались как коды цвета при разборе строки методом renderColoredString() yii\helpers\BaseConsole
getScreenSize() Использование: list($width, $height) = ConsoleHelper::getScreenSize(); yii\helpers\BaseConsole
hideCursor() Скрывает курсор, отправив терминалу ANSI-код DECTCEM ?25l. yii\helpers\BaseConsole
input() Запрашивает ввод у пользователя. Завершается, когда пользователь нажмёт Enter (PHP_EOL). Дополнительно, можно задать подсказку. yii\helpers\BaseConsole
isRunningOnWindows() Возвращает true, если консоль работает в Windows yii\helpers\BaseConsole
markdownToAnsi() Преобразует Markdown для лучшей читаемости в консольных средах, применяя некоторые форматы ANSI. 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-форматированную, заменяя шаблоны, например %y (для жёлтого), на ANSI-коды. yii\helpers\BaseConsole
restoreCursorPosition() Восстанавливает позицию курсора, сохранённую методом saveCursorPosition(), отправив терминалу ANSI-код RCP. 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-код DECTCEM ?25h. yii\helpers\BaseConsole
startProgress() Начинает отображение полосы прогресса на экране. yii\helpers\BaseConsole
stderr() Выводит строку в STDERR. yii\helpers\BaseConsole
stdin() Получает ввод из STDIN и возвращает строку, обрезанную справа от символов конца строки. 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() Возвращает код ansi формата для цвета фона xterm. yii\helpers\BaseConsole
xtermFgColor() Возвращает код ansi формата для цвета переднего плана xterm. 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
BLINK 5 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

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-helpers-console.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API