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);
write( string|array $message , integer $newlines 1 )
Write output to the buffer.
$message
$newlines
optional 1 Cake\Console\ConsoleOutput::write()
__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.
$stream
optional 'php://stdout' _replaceTags( array $matches )
Replace tags with color codes.
$matches
string
_write( string $message )
Writes a message to the output stream.
$message
boolean
outputAs( integer|null $type null )
Get/Set the output type to use. The output type how formatting tags are treated.
$type
optional null integer|null
styleText( string $text )
Apply styling to text.
$text
string
styles( string|null $style null , array|boolean|null $definition null )
Get the current styles offered, or append new ones in.
$output->styles('error');
$output->styles();
$output->styles('annoy', ['text' => 'purple', 'background' => 'yellow', 'blink' => true]);
$this->output->styles('annoy', false);
$style
optional null $definition
optional null mixed
COLOR, LF, PLAIN, RAW |
protected static array
background colors used in colored output.
[ 'black' => 40, 'red' => 41, 'green' => 42, 'yellow' => 43, 'blue' => 44, 'magenta' => 45, 'cyan' => 46, 'white' => 47 ]
protected static array
text colors used in colored output.
[ 'black' => 30, 'red' => 91, 'green' => 32, 'yellow' => 33, 'blue' => 34, 'magenta' => 35, 'cyan' => 36, 'white' => 37 ]
protected static string
formatting options for colored output
[ 'bold' => 1, 'underline' => 4, 'blink' => 5, 'reverse' => 7, ]
protected integer
The current output type. Manipulated with ConsoleOutput::outputAs();
protected static array
Styles that are available as tags in console output. You can modify these styles with ConsoleOutput::styles()
[ 'emergency' => ['text' => 'red'], 'alert' => ['text' => 'red'], 'critical' => ['text' => 'red'], 'error' => ['text' => 'red'], 'warning' => ['text' => 'yellow'], 'info' => ['text' => 'cyan'], 'debug' => ['text' => 'yellow'], 'success' => ['text' => 'green'], 'comment' => ['text' => 'blue'], 'question' => ['text' => 'magenta'], 'notice' => ['text' => 'cyan'] ]
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.TestSuite.Stub.ConsoleOutput.html