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
-
ConsoleOutputStub
License: MIT License
Location: Cake/TestSuite/Stub/ConsoleOutputStub.php
Properties summary
-
$_lastWrittenprotectedintegerThe number of bytes written by last call to write -
$_outprotectedarrayBuffered 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
overwrite() 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
Methods inherited from ConsoleOutput
__construct() 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.
_replaceTags() protected ¶
_replaceTags( array $matches )
Replace tags with color codes.
Parameters
- array $matches
- An array of matches to replace.
Returns
_write() protected ¶
_write( string $message )
Writes a message to the output stream.
Parameters
- string $message
- Message to write.
Returns
success
outputAs() 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
Either null or the value if getting.
styleText() public ¶
styleText( string $text )
Apply styling to text.
Parameters
- string $text
- Text with styling tags.
Returns
String with color codes added.
styles() 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
If you are getting styles, the style or null will be returned. If you are creating/modifying styles true will be returned.