An object to represent a single argument used in the command line.
ConsoleOptionParser creates these when you use addArgument()
string[]
An array of valid choices for this argument.
string
Help string
string
Name of the argument.
bool
Is this option required?
__construct(mixed $name, mixed $help, mixed $required, mixed $choices)
Make a new Input Argument
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
bool
$required optional Whether this argument is required. Missing required args will trigger exceptions
string[]
$choices optional Valid choices for this option.
help(int $width)
Generate the help for this argument.
int
$width optional The width to make the name of the option.
string
isEqualTo(\Cake\Console\ConsoleInputArgument $argument)
Checks if this argument is equal to another argument.
\Cake\Console\ConsoleInputArgument
$argument ConsoleInputArgument to compare to.
bool
isRequired()
Check if this argument is a required argument
bool
name()
Get the value of the name attribute.
string
Value of this->_name.
usage()
Get the usage value for this argument
string
validChoice(string $value)
Check that $value is a valid choice for this argument.
string
$value The choice to validate.
true
Cake\Console\Exception\ConsoleException
xml(\SimpleXMLElement $parent)
Append this arguments XML representation to the passed in SimpleXml object.
\SimpleXMLElement
$parent The parent element.
\SimpleXMLElement
The parent with this argument appended.
An array of valid choices for this argument.
string[]
Help string
string
Name of the argument.
string
Is this option required?
bool
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Console.ConsoleInputArgument.html