| Methods |
public
|
__construct(InputInterface $input, OutputInterface $output)
|
#
|
public
|
block(
string|array $messages,
?string $type = null,
?string $style = null,
string $prefix = ' ',
bool $padding = false,
bool $escape = true,
): void
Formats a message as a block of text.
Formats a message as a block of text.
|
#
|
public
|
title(string $message): void
Formats a command title.
|
#
|
public
|
section(string $message): void
Formats a section title.
|
#
|
public
|
listing(array $elements): void
Formats a list.
|
#
|
public
|
text(string|array $message): void
Formats informational text.
Formats informational text.
Implements
|
#
|
public
|
comment(string|array $message): void
Formats a command comment.
Formats a command comment.
|
#
|
public
|
success(string|array $message): void
Formats a success result bar.
Formats a success result bar.
Implements
|
#
|
public
|
error(string|array $message): void
Formats an error result bar.
Formats an error result bar.
Implements
|
#
|
public
|
warning(string|array $message): void
Formats an warning result bar.
Formats an warning result bar.
Implements
|
#
|
public
|
note(string|array $message): void
Formats a note admonition.
Formats a note admonition.
Implements
|
#
|
public
|
info(string|array $message): void
Formats an info message.
|
#
|
public
|
caution(string|array $message): void
Formats a caution admonition.
Formats a caution admonition.
Implements
|
#
|
public
|
table(array $headers, array $rows): void
Formats a table.
|
#
|
public
|
horizontalTable(array $headers, array $rows): void
Formats a horizontal table.
Formats a horizontal table.
|
#
|
public
|
definitionList(string|array|TableSeparator ...$list): void
Formats a list of key/value horizontally.
Formats a list of key/value horizontally.
Each row can be one of:
- 'A title'
- ['key' => 'value']
- new TableSeparator()
|
#
|
public
|
ask(string $question, ?string $default = null, ?callable $validator = null): mixed
Asks a question.
|
#
|
public
|
askHidden(string $question, ?callable $validator = null): mixed
Asks a question with the user input hidden.
Asks a question with the user input hidden.
Implements
|
#
|
public
|
confirm(string $question, bool $default = true): bool
Asks for confirmation.
|
#
|
public
|
choice(string $question, array $choices, mixed $default = null, bool $multiSelect = false): mixed
Asks a choice question.
|
#
|
public
|
progressStart(int $max = 0): void
Starts the progress output.
Starts the progress output.
Implements
|
#
|
public
|
progressAdvance(int $step = 1): void
Advances the progress output X steps.
Advances the progress output X steps.
Implements
|
#
|
public
|
progressFinish(): void
Finishes the progress output.
Finishes the progress output.
Implements
|
#
|
public
|
createProgressBar(int $max = 0): ProgressBar
|
#
|
public
|
progressIterate<TKey, TValue>(iterable<TKey, TValue> $iterable, int|null $max = null): iterable<TKey, TValue>
Parameters
| $max |
Number of steps to complete the bar (0 if indeterminate), if null it will be inferred from $iterable
|
|
#
|
public
|
askQuestion(Question $question): mixed
|
#
|
public
|
writeln(string|iterable $messages, int $type = self::OUTPUT_NORMAL): void
Writes a message to the output and adds a newline at the end.
Writes a message to the output and adds a newline at the end.
Parameters
| $type |
A bitmask of options (one of the OUTPUT or VERBOSITY constants),
0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
|
Overrides
Overriden by
|
#
|
public
|
write(string|iterable $messages, bool $newline = false, int $type = self::OUTPUT_NORMAL): void
Writes a message to the output.
Writes a message to the output.
Parameters
| $newline |
Whether to add a newline
|
| $type |
A bitmask of options (one of the OUTPUT or VERBOSITY constants),
0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
|
Overrides
Overriden by
|
#
|
public
|
newLine(int $count = 1): void
Add newline(s).
|
#
|
public
|
getErrorStyle(): self
Returns a new instance which makes use of stderr if available.
Returns a new instance which makes use of stderr if available.
|
#
|
public
|
createTable(): Table
|
#
|