InputArgument
in package
Represents a command line argument.
Tags
Table of Contents
Constants
Properties
- $default : string|int|bool|array<string|int, mixed>|null|float
- $description : string
- $mode : int
- $name : string
- $suggestedValues : array<string|int, mixed>|Closure
Methods
- __construct() : mixed
- complete() : void
- Adds suggestions to $suggestions for the current completion input.
- getDefault() : string|bool|int|float|array<string|int, mixed>|null
- Returns the default value.
- getDescription() : string
- Returns the description text.
- getName() : string
- Returns the argument name.
- hasCompletion() : bool
- isArray() : bool
- Returns true if the argument can take multiple values.
- isRequired() : bool
- Returns true if the argument is required.
- setDefault() : void
- Sets the default value.
Constants
IS_ARRAY
public
mixed
IS_ARRAY
= 4
OPTIONAL
public
mixed
OPTIONAL
= 2
REQUIRED
public
mixed
REQUIRED
= 1
Properties
$default
private
string|int|bool|array<string|int, mixed>|null|float
$default
$description
private
string
$description
$mode
private
int
$mode
$name
private
string
$name
$suggestedValues
private
array<string|int, mixed>|Closure
$suggestedValues
Methods
__construct()
public
__construct(string $name[, int|null $mode = null ][, string $description = '' ][, string|bool|int|float|array<string|int, mixed>|null $default = null ][, array<string|int, mixed>|callable(CompletionInput, CompletionSuggestions): array<int, string|Suggestion> $suggestedValues = [] ]) : mixed
Parameters
- $name : string
-
The argument name
- $mode : int|null = null
-
The argument mode: a bit mask of self::REQUIRED, self::OPTIONAL and self::IS_ARRAY
- $description : string = ''
-
A description text
- $default : string|bool|int|float|array<string|int, mixed>|null = null
-
The default value (for self::OPTIONAL mode only)
- $suggestedValues : array<string|int, mixed>|callable(CompletionInput, CompletionSuggestions): array<int, string|Suggestion> = []
-
The values used for input completion
Tags
complete()
Adds suggestions to $suggestions for the current completion input.
public
complete(CompletionInput $input, CompletionSuggestions $suggestions) : void
Parameters
- $input : CompletionInput
- $suggestions : CompletionSuggestions
Tags
getDefault()
Returns the default value.
public
getDefault() : string|bool|int|float|array<string|int, mixed>|null
Return values
string|bool|int|float|array<string|int, mixed>|nullgetDescription()
Returns the description text.
public
getDescription() : string
Return values
stringgetName()
Returns the argument name.
public
getName() : string
Return values
stringhasCompletion()
public
hasCompletion() : bool
Return values
boolisArray()
Returns true if the argument can take multiple values.
public
isArray() : bool
Return values
bool —true if mode is self::IS_ARRAY, false otherwise
isRequired()
Returns true if the argument is required.
public
isRequired() : bool
Return values
bool —true if parameter mode is self::REQUIRED, false otherwise
setDefault()
Sets the default value.
public
setDefault([string|bool|int|float|array<string|int, mixed>|null $default = null ]) : void
Parameters
- $default : string|bool|int|float|array<string|int, mixed>|null = null