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.
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.
Please login to continue.