| Methods |
public
|
__construct(
CliHelpTarget::* $target = CliHelpTarget::PLAIN,
?int $width = null,
?ConsoleFormatterInterface $formatter = null,
)
|
#
|
public
|
getFormatter(): ConsoleFormatterInterface
Get output formatter
|
#
|
public
|
getWidth(): ?int
Get output width in columns after subtracting any margin widths
Get output width in columns after subtracting any margin widths
Implements
|
#
|
public
|
getBold(): string
Get string to insert before and after bold text
Get string to insert before and after bold text
Implements
|
#
|
public
|
getItalic(): string
Get string to insert before and after italic text
Get string to insert before and after italic text
Implements
|
#
|
public
|
getEscape(): string
Get escape character
|
#
|
public
|
getSynopsisPrefix(): string
Get string to insert before synopsis
Get string to insert before synopsis
Implements
|
#
|
public
|
getSynopsisNewline(): string
Get string to insert between wrapped synopsis lines
Get string to insert between wrapped synopsis lines
Implements
|
#
|
public
|
getSynopsisSoftNewline(): string
Get string to insert between long synopsis lines after wrapping, or an
empty string to disable synopsis soft-wrapping
Get string to insert between long synopsis lines after wrapping, or an
empty string to disable synopsis soft-wrapping
Implements
|
#
|
public
|
getCollapseSynopsis(): bool
Check whether to collapse non-mandatory options to "[options]" when a
wrapped synopsis breaks over multiple lines
Check whether to collapse non-mandatory options to "[options]" when a
wrapped synopsis breaks over multiple lines
Implements
|
#
|
public
|
getOptionIndent(): string
Get string to insert before each option line
Get string to insert before each option line
Implements
|
#
|
public
|
getOptionPrefix(): string
Get string to insert before each option
Get string to insert before each option
Implements
|
#
|
public
|
getOptionDescriptionPrefix(): string
Get string to insert before each option description
Get string to insert before each option description
Implements
|
#
|
public
|
getVisibility(): int
Get option visibility flag to require
Get option visibility flag to require
Implements
|
#
|
public
|
withCollapseSynopsis(bool $value = true)
Get an instance where non-mandatory options are collapsed to "[options]"
when a wrapped synopsis breaks over multiple…
Get an instance where non-mandatory options are collapsed to "[options]"
when a wrapped synopsis breaks over multiple lines
Implements
|
#
|
public
|
prepareHelp(string $text, string $indent = ''): string
Reflow and optionally indent help message text
Reflow and optionally indent help message text
Implements
|
#
|
public
|
buildHelp(array<CliHelpSectionName::*|string, string> $sections): string
Combine help message sections into one help message
Combine help message sections into one help message
Implements
|
#
|
public
|
maybeEscapeTags(string $string): string
Escape special characters in a string
Escape special characters in a string
Implements
|
#
|
public
static
|
getConsoleWidth(): ?int
|
#
|