Class yii\helpers\BaseConsole

Will return a string formatted with the given ANSI style.

Returns the ANSI format code.

Returns the length of the string without ANSI color codes.

Converts an ANSI formatted string to HTML.

Note: xTerm 256 bit colors are currently not supported.

Echoes an ANSI format code that affects the formatting of any text that is printed afterwards.

See also:

• ansiFormatCode()
• endAnsiFormat()

Clears the line, the cursor is currently on by sending ANSI control code EL with argument 2 to the terminal.

Cursor position will not be changed.

Clears text from cursor position to the end of the line by sending ANSI control code EL with argument 0 to the terminal.

Cursor position will not be changed.

Clears text from cursor position to the beginning of the line by sending ANSI control code EL with argument 1 to the terminal.

Cursor position will not be changed.

Clears entire screen content by sending ANSI control code ED with argument 2 to the terminal.

Cursor position will not be changed. Note: ANSI.SYS implementation used in windows will reset cursor position to upper left corner of the screen.

Clears text from cursor to the end of the screen by sending ANSI control code ED with argument 0 to the terminal.

Cursor position will not be changed.

Clears text from cursor to the beginning of the screen by sending ANSI control code ED with argument 1 to the terminal.

Cursor position will not be changed.

Asks user to confirm by typing y or n.

A typical usage looks like the following:

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

Resets any ANSI format set by previous method beginAnsiFormat() Any output after this will have default text format.

This is equal to calling.

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

Ends a progress bar that has been started by startProgress().

See also:

• startProgress()
• updateProgress()

Prints text to STDERR appended with a carriage return (PHP_EOL).

Generates a summary of the validation errors.

Escapes % so they don't get interpreted as color codes when the string is parsed by renderColoredString().

Returns terminal screen size.

Usage:

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

Hides the cursor by sending ANSI DECTCEM code ?25l to the terminal.

Use showCursor() to bring it back. Do not forget to show cursor when your application exits. Cursor might stay hidden in terminal after exit.

Asks the user for input. Ends when the user types a carriage return (PHP_EOL). Optionally, It also provides a prompt.

Returns true if the console is running on windows.

Converts Markdown to be better readable in console environments by applying some ANSI format.

Moves the terminal cursor backward by sending ANSI control code CUB to the terminal.

If the cursor is already at the edge of the screen, this has no effect.

Moves the terminal cursor down by sending ANSI control code CUD to the terminal.

If the cursor is already at the edge of the screen, this has no effect.

Moves the terminal cursor forward by sending ANSI control code CUF to the terminal.

If the cursor is already at the edge of the screen, this has no effect.

Moves the terminal cursor to the beginning of the next line by sending ANSI control code CNL to the terminal.

Moves the terminal cursor to the beginning of the previous line by sending ANSI control code CPL to the terminal.

Moves the cursor to an absolute position given as column and row by sending ANSI control code CUP or CHA to the terminal.

Moves the terminal cursor up by sending ANSI control code CUU to the terminal.

If the cursor is already at the edge of the screen, this has no effect.

Prints text to STDOUT appended with a carriage return (PHP_EOL).

Prompts the user for input and validates it.

Converts a string to ansi formatted by replacing patterns like %y (for yellow) with ansi control codes.

Uses almost the same syntax as https://github.com/pear/Console_Color2/blob/master/Console/Color2.php The conversion table is: ('bold' meaning 'light' on some terminals). It's almost the same conversion table irssi uses.

             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 %

Restores the cursor position saved with saveCursorPosition() by sending ANSI control code RCP to the terminal.

Saves the current cursor position by sending ANSI control code SCP to the terminal.

Position can then be restored with restoreCursorPosition().

Scrolls whole page down by sending ANSI control code SD to the terminal.

New lines are added at the top. This is not supported by ANSI.SYS used in windows.

Scrolls whole page up by sending ANSI control code SU to the terminal.

New lines are added at the bottom. This is not supported by ANSI.SYS used in windows.

Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations.

Will show a cursor again when it has been hidden by hideCursor() by sending ANSI DECTCEM code ?25h to the terminal.

Starts display of a progress bar on screen.

This bar will be updated by updateProgress() and my be ended by endProgress().

The following example shows a simple usage of a progress bar:

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

Git clone like progress (showing only status information): `php Console::startProgress(0, 1000, 'Counting objects: ', false); for ($n = 1; $n <= 1000; $n++) {

usleep(1000);
Console::updateProgress($n, 1000);

} Console::endProgress("done." . PHP_EOL); `

See also:

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

Prints a string to STDERR.

Gets input from STDIN and returns a string right-trimmed for EOLs.

Prints a string to STDOUT.

Returns true if the stream supports colorization. ANSI colors are disabled if not supported by the stream.

• windows without ansicon
• not tty consoles

Strips ANSI control codes from a string.

Updates a progress bar that has been started by startProgress().

See also:

• startProgress()
• endProgress()

Word wrap text with indentation to fit the screen size.

If screen size could not be detected, or the indentation is greater than the screen size, the text will not be wrapped.

The first line will not be indented, so Console::wrapText("Lorem ipsum dolor sit amet.", 4) will result in the following output, given the screen width is 16 characters:

Lorem ipsum
    dolor sit
    amet.

Returns the ansi format code for xterm background color.

You can pass the return value of this to one of the formatting methods: ansiFormat(), ansiFormatCode(), beginAnsiFormat().

See also http://en.wikipedia.org/wiki/Talk:ANSI_escape_code#xterm-256colors.

Returns the ansi format code for xterm foreground color.

You can pass the return value of this to one of the formatting methods: ansiFormat(), ansiFormatCode(), beginAnsiFormat().

See also http://en.wikipedia.org/wiki/Talk:ANSI_escape_code#xterm-256colors.