Class ConsoleInputOption
An object to represent a single option used in the command line. ConsoleOptionParser creates these when you use addOption()
Properties summary
-
boolean
Is the option a boolean option. Boolean options do not consume a parameter. -
array
An array of choices for the option. -
mixed
Default value for the option -
string
Help text for the option. -
boolean
Can the option accept multiple value definition. -
string
Name of the option -
string
Short (1 character) alias for the option.
Method Summary
- Make a new Input Option
- Check if this option accepts multiple values.
- Get the default value for this option
- Generate the help for this this option.
- Check if this option is a boolean option
- Get the value of the name attribute.
- Get the value of the short attribute.
- Get the usage value for this option
- Check that a value is a valid choice for this option.
- Append the option's xml into the parent.
Method Detail
__construct()source public
__construct( string|array $name , string $short '' , string $help '' , boolean $boolean false , string $default '' , array $choices [] , boolean $multiple false )
Make a new Input Option
Parameters
- string|array
$name
- The long name of the option, or an array with all the properties.
- string
$short
optional '' - The short alias for this option
- string
$help
optional '' - The help text for this option
- boolean
$boolean
optional false - Whether this option is a boolean option. Boolean options don't consume extra tokens
- string
$default
optional '' - The default value for this option.
- array
$choices
optional [] - Valid choices for this option.
- boolean
$multiple
optional false - Whether this option can accept multiple value definition.
Throws
Cake\Console\Exception\ConsoleException
acceptsMultiple()source public
acceptsMultiple( )
Check if this option accepts multiple values.
Returns
boolean
defaultValue()source public
defaultValue( )
Get the default value for this option
Returns
mixed
help()source public
help( integer $width 0 )
Generate the help for this this option.
Parameters
- integer
$width
optional 0 - The width to make the name of the option.
Returns
string
isBoolean()source public
isBoolean( )
Check if this option is a boolean option
Returns
boolean
name()source public
name( )
Get the value of the name attribute.
Returns
string
Value of this->_name.
short()source public
short( )
Get the value of the short attribute.
Returns
string
Value of this->_short.
usage()source public
usage( )
Get the usage value for this option
Returns
string
xml( SimpleXmlElement $parent )
Append the option's xml into the parent.
Parameters
- SimpleXmlElement
$parent
- The parent element.
Returns
SimpleXmlElement
The parent with this option appended.
Properties detail
protected boolean
Is the option a boolean option. Boolean options do not consume a parameter.
protected array
An array of choices for the option.
protected mixed
Default value for the option
protected string
Help text for the option.
protected boolean
Can the option accept multiple value definition.
protected string
Name of the option
protected string
Short (1 character) alias for the option.