Class ConsoleOutput
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 prompts
By defining styles with addStyle() you can create custom console styles.
Using styles in output
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.
Constants summary
-
int
COLOR2
-
string
LFPHP_EOL
-
int
PLAIN1
-
int
RAW0
Properties summary
- $_backgroundColors protected static
array
background colors used in colored output.
- $_foregroundColors protected static
array
text colors used in colored output.
- $_options protected static
array
Formatting options for colored output.
- $_output protected
resource
File handle for output.
- $_outputAs protected
int
The current output type.
- $_styles protected static
array
Styles that are available as tags in console output.
Method Summary
- write() public
Outputs a single or multiple messages to stdout or stderr. If no parameters are passed, outputs just a newline.
Method Detail
__construct() public
__construct(string $stream)
Construct the output object.
Checks for a pretty console environment. Ansicon and ConEmu allows pretty consoles on windows, and is supported.
Parameters
-
string
$stream optional The identifier of the stream to write output to.
__destruct() public
__destruct()
Clean up and close handles
_replaceTags() protected
_replaceTags(array $matches)
Replace tags with color codes.
Parameters
-
array
$matches An array of matches to replace.
Returns
string
_write() protected
_write(string $message)
Writes a message to the output stream.
Parameters
-
string
$message Message to write.
Returns
int
The number of bytes returned from writing to output.
getOutputAs() public
getOutputAs()
Get the output type on how formatting tags are treated.
Returns
int
getStyle() public
getStyle(string $style)
Gets the current styles offered
Parameters
-
string
$style The style to get.
Returns
array
The style or empty array.
setOutputAs() public
setOutputAs(int $type)
Set the output type on how formatting tags are treated.
Parameters
-
int
$type The output type to use. Should be one of the class constants.
Throws
InvalidArgumentException
in case of a not supported output type.
setStyle() public
setStyle(string $style, array $definition)
Sets style.
Creates or modifies an existing style.
$output->setStyle('annoy', ['text' => 'purple', 'background' => 'yellow', 'blink' => true]);
Remove a style
$this->output->setStyle('annoy', []);
Parameters
-
string
$style The style to set.
-
array
$definition The array definition of the style to change or create..
styleText() public
styleText(string $text)
Apply styling to text.
Parameters
-
string
$text Text with styling tags.
Returns
string
String with color codes added.
styles() public
styles()
Gets all the style definitions.
Returns
array
write() public
write(mixed $message, int $newlines)
Outputs a single or multiple messages to stdout or stderr. If no parameters are passed, outputs just a newline.
Parameters
-
string|string[]
$message A string or an array of strings to output
-
int
$newlines optional Number of newlines to append
Returns
int
The number of bytes returned from writing to output.
Property Detail
$_backgroundColors protected static
background colors used in colored output.
Type
array
$_foregroundColors protected static
text colors used in colored output.
Type
array
$_options protected static
Formatting options for colored output.
Type
array
$_output protected
File handle for output.
Type
resource
$_outputAs protected
The current output type.
Type
int
$_styles protected static
Styles that are available as tags in console output.
You can modify these styles with ConsoleOutput::styles()
Type
array
© 2005–present 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/4.1/class-Cake.Console.ConsoleOutput.html