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);
- Cake\Console\ConsoleOutput
-
Cake\TestSuite\Stub\ConsoleOutput
Properties summary
-
$_outprotectedarrayBuffered messages.
Inherited Properties
Method Summary
-
messages() public
Get the buffered output. -
write() public
Write output to the buffer.
Method Detail
Methods inherited from Cake\Console\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
The number of bytes returned from writing to output.
getOutputAs() public ¶
getOutputAs( )
Get the output type on how formatting tags are treated.
Returns
outputAs() public deprecated ¶
outputAs( integer|null $type = null )
Get/Set the output type to use. The output type how formatting tags are treated.
Deprecated
Parameters
- integer|null $type optional null
- The output type to use. Should be one of the class constants.
Returns
Either null or the value if getting.
setOutputAs() 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
in case of a not supported output type.
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|null $style = null , array|false|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|false|null $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.