ConsoleOutput (class)
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
Inherited Constants
Properties summary
-
$_out
protectedBuffered messages.array
Inherited Properties
Method Summary
- messages() publicGet the buffered output.
- write() publicWrite output to the buffer.
Method Detail
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
Cake\Console\ConsoleOutput::write()
Methods inherited from Cake\Console\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.
_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
integer|booleanThe number of bytes returned from writing to output.
outputAs()source public
outputAs( integer|null $type null )
Get/Set the output type to use. The output type how formatting tags are treated.
Parameters
- integer|null
$type
optional null - The output type to use. Should be one of the class constants.
Returns
integer|nullEither null or the value if getting.
styleText()source public
styleText( string $text )
Apply styling to text.
Parameters
- string
$text
- Text with styling tags.
Returns
stringString with color codes added.
styles()source public
styles( string|null $style null , array|boolean|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|boolean|null
$definition
optional null The array definition of the style to change or create a style or false to remove a style.
Returns
mixedIf you are getting styles, the style or null will be returned. If you are creating/modifying styles true will be returned.
Properties detail
© 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/3.4/class-Cake.TestSuite.Stub.ConsoleOutput.html