Symfony\Component\Console\Style\SymfonyStyle

class SymfonyStyle extends OutputStyle

Output decorator helpers for the Symfony Style Guide.

Constants

MAX_LINE_LENGTH

Methods

__construct(InputInterface $input, 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.

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)

No description

from OutputStyle

OutputFormatterInterface

getFormatter()

Returns current output formatter instance.

from OutputStyle

bool

isQuiet()

Returns whether verbosity is quiet (-q).

from OutputStyle

bool

isVerbose()

Returns whether verbosity is verbose (-v).

from OutputStyle

bool

isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

from OutputStyle

bool

isDebug()

Returns whether verbosity is debug (-vvv).

from OutputStyle

getErrorOutput()

No description

from OutputStyle

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

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(string|array $message)

Formats a command comment.

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.

mixed

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

Asks a question.

mixed

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.

mixed

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

Asks a choice question.

progressStart(int $max = 0)

Starts the progress output.

progressAdvance(int $step = 1)

Advances the progress output X steps.

progressFinish()

Finishes the progress output.

mixed

askQuestion(Question $question)

No description

SymfonyStyle

getErrorStyle()

Returns a new instance which makes use of stderr if available.

Details

`__construct(InputInterface $input, OutputInterface $output)`

Parameters

InputInterface	$input
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

bool	true if verbosity is set to VERBOSITY_DEBUG, false otherwise

`protected getErrorOutput()`

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

Formats a message as a block of text.

Parameters

string\|array	$messages	The message to write in the block
string\|null	$type	The block type (added in [] on first line)
string\|null	$style	The style to apply to the whole block
string	$prefix	The prefix for the block
bool	$padding	Whether to add vertical padding
bool	$escape	Whether to escape the message

`table(array $headers, array $rows)`

Formats a table.

Parameters

array	$headers
array	$rows

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

Asks a question.

Parameters

string	$question
string\|null	$default
callable\|null	$validator

Return Value

mixed

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

Asks a question with the user input hidden.

Parameters

string	$question
callable\|null	$validator

Return Value

mixed

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

Asks for confirmation.

Parameters

string	$question
bool	$default

Return Value

bool

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

Asks a choice question.

Parameters

string	$question
array	$choices
string\|int\|null	$default

Return Value

mixed

`progressStart(int $max = 0)`

Starts the progress output.

Parameters

int

$max

Maximum steps (0 if unknown)

`progressAdvance(int $step = 1)`

Advances the progress output X steps.

Parameters

int

$step

Number of steps to advance

`progressFinish()`

Finishes the progress output.

`mixed askQuestion(Question $question)`

Parameters

Question

$question

Return Value

mixed

`SymfonyStyle getErrorStyle()`

Returns a new instance which makes use of stderr if available.

Return Value

SymfonyStyle