W3cubDocs

Symfony\Component\Console\Style\OutputStyle

abstract class OutputStyle implements OutputInterface, StyleInterface

Decorates output to add console style guide helpers.

Methods

	__construct(OutputInterface $output)
	newLine(int $count = 1) Add newline(s).
ProgressBar	createProgressBar(int $max)
	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.

Details

public __construct(OutputInterface $output)

Parameters

OutputInterface

$output

public newLine(int $count = 1)

Add newline(s).

Parameters

int

$count

The number of newlines

public ProgressBar createProgressBar(int $max)

Parameters

int

$max

Return Value

ProgressBar

public 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

public 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

public setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

int

$level

The level of verbosity (one of the VERBOSITY constants)

public int getVerbosity()

Gets the current verbosity of the output.

Return Value

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

public setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool

$decorated

Whether to decorate the messages

public bool isDecorated()

Gets the decorated flag.

Return Value

bool	true if the output will decorate messages, false otherwise

public setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

Parameters

OutputFormatterInterface

$formatter

public OutputFormatterInterface getFormatter()

Returns current output formatter instance.

Return Value

OutputFormatterInterface

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Console/Style/OutputStyle.html