Symfony\Component\Console\Style\SymfonyStyle

class SymfonyStyle extends OutputStyle

Constants

MAX_LINE_LENGTH

Methods

	__construct(InputInterface $input, 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.	from OutputStyle
int	getVerbosity() Gets the current verbosity of the output.	from OutputStyle
	setDecorated(bool $decorated) Sets the decorated flag.	from OutputStyle
bool	isDecorated() Gets the decorated flag.	from OutputStyle
	setFormatter(OutputFormatterInterface $formatter) Sets output formatter.	from OutputStyle
OutputFormatterInterface	getFormatter() Returns current output formatter instance.	from OutputStyle
	block(string|array $messages, string|null $type = null, string|null $style = null, string $prefix = ' ', bool $padding = false) Formats a message as a block of text.
	title(string $message) Formats a command title.
	section(string $message) Formats a section title.
	listing(array $elements) Formats a list.
	text(string|array $message) Formats informational text.
	comment($message) {@inheritdoc}
	success(string|array $message) Formats a success result bar.
	error(string|array $message) Formats an error result bar.
	warning(string|array $message) Formats an warning result bar.
	note(string|array $message) Formats a note admonition.
	caution(string|array $message) Formats a caution admonition.
	table(array $headers, array $rows) Formats a table.
string	ask(string $question, string|null $default = null, callable|null $validator = null) Asks a question.
string	askHidden(string $question, callable|null $validator = null) Asks a question with the user input hidden.
bool	confirm(string $question, bool $default = true) Asks for confirmation.
string	choice(string $question, array $choices, string|int|null $default = null) Asks a choice question.
	progressStart(int $max) Starts the progress output.
	progressAdvance(int $step = 1) Advances the progress output X steps.
	progressFinish() Finishes the progress output.
string	askQuestion(Question $question)

Details

public __construct(InputInterface $input, OutputInterface $output)

public newLine(int $count = 1)

Add newline(s).

public ProgressBar createProgressBar(int $max)

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

Writes a message to the output.

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

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

public setVerbosity(int $level)

Sets the verbosity of the output.

public int getVerbosity()

Gets the current verbosity of the output.

public setDecorated(bool $decorated)

Sets the decorated flag.

public bool isDecorated()

Gets the decorated flag.

public setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

public OutputFormatterInterface getFormatter()

Returns current output formatter instance.

public block(string|array $messages, string|null $type = null, string|null $style = null, string $prefix = ' ', bool $padding = false)

Formats a message as a block of text.

public title(string $message)

Formats a command title.

public section(string $message)

Formats a section title.

public listing(array $elements)

Formats a list.

public text(string|array $message)

Formats informational text.

public comment($message)

{@inheritdoc}

public success(string|array $message)

Formats a success result bar.

public error(string|array $message)

Formats an error result bar.

public warning(string|array $message)

Formats an warning result bar.

public note(string|array $message)

Formats a note admonition.

public caution(string|array $message)

Formats a caution admonition.

public table(array $headers, array $rows)

Formats a table.

public string ask(string $question, string|null $default = null, callable|null $validator = null)

Asks a question.

public string askHidden(string $question, callable|null $validator = null)

Asks a question with the user input hidden.

public bool confirm(string $question, bool $default = true)

Asks for confirmation.

public string choice(string $question, array $choices, string|int|null $default = null)

Asks a choice question.

public progressStart(int $max)

Starts the progress output.

public progressAdvance(int $step = 1)

Advances the progress output X steps.

public progressFinish()

Finishes the progress output.

public string askQuestion(Question $question)