Console
API reference › yii › helpers › Console
Console helper provides useful methods for command line related tasks such as getting input or formatting and coloring output.
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
ansiColorizedSubstr() static | Returns the portion with ANSI color codes of string specified by the start and length parameters. | BaseConsole |
ansiFormat() static | Will return a string formatted with the given ANSI style. | BaseConsole |
ansiFormatCode() static | Returns the ANSI format code. | BaseConsole |
ansiStrlen() static | Returns the length of the string without ANSI color codes. | BaseConsole |
ansiStrwidth() static | Returns the width of the string without ANSI color codes. | BaseConsole |
ansiToHtml() static | Converts an ANSI formatted string to HTML. | BaseConsole |
beginAnsiFormat() static | Echoes an ANSI format code that affects the formatting of any text that is printed afterwards. | BaseConsole |
clearLine() static | Clears the line, the cursor is currently on by sending ANSI control code EL with argument 2 to the terminal. | BaseConsole |
clearLineAfterCursor() static | Clears text from cursor position to the end of the line by sending ANSI control code EL with argument 0 to the terminal. | BaseConsole |
clearLineBeforeCursor() static | Clears text from cursor position to the beginning of the line by sending ANSI control code EL with argument 1 to the terminal. | BaseConsole |
clearScreen() static | Clears entire screen content by sending ANSI control code ED with argument 2 to the terminal. | BaseConsole |
clearScreenAfterCursor() static | Clears text from cursor to the end of the screen by sending ANSI control code ED with argument 0 to the terminal. | BaseConsole |
clearScreenBeforeCursor() static | Clears text from cursor to the beginning of the screen by sending ANSI control code ED with argument 1 to the terminal. | BaseConsole |
confirm() static | Asks user to confirm by typing y or n. | BaseConsole |
endAnsiFormat() static | Resets any ANSI format set by previous method beginAnsiFormat() Any output after this will have default text format. | BaseConsole |
endProgress() static | Ends a progress bar that has been started by startProgress(). | BaseConsole |
error() static | Prints text to STDERR appended with a carriage return (PHP_EOL). | BaseConsole |
errorSummary() static | Generates a summary of the validation errors. | BaseConsole |
escape() static | Escapes % so they don’t get interpreted as color codes when the string is parsed by renderColoredString(). | BaseConsole |
getScreenSize() static | Returns terminal screen size. | BaseConsole |
hideCursor() static | Hides the cursor by sending ANSI DECTCEM code ?25l to the terminal. | BaseConsole |
input() static | Asks the user for input. Ends when the user types a carriage return (PHP_EOL). Optionally, It also provides a prompt. | BaseConsole |
isRunningOnWindows() static | Returns true if the console is running on windows. | BaseConsole |
markdownToAnsi() static | Converts Markdown to be better readable in console environments by applying some ANSI format. | BaseConsole |
moveCursorBackward() static | Moves the terminal cursor backward by sending ANSI control code CUB to the terminal. | BaseConsole |
moveCursorDown() static | Moves the terminal cursor down by sending ANSI control code CUD to the terminal. | BaseConsole |
moveCursorForward() static | Moves the terminal cursor forward by sending ANSI control code CUF to the terminal. | BaseConsole |
moveCursorNextLine() static | Moves the terminal cursor to the beginning of the next line by sending ANSI control code CNL to the terminal. | BaseConsole |
moveCursorPrevLine() static | Moves the terminal cursor to the beginning of the previous line by sending ANSI control code CPL to the terminal. | BaseConsole |
moveCursorTo() static | Moves the cursor to an absolute position given as column and row by sending ANSI control code CUP or CHA to the terminal. | BaseConsole |
moveCursorUp() static | Moves the terminal cursor up by sending ANSI control code CUU to the terminal. | BaseConsole |
output() static | Prints text to STDOUT appended with a carriage return (PHP_EOL). | BaseConsole |
prompt() static | Prompts the user for input and validates it. | BaseConsole |
renderColoredString() static | Converts a string to ansi formatted by replacing patterns like %y (for yellow) with ansi control codes. | BaseConsole |
restoreCursorPosition() static | Restores the cursor position saved with saveCursorPosition() by sending ANSI control code RCP to the terminal. | BaseConsole |
saveCursorPosition() static | Saves the current cursor position by sending ANSI control code SCP to the terminal. | BaseConsole |
scrollDown() static | Scrolls whole page down by sending ANSI control code SD to the terminal. | BaseConsole |
scrollUp() static | Scrolls whole page up by sending ANSI control code SU to the terminal. | BaseConsole |
select() static | Gives the user an option to choose from. Giving ’?’ as an input will show a list of options to choose from and their explanations. | BaseConsole |
showCursor() static | Will show a cursor again when it has been hidden by hideCursor() by sending ANSI DECTCEM code ?25h to the terminal. | BaseConsole |
startProgress() static | Starts display of a progress bar on screen. | BaseConsole |
stderr() static | Prints a string to STDERR. | BaseConsole |
stdin() static | Gets input from STDIN and returns a string right-trimmed for EOLs. | BaseConsole |
stdout() static | Prints a string to STDOUT. | BaseConsole |
streamSupportsAnsiColors() static | Returns true if the stream supports colorization. ANSI colors are disabled if not supported by the stream. | BaseConsole |
stripAnsiFormat() static | Strips ANSI control codes from a string. | BaseConsole |
updateProgress() static | Updates a progress bar that has been started by startProgress(). | BaseConsole |
wrapText() static | Word wrap text with indentation to fit the screen size. | BaseConsole |
xtermBgColor() static | Returns the ansi format code for xterm background color. | BaseConsole |
xtermFgColor() static | Returns the ansi format code for xterm foreground color. | BaseConsole |