OutputStyle
in package
implements
OutputInterface, StyleInterface
AbstractYes
Decorates output to add console style guide helpers.
Tags
Table of Contents
Interfaces
- OutputInterface
- OutputInterface is the interface implemented by all Output classes.
- StyleInterface
- Output style helpers.
Properties
Methods
- __construct() : mixed
- createProgressBar() : ProgressBar
- getFormatter() : OutputFormatterInterface
- Returns current output formatter instance.
- getVerbosity() : self::VERBOSITY_*
- Gets the current verbosity of the output.
- isDebug() : bool
- Returns whether verbosity is debug (-vvv).
- isDecorated() : bool
- Gets the decorated flag.
- isQuiet() : bool
- Returns whether verbosity is quiet (-q).
- isVerbose() : bool
- Returns whether verbosity is verbose (-v).
- isVeryVerbose() : bool
- Returns whether verbosity is very verbose (-vv).
- newLine() : void
- Add newline(s).
- setDecorated() : void
- Sets the decorated flag.
- setFormatter() : void
- setVerbosity() : void
- Sets the verbosity of the output.
- write() : void
- Writes a message to the output.
- writeln() : void
- Writes a message to the output and adds a newline at the end.
- getErrorOutput() : OutputInterface
Properties
$output
private
OutputInterface
$output
Methods
__construct()
public
__construct(OutputInterface $output) : mixed
Parameters
- $output : OutputInterface
createProgressBar()
public
createProgressBar([int $max = 0 ]) : ProgressBar
Parameters
- $max : int = 0
Return values
ProgressBargetFormatter()
Returns current output formatter instance.
public
getFormatter() : OutputFormatterInterface
Return values
OutputFormatterInterfacegetVerbosity()
Gets the current verbosity of the output.
public
getVerbosity() : self::VERBOSITY_*
Return values
self::VERBOSITY_*isDebug()
Returns whether verbosity is debug (-vvv).
public
isDebug() : bool
Return values
boolisDecorated()
Gets the decorated flag.
public
isDecorated() : bool
Return values
boolisQuiet()
Returns whether verbosity is quiet (-q).
public
isQuiet() : bool
Return values
boolisVerbose()
Returns whether verbosity is verbose (-v).
public
isVerbose() : bool
Return values
boolisVeryVerbose()
Returns whether verbosity is very verbose (-vv).
public
isVeryVerbose() : bool
Return values
boolnewLine()
Add newline(s).
public
newLine([int $count = 1 ]) : void
Parameters
- $count : int = 1
setDecorated()
Sets the decorated flag.
public
setDecorated(bool $decorated) : void
Parameters
- $decorated : bool
setFormatter()
public
setFormatter(OutputFormatterInterface $formatter) : void
Parameters
- $formatter : OutputFormatterInterface
setVerbosity()
Sets the verbosity of the output.
public
setVerbosity(int $level) : void
Parameters
- $level : int
write()
Writes a message to the output.
public
write(string|iterable<string|int, mixed> $messages[, bool $newline = false ][, int $type = self::OUTPUT_NORMAL ]) : void
Parameters
- $messages : string|iterable<string|int, mixed>
- $newline : bool = false
-
Whether to add a newline
- $type : int = self::OUTPUT_NORMAL
writeln()
Writes a message to the output and adds a newline at the end.
public
writeln(string|iterable<string|int, mixed> $messages[, int $type = self::OUTPUT_NORMAL ]) : void
Parameters
- $messages : string|iterable<string|int, mixed>
- $type : int = self::OUTPUT_NORMAL
getErrorOutput()
protected
getErrorOutput() : OutputInterface