1. class
  2. Symfony
  3. \
  4. Component
  5. \
  6. Console
  7. \
  8. Style
  9. \
  10. OutputStyle

OutputStyle

abstract 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 = 0)

No description

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

Writes a message to the output.

writeln(string|iterable $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)

No description

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).

getErrorOutput()

No description

Details

__construct(OutputInterface $output)

Parameters

OutputInterface $output

newLine(int $count = 1)

Add newline(s).

Parameters

int $count The number of newlines

ProgressBar createProgressBar(int $max = 0)

Parameters

int $max

Return Value

ProgressBar

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

Writes a message to the output.

Parameters

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

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

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

Parameters

string|iterable $messages The message as an iterable of strings or a single string
$type

setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

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

int getVerbosity()

Gets the current verbosity of the output.

Return Value

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

setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

setFormatter(OutputFormatterInterface $formatter)

Parameters

OutputFormatterInterface $formatter

OutputFormatterInterface getFormatter()

Returns current output formatter instance.

Return Value

OutputFormatterInterface

bool isQuiet()

Returns whether verbosity is quiet (-q).

Return Value

bool true if verbosity is set to VERBOSITY_QUIET, false otherwise

bool isVerbose()

Returns whether verbosity is verbose (-v).

Return Value

bool true if verbosity is set to VERBOSITY_VERBOSE, false otherwise

bool isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

Return Value

bool true if verbosity is set to VERBOSITY_VERY_VERBOSE, false otherwise

bool isDebug()

Returns whether verbosity is debug (-vvv).

Return Value

bool true if verbosity is set to VERBOSITY_DEBUG, false otherwise

protected getErrorOutput()