Class ConsoleOutput

use Cake\Console\ConsoleIo;
use Cake\TestSuite\Stub\ConsoleOutput;

$output = new ConsoleOutput();
$io = new ConsoleIo($output);

messages()source public

messages( )

Get the buffered output.

Returns

array

write()source public

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

Write output to the buffer.

Parameters

string|array $message

A string or an array of strings to output

integer $newlines optional 1

Number of newlines to append

Overrides

Cake\Console\ConsoleOutput::write()

__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

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.

[]