1. class
  2. Symfony
  3. Component
  4. Console
  5. Style
  6. SymfonyStyle

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)

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.

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)

No description

Details

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

Parameters

InputInterface $input
OutputInterface $output

at line line 361
newLine(int $count = 1)

Add newline(s).

Parameters

int $count The number of newlines

at line line 302
ProgressBar createProgressBar(int $max)

Parameters

int $max

Return Value

ProgressBar

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

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

in OutputStyle at line line 72
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 line 80
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 line 88
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages

in OutputStyle at line line 96
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

in OutputStyle at line line 104
setFormatter(OutputFormatterInterface $formatter)

Sets output formatter.

Parameters

OutputFormatterInterface $formatter

in OutputStyle at line line 112
OutputFormatterInterface getFormatter()

Returns current output formatter instance.

Return Value

OutputFormatterInterface

at line line 66
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 line 108
title(string $message)

Formats a command title.

Parameters

string $message

at line line 121
section(string $message)

Formats a section title.

Parameters

string $message

at line line 134
listing(array $elements)

Formats a list.

Parameters

array $elements

at line line 148
text(string|array $message)

Formats informational text.

Parameters

string|array $message

at line line 161
comment($message)

{@inheritdoc}

Parameters

$message

at line line 174
success(string|array $message)

Formats a success result bar.

Parameters

string|array $message

at line line 182
error(string|array $message)

Formats an error result bar.

Parameters

string|array $message

at line line 190
warning(string|array $message)

Formats an warning result bar.

Parameters

string|array $message

at line line 198
note(string|array $message)

Formats a note admonition.

Parameters

string|array $message

at line line 206
caution(string|array $message)

Formats a caution admonition.

Parameters

string|array $message

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

Formats a table.

Parameters

array $headers
array $rows

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

string

at line line 241
string askHidden(string $question, callable|null $validator = null)

Asks a question with the user input hidden.

Parameters

string $question
callable|null $validator

Return Value

string

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

Asks for confirmation.

Parameters

string $question
bool $default

Return Value

bool

at line line 262
string 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

string

at line line 275
progressStart(int $max)

Starts the progress output.

Parameters

int $max Maximum steps (0 if unknown)

at line line 284
progressAdvance(int $step = 1)

Advances the progress output X steps.

Parameters

int $step Number of steps to advance

at line line 292
progressFinish()

Finishes the progress output.

at line line 320
string askQuestion(Question $question)

Parameters

Question $question

Return Value

string