Class ConsoleOutput

StubOutput makes testing shell commands/shell helpers easier.

You can use this class by injecting it into a ConsoleIo instance that your command/task/helper uses:

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

$output = new ConsoleOutput();
$io = new ConsoleIo($output);
Namespace: Cake\TestSuite\Stub

Constants summary

  • int
    COLOR
    2
  • string
    LF
    PHP_EOL
  • int
    PLAIN
    1
  • int
    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.

  • $_out protected
    array

    Buffered messages.

  • $_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

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.

messages() public 

messages()

Get the buffered output.

Returns

array

output() public 

output()

Get the output as a string

Returns

string

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)

Write output to the buffer.

Parameters

string|string[] $message

A string or an array of strings to output

int $newlines optional

Number of newlines to append

Returns

int

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

$_out protected

Buffered messages.

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.TestSuite.Stub.ConsoleOutput.html