Method | Description | |
---|---|---|
__construct ( Webmozart\Console\Api\IO\OutputStream $stream, Webmozart\Console\Api\Formatter\Formatter $formatter = null ) | Creates an output for the given output stream. | |
close ( ) | Closes the output. | |
flush ( ) | Forces all pending text to be written out. | |
format ( $string, |
||
getFormatter ( ) : Webmozart\Console\Api\Formatter\Formatter | Returns the output formatter. | |
getStream ( ) : Webmozart\Console\Api\IO\OutputStream | Returns the underlying stream. | |
getVerbosity ( ) : integer | Returns the current verbosity level. | |
isClosed ( ) : boolean | Returns whether the output is closed. | |
isDebug ( ) : boolean | Returns whether the verbosity level is {@link IO::DEBUG}. | |
isQuiet ( ) : boolean | Returns whether output is suppressed completely. | |
isVerbose ( ) : boolean | Returns whether the verbosity level is {@link IO::VERBOSE} or greater. | |
isVeryVerbose ( ) : boolean | Returns whether the verbosity level is {@link IO::VERY_VERBOSE} or greater. | |
removeFormat ( $string ) | ||
setFormatter ( Webmozart\Console\Api\Formatter\Formatter $formatter ) | Sets the output formatter. | |
setQuiet ( boolean $quiet ) | Sets whether output should be suppressed completely. | |
setStream ( Webmozart\Console\Api\IO\OutputStream $stream ) | Sets the underlying stream. | |
setVerbosity ( integer $verbosity ) | Sets the verbosity level of the output. | |
write ( string $string, integer $flags = null ) | Writes a string to the output stream. | |
writeLine ( string $string, integer $flags = null ) | Writes a line of text to the output stream. | |
writeLineRaw ( string $string, integer $flags = null ) | Writes a line of text to the output stream without formatting. | |
writeRaw ( string $string, integer $flags = null ) | Writes a string to the output stream without formatting. |
Method | Description | |
---|---|---|
mayWrite ( integer $flags ) : boolean | Returns whether an output may be written for the given flags. |
public __construct ( Webmozart\Console\Api\IO\OutputStream $stream, Webmozart\Console\Api\Formatter\Formatter $formatter = null ) | ||
$stream | Webmozart\Console\Api\IO\OutputStream | The output stream. |
$formatter | Webmozart\Console\Api\Formatter\Formatter | The formatter for formatting text written to the output stream. |
public format ( $string, |
||
$style |
public getFormatter ( ) : Webmozart\Console\Api\Formatter\Formatter | ||
return | Webmozart\Console\Api\Formatter\Formatter | The output formatter. |
public getStream ( ) : Webmozart\Console\Api\IO\OutputStream | ||
return | Webmozart\Console\Api\IO\OutputStream | The output stream. |
public getVerbosity ( ) : integer | ||
return | integer | One of the verbosity constants. |
public isVeryVerbose ( ) : boolean | ||
return | boolean | Returns `true` if the verbosity level is {@link IO::VERY_VERBOSE} or greater and `false` otherwise. |
public setFormatter ( Webmozart\Console\Api\Formatter\Formatter $formatter ) | ||
$formatter | Webmozart\Console\Api\Formatter\Formatter | The output formatter. |
public setStream ( Webmozart\Console\Api\IO\OutputStream $stream ) | ||
$stream | Webmozart\Console\Api\IO\OutputStream | The output stream. |
public setVerbosity ( integer $verbosity ) | ||
$verbosity | integer | One of the constants {@link NORMAL}, {@link VERBOSE}, {@link VERY_VERBOSE} or {@link DEBUG}. Only output with the given verbosity level or smaller will be written out. |
public writeLine ( string $string, integer $flags = null ) | ||
$string | string | The string to write. A newline is appended. |
$flags | integer | The flags. If one of of {@link IO::VERBOSE}, {@link IO::VERY_VERBOSE} and {@link IO::DEBUG} is passed, the output is only written if the verbosity level is the given level or higher. |
public writeLineRaw ( string $string, integer $flags = null ) | ||
$string | string | The string to write. A newline is appended. |
$flags | integer | The flags. If one of of {@link IO::VERBOSE}, {@link IO::VERY_VERBOSE} and {@link IO::DEBUG} is passed, the output is only written if the verbosity level is the given level or higher. |