Class ConsoleInputArgument
An object to represent a single argument used in the command line. ConsoleOptionParser creates these when you use addArgument()
Property Summary
-
$_choices protected
list<string>An array of valid choices for this argument.
-
$_default protected
string|nullDefault value for this argument.
-
$_help protected
stringHelp string
-
$_name protected
stringName of the argument.
-
$_required protected
boolIs this option required?
Method Summary
-
__construct() public
Make a new Input Argument
-
defaultValue() public
Get the default value for this argument
-
help() public
Generate the help for this argument.
-
isEqualTo() public
Checks if this argument is equal to another argument.
-
isRequired() public
Check if this argument is a required argument
-
name() public
Get the value of the name attribute.
-
usage() public
Get the usage value for this argument
-
validChoice() public
Check that $value is a valid choice for this argument.
-
xml() public
Append this arguments XML representation to the passed in SimpleXml object.
Method Detail
__construct() ¶ public
__construct(array<string, mixed>|string $name, string $help = '', bool $required = false, list<string> $choices = [], string|null $default = null)Make a new Input Argument
Parameters
-
array<string, mixed>|string$name The long name of the option, or an array with all the properties.
-
string$help optional The help text for this option
-
bool$required optional Whether this argument is required. Missing required args will trigger exceptions
-
list<string>$choices optional Valid choices for this option.
-
string|null$default optional The default value for this argument.
defaultValue() ¶ public
defaultValue(): string|nullGet the default value for this argument
Returns
string|nullhelp() ¶ public
help(int $width = 0): stringGenerate the help for this argument.
Parameters
-
int$width optional The width to make the name of the option.
Returns
stringisEqualTo() ¶ public
isEqualTo(Cake\Console\ConsoleInputArgument $argument): boolChecks if this argument is equal to another argument.
Parameters
-
Cake\Console\ConsoleInputArgument$argument ConsoleInputArgument to compare to.
Returns
boolvalidChoice() ¶ public
validChoice(string $value): trueCheck that $value is a valid choice for this argument.
Parameters
-
string$value The choice to validate.
Returns
trueThrows
Cake\Console\Exception\ConsoleExceptionxml() ¶ public
xml(SimpleXMLElement $parent): SimpleXMLElementAppend this arguments XML representation to the passed in SimpleXml object.
Parameters
-
SimpleXMLElement$parent The parent element.
Returns
SimpleXMLElement