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

createProgressBar(int $max = 0)

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)

No description

getFormatter()

Returns current output formatter instance.

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(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

Details

at line 43
__construct(InputInterface $input, OutputInterface $output)

Parameters

InputInterface $input
OutputInterface $output

at line 327
newLine(int $count = 1)

Add newline(s).

Parameters

int $count The number of newlines

at line 270
ProgressBar createProgressBar(int $max = 0)

Parameters

int $max

Return Value

ProgressBar

at line 318
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 strings or a single string
bool $newline Whether to add a newline
$type

at line 309
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 strings or a single string
$type

in OutputStyle at line 69
setVerbosity(int $level)

Sets the verbosity of the output.

Parameters

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

in OutputStyle at line 77
int getVerbosity()

Gets the current verbosity of the output.

Return Value

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

in OutputStyle at line 85
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

in OutputStyle at line 93
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

in OutputStyle at line 101
setFormatter(OutputFormatterInterface $formatter)

Parameters

OutputFormatterInterface $formatter

in OutputStyle at line 109
OutputFormatterInterface getFormatter()

Returns current output formatter instance.

at line 62
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.

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

at line 74
title(string $message)

Formats a command title.

Parameters

string $message

at line 87
section(string $message)

Formats a section title.

Parameters

string $message

at line 100
listing(array $elements)

Formats a list.

Parameters

array $elements

at line 114
text(string|array $message)

Formats informational text.

Parameters

string|array $message

at line 129
comment(string|array $message)

Formats a command comment.

Parameters

string|array $message

at line 141
success(string|array $message)

Formats a success result bar.

Parameters

string|array $message

at line 149
error(string|array $message)

Formats an error result bar.

Parameters

string|array $message

at line 157
warning(string|array $message)

Formats an warning result bar.

Parameters

string|array $message

at line 165
note(string|array $message)

Formats a note admonition.

Parameters

string|array $message

at line 173
caution(string|array $message)

Formats a caution admonition.

Parameters

string|array $message

at line 181
table(array $headers, array $rows)

Formats a table.

Parameters

array $headers
array $rows

at line 198
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

at line 209
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

at line 222
bool confirm(string $question, bool $default = true)

Asks for confirmation.

Parameters

string $question
bool $default

Return Value

bool

at line 230
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

at line 243
progressStart(int $max = 0)

Starts the progress output.

Parameters

int $max Maximum steps (0 if unknown)

at line 252
progressAdvance(int $step = 1)

Advances the progress output X steps.

Parameters

int $step Number of steps to advance

at line 260
progressFinish()

Finishes the progress output.

at line 286
mixed askQuestion(Question $question)

Parameters

Question $question

Return Value

mixed