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.

Direct Subclasses

Namespace: Cake\Console
Location: Console/ConsoleOutput.php

Constants summary

  • integer

    COLOR
    2

  • string

    LF
    PHP_EOL

  • integer

    PLAIN
    1

  • integer

    RAW
    0

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
    integer
    The current output type. Manipulated with ConsoleOutput::outputAs();
  • $_styles protected static
    array

    Styles that are available as tags in console output. You can modify these styles with ConsoleOutput::styles()

Method Summary

  • __construct() public
    Construct the output object.
  • __destruct() public
    Clean up and close handles
  • _replaceTags() protected
    Replace tags with color codes.
  • _write() protected
    Writes a message to the output stream.
  • getOutputAs() public
    Get the output type on how formatting tags are treated.
  • outputAs() public deprecated
    Get/Set the output type to use. The output type how formatting tags are treated.
  • setOutputAs() public
    Set the output type on how formatting tags are treated.
  • styleText() public
    Apply styling to text.
  • styles() public
    Get the current styles offered, or append new ones in.
  • write() public

    Outputs a single or multiple messages to stdout or stderr. If no parameters are passed, outputs just a newline.

Method Detail

__construct()source public 

__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.

Parameters

string $stream optional 'php://stdout'
The identifier of the stream to write output to.

__destruct()source public 

__destruct( )

Clean up and close handles

_replaceTags()source protected 

_replaceTags( array $matches )

Replace tags with color codes.

Parameters

array $matches
An array of matches to replace.

Returns

string

_write()source protected 

_write( string $message )

Writes a message to the output stream.

Parameters

string $message
Message to write.

Returns

integer|boolean
The number of bytes returned from writing to output.

getOutputAs()source public 

getOutputAs( )

Get the output type on how formatting tags are treated.

Returns

integer

outputAs()source public deprecated 

outputAs( integer|null $type = null )

Get/Set the output type to use. The output type how formatting tags are treated.

Deprecated

3.5.0 Use getOutputAs()/setOutputAs() instead.

Parameters

integer|null $type optional null
The output type to use. Should be one of the class constants.

Returns

integer|null
Either null or the value if getting.

setOutputAs()source public 

setOutputAs( integer $type )

Set the output type on how formatting tags are treated.

Parameters

integer $type
The output type to use. Should be one of the class constants.

Throws

InvalidArgumentException
in case of a not supported output type.

styleText()source public 

styleText( string $text )

Apply styling to text.

Parameters

string $text
Text with styling tags.

Returns

string
String with color codes added.

styles()source public 

styles( string|null $style = null , array|boolean|null $definition = null )

Get the current styles offered, or append new ones in.

Get a style definition

$output->styles('error');

Get all the style definitions

$output->styles();

Create or modify an existing style

$output->styles('annoy', ['text' => 'purple', 'background' => 'yellow', 'blink' => true]);

Remove a style

$this->output->styles('annoy', false);

Parameters

string|null $style optional null
The style to get or create.
array|boolean|null $definition optional null

The array definition of the style to change or create a style or false to remove a style.

Returns

mixed

If you are getting styles, the style or null will be returned. If you are creating/modifying styles true will be returned.


write()source public 

write( string|array $message , integer $newlines = 1 )

Outputs a single or multiple messages to stdout or stderr. If no parameters are passed, outputs just a newline.

Parameters

string|array $message
A string or an array of strings to output
integer $newlines optional 1
Number of newlines to append

Returns

integer|boolean
The number of bytes returned from writing to output.

Properties detail

$_backgroundColorssource

protected static array

background colors used in colored output.

[
    'black' => 40,
    'red' => 41,
    'green' => 42,
    'yellow' => 43,
    'blue' => 44,
    'magenta' => 45,
    'cyan' => 46,
    'white' => 47
]

$_foregroundColorssource

protected static array

text colors used in colored output.

[
    'black' => 30,
    'red' => 31,
    'green' => 32,
    'yellow' => 33,
    'blue' => 34,
    'magenta' => 35,
    'cyan' => 36,
    'white' => 37
]

$_optionssource

protected static array

Formatting options for colored output.

[
    'bold' => 1,
    'underline' => 4,
    'blink' => 5,
    'reverse' => 7,
]

$_outputsource

protected resource

File handle for output.

$_outputAssource

protected integer

The current output type. Manipulated with ConsoleOutput::outputAs();

self::COLOR

$_stylessource

protected static array

Styles that are available as tags in console output. You can modify these styles with ConsoleOutput::styles()

[
    'emergency' => ['text' => 'red'],
    'alert' => ['text' => 'red'],
    'critical' => ['text' => 'red'],
    'error' => ['text' => 'red'],
    'warning' => ['text' => 'yellow'],
    'info' => ['text' => 'cyan'],
    'debug' => ['text' => 'yellow'],
    'success' => ['text' => 'green'],
    'comment' => ['text' => 'blue'],
    'question' => ['text' => 'magenta'],
    'notice' => ['text' => 'cyan']
]

© 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/3.6/class-Cake.Console.ConsoleOutput.html