RAW
RAW = 0 : integer
Raw output constant - no modification of output text.
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.
write(string|array $message, integer $newlines = 1) : integer|boolean
Outputs a single or multiple messages to stdout or stderr. If no parameters are passed, outputs just a newline.
string|array | $message | A string or an array of strings to output |
integer | $newlines | Number of newlines to append |
The number of bytes returned from writing to output.
styles(string|null $style = null, array|boolean|null $definition = null) : mixed
Get the current styles offered, or append new ones in.
$output->styles('error');
$output->styles();
$output->styles('annoy', ['text' => 'purple', 'background' => 'yellow', 'blink' => true]);
$this->output->styles('annoy', false);
string|null | $style | The style to get or create. |
array|boolean|null | $definition | 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.
None found |
_replaceTags(array $matches) : string
Replace tags with color codes.
array | $matches | An array of matches to replace. |
None found |
_write(string $message) : integer|boolean
Writes a message to the output stream.
string | $message | Message to write. |
The number of bytes returned from writing to output.
None found |
Loading…