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.
__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
string
_write( string $message )
Writes a message to the output stream.
$message
boolean
outputAs( integer $type null )
Get/Set the output type to use. The output type how formatting tags are treated.
$type
optional null mixed
styleText( string $text )
Apply styling to text.
$text
string
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 mixed
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 integer
integer | COLOR Color output - Convert known tags in to ANSI color escape codes. | 2 |
string | LF Constant for a newline. | PHP_EOL |
integer | PLAIN Plain output - tags will be stripped. | 1 |
integer | RAW Raw output constant - no modification of output text. | 0 |
© 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.
http://api.cakephp.org/2.7/class-ConsoleOutput.html