Class ConsoleInputArgument
An object to represent a single argument used in the command line. ConsoleOptionParser creates these when you use addArgument()
Namespace: Cake\Console
See: \Cake\Console\ConsoleOptionParser::addArgument()
Location: Console/ConsoleInputArgument.php
See: \Cake\Console\ConsoleOptionParser::addArgument()
Location: Console/ConsoleInputArgument.php
Properties summary
-
$_choicesprotectedstring[]An array of valid choices for this argument. -
$_helpprotectedstringHelp string -
$_nameprotectedstringName of the argument. -
$_requiredprotectedbooleanIs this option required?
Method Summary
-
__construct() public
Make a new Input 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( string|array $name , string $help = '' , boolean $required = false , string[] $choices = [] )
Make a new Input Argument
Parameters
- string|array $name
- The long name of the option, or an array with all the properties.
- string $help optional ''
- The help text for this option
- boolean $required optional false
- Whether this argument is required. Missing required args will trigger exceptions
- string[] $choices optional []
- Valid choices for this option.
help() public ¶
help( integer $width = 0 )
Generate the help for this argument.
Parameters
- integer $width optional 0
- The width to make the name of the option.
Returns
string
isEqualTo() public ¶
isEqualTo( Cake\Console\ConsoleInputArgument $argument )
Checks if this argument is equal to another argument.
Parameters
-
Cake\Console\ConsoleInputArgument$argument - ConsoleInputArgument to compare to.
Returns
boolean
validChoice() public ¶
validChoice( string $value )
Check that $value is a valid choice for this argument.
Parameters
- string $value
- The choice to validate.
Returns
true