| Methods |
public
|
__construct(
string $name,
int-mask-of<InputArgument::*>|null $mode = null,
string $description = '',
string|bool|int|float|array|null $default = null,
array|(Closure(CompletionInput, CompletionSuggestions): list<string|Suggestion>) $suggestedValues = [],
)
Parameters
| $name |
The argument name
|
| $mode |
The argument mode: a bit mask of self::REQUIRED, self::OPTIONAL and self::IS_ARRAY
|
| $description |
A description text
|
| $default |
The default value (for self::OPTIONAL mode only)
|
| $suggestedValues |
The values used for input completion
|
Throws
|
#
|
public
|
getName(): string
Returns the argument name.
Returns the argument name.
|
#
|
public
|
isRequired(): bool
Returns true if the argument is required.
Returns true if the argument is required.
Returns
true if parameter mode is self::REQUIRED, false otherwise
|
#
|
public
|
isArray(): bool
Returns true if the argument can take multiple values.
Returns true if the argument can take multiple values.
Returns
true if mode is self::IS_ARRAY, false otherwise
|
#
|
public
|
setDefault(string|bool|int|float|array|null $default): void
Sets the default value.
|
#
|
public
|
getDefault(): string|bool|int|float|array|null
Returns the default value.
Returns the default value.
|
#
|
public
|
hasCompletion(): bool
Returns true if the argument has values for input completion.
Returns true if the argument has values for input completion.
|
#
|
public
|
complete(CompletionInput $input, CompletionSuggestions $suggestions): void
Supplies suggestions when command resolves possible completion options for input.
Supplies suggestions when command resolves possible completion options for input.
|
#
|
public
|
getDescription(): string
Returns the description text.
Returns the description text.
|
#
|