Class ConsoleOutputStub

StubOutput makes testing shell commands/shell helpers easier.

You can use this class by injecting it into a Helper instance:

App::uses("ConsoleOutputStub", "TestSuite/Stub");

$output = new ConsoleOutputStub();
$helper = new ProgressHelper($output);
ConsoleOutput
Extended by ConsoleOutputStub
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Location: Cake/TestSuite/Stub/ConsoleOutputStub.php

Inherited Constants

Properties summary

  • $_lastWritten protected
    integer
    The number of bytes written by last call to write
  • $_out protected
    array
    Buffered messages.

Inherited Properties

Method Summary

  • messages() public
    Get the buffered output.
  • overwrite() public
    Overwrite output already written to the buffer.
  • write() public
    Write output to the buffer.

Method Detail

messages()source public 

messages( )

Get the buffered output.

Returns

array

overwrite()source public 

overwrite( array|string $message , integer $newlines 1 , integer $size null )

Overwrite output already written to the buffer.

Parameters

array|string $message
The message to output.
integer $newlines optional 1
Number of newlines to append.
integer $size optional null

The number of bytes to overwrite. Defaults to the length of the last message output.

Overrides

ConsoleOutput::overwrite()

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

ConsoleOutput::write()

Methods inherited from ConsoleOutput

__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

boolean
success

outputAs()source public 

outputAs( integer $type null )

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

Parameters

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

Returns

mixed
Either null or the value if getting.

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 $style null , array $definition null )

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

Get a style definition

$this->output->styles('error');

Get all the style definitions

$this->output->styles();

Create or modify an existing style

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

Remove a style

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

Parameters

string $style optional null
The style to get or create.
array $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.


Properties detail

$_lastWrittensource

protected integer

The number of bytes written by last call to write

$_outsource

protected array

Buffered messages.

array()

© 2005–2017 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/2.10/class-ConsoleOutputStub.html