StyleInterface

interface StyleInterface

Output style helpers.

Methods

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.

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.

newLine(int $count = 1)

Add newline(s).

progressStart(int $max)

Starts the progress output.

progressAdvance(int $step = 1)

Advances the progress output X steps.

progressFinish()

Finishes the progress output.

Details

title(string $message)

Formats a command title.

Parameters

string $message

section(string $message)

Formats a section title.

Parameters

string $message

listing(array $elements)

Formats a list.

Parameters

array $elements

text(string|array $message)

Formats informational text.

Parameters

string|array $message

success(string|array $message)

Formats a success result bar.

Parameters

string|array $message

error(string|array $message)

Formats an error result bar.

Parameters

string|array $message

warning(string|array $message)

Formats an warning result bar.

Parameters

string|array $message

note(string|array $message)

Formats a note admonition.

Parameters

string|array $message

caution(string|array $message)

Formats a caution admonition.

Parameters

string|array $message

table(array $headers, array $rows)

Formats a table.

Parameters

array $headers
array $rows

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

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

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

Asks for confirmation.

Parameters

string $question
bool $default

Return Value

bool

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

newLine(int $count = 1)

Add newline(s).

Parameters

int $count The number of newlines

progressStart(int $max)

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.

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Console/Style/StyleInterface.html