1. class
  2. Symfony
  3. Component
  4. Console
  5. Style
  6. OutputStyle

OutputStyle

class OutputStyle implements OutputInterface, StyleInterface

Decorates output to add console style guide helpers.

Methods

__construct(OutputInterface $output)

No description

newLine(int $count = 1)

Add newline(s).

ProgressBar
createProgressBar(int $max)

No description

write(string|array $messages, bool $newline = false, $type = self::OUTPUT_NORMAL)

Writes a message to the output.

writeln(string|array $messages, $type = self::OUTPUT_NORMAL)

Writes a message to the output and adds a newline at the end.

setVerbosity(int $level)

Sets the verbosity of the output.

int
getVerbosity()

Gets the current verbosity of the output.

setDecorated(bool $decorated)

Sets the decorated flag.

bool
isDecorated()

Gets the decorated flag.

setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

OutputFormatterInterface
getFormatter()

Returns current output formatter instance.

bool
isQuiet()

Returns whether verbosity is quiet (-q).

bool
isVerbose()

Returns whether verbosity is verbose (-v).

bool
isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

bool
isDebug()

Returns whether verbosity is debug (-vvv).

Details

at line line 30
__construct(OutputInterface $output)

Parameters

OutputInterface $output

at line line 38
newLine(int $count = 1)

Add newline(s).

Parameters

int $count The number of newlines

at line line 48
ProgressBar createProgressBar(int $max)

Parameters

int $max

Return Value

ProgressBar

at line line 56
write(string|array $messages, bool $newline = false, $type = self::OUTPUT_NORMAL)

Writes a message to the output.

Parameters

string|array $messages The message as an array of lines or a single string
bool $newline Whether to add a newline
$type

at line line 64
writeln(string|array $messages, $type = self::OUTPUT_NORMAL)

Writes a message to the output and adds a newline at the end.

Parameters

string|array $messages The message as an array of lines of a single string
$type

at line line 72
setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

int $level The level of verbosity (one of the VERBOSITY constants)

at line line 80
int getVerbosity()

Gets the current verbosity of the output.

Return Value

int The current level of verbosity (one of the VERBOSITY constants)

at line line 88
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

at line line 96
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

at line line 104
setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

Parameters

OutputFormatterInterface $formatter

at line line 112
OutputFormatterInterface getFormatter()

Returns current output formatter instance.

Return Value

OutputFormatterInterface

at line line 120
bool isQuiet()

Returns whether verbosity is quiet (-q).

Return Value

bool true if verbosity is set to VERBOSITY_QUIET, false otherwise

at line line 128
bool isVerbose()

Returns whether verbosity is verbose (-v).

Return Value

bool true if verbosity is set to VERBOSITY_VERBOSE, false otherwise

at line line 136
bool isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

Return Value

bool true if verbosity is set to VERBOSITYVERYVERBOSE, false otherwise

at line line 144
bool isDebug()

Returns whether verbosity is debug (-vvv).

Return Value

bool true if verbosity is set to VERBOSITY_DEBUG, false otherwise