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