Object wrapper for outputting information from a shell application. Can be connected to any stream resource that can be used with fopen()
Can generate colorized output on consoles that support it. There are a few built in styles
error Error messages.warning Warning messages.info Informational messages.comment Additional text.question Magenta text used for user promptsBy defining styles with addStyle() you can create custom console styles.
You can format console output using tags with the name of the style to apply. From inside a shell object
$this->out('<warning>Overwrite:</warning> foo.php was overwritten.');
This would create orange 'Overwrite:' text, while the rest of the text would remain the normal color. See ConsoleOutput::styles() to learn more about defining your own styles. Nested styles are not supported at this time.
integer
2 string
PHP_EOL integer
1 integer
0 arrayarray$_lastWritten protected integerThe number of bytes last written to the output stream used when overwriting the previous message.
string$_output protected resource$_outputAs protected integerarrayStyles that are available as tags in console output. You can modify these styles with ConsoleOutput::styles()
Outputs a single or multiple messages to stdout. If no parameters are passed, outputs just a newline.
__construct( string $stream 'php://stdout' )
Construct the output object.
Checks for a pretty console environment. Ansicon and ConEmu allows pretty consoles on Windows, and is supported.
$stream optional 'php://stdout' _replaceTags( array $matches )
Replace tags with color codes.
$matches _write( string $message )
Writes a message to the output stream.
$message outputAs( integer $type null )
Get/Set the output type to use. The output type how formatting tags are treated.
$type optional null overwrite( array|string $message , integer $newlines 1 , integer|null $size null )
Overwrite some already output text.
Useful for building progress bars, or when you want to replace text already output to the screen with new text.
Warning You cannot overwrite text that contains newlines.
$message $newlines optional 1 $size optional null The number of bytes to overwrite. Defaults to the length of the last message output.
styleText( string $text )
Apply styling to text.
$text styles( string $style null , array $definition null )
Get the current styles offered, or append new ones in.
$this->output->styles('error');
$this->output->styles();
$this->output->styles('annoy', array('text' => 'purple', 'background' => 'yellow', 'blink' => true));
$this->output->styles('annoy', false);
$style optional null $definition optional null The array definition of the style to change or create a style or false to remove a style.
If you are getting styles, the style or null will be returned. If you are creating/modifying styles true will be returned.
write( string|array $message , integer $newlines 1 )
Outputs a single or multiple messages to stdout. If no parameters are passed, outputs just a newline.
$message $newlines optional 1 protected static array
background colors used in colored output.
array(
'black' => 40,
'red' => 41,
'green' => 42,
'yellow' => 43,
'blue' => 44,
'magenta' => 45,
'cyan' => 46,
'white' => 47
) protected static array
text colors used in colored output.
array(
'black' => 30,
'red' => 31,
'green' => 32,
'yellow' => 33,
'blue' => 34,
'magenta' => 35,
'cyan' => 36,
'white' => 37
) protected integer
The number of bytes last written to the output stream used when overwriting the previous message.
protected static string
formatting options for colored output
array(
'bold' => 1,
'underline' => 4,
'blink' => 5,
'reverse' => 7,
) protected integer
The current output type. Manipulated with ConsoleOutput::outputAs();
self::COLOR
protected static array
Styles that are available as tags in console output. You can modify these styles with ConsoleOutput::styles()
array(
'emergency' => array('text' => 'red', 'underline' => true),
'alert' => array('text' => 'red', 'underline' => true),
'critical' => array('text' => 'red', 'underline' => true),
'error' => array('text' => 'red', 'underline' => true),
'warning' => array('text' => 'yellow'),
'info' => array('text' => 'cyan'),
'debug' => array('text' => 'yellow'),
'success' => array('text' => 'green'),
'comment' => array('text' => 'blue'),
'question' => array('text' => 'magenta'),
'notice' => array('text' => 'cyan')
)
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.9/class-ConsoleOutput.html