Class ConsoleInputOption
An object to represent a single option used in the command line. ConsoleOptionParser creates these when you use addOption()
Namespace: Cake\Console
See: \Cake\Console\ConsoleOptionParser::addOption()
Location: Console/ConsoleInputOption.php
See: \Cake\Console\ConsoleOptionParser::addOption()
Location: Console/ConsoleInputOption.php
Properties summary
-
$_booleanprotectedbooleanIs the option a boolean option. Boolean options do not consume a parameter. -
$_choicesprotectedarrayAn array of choices for the option. -
$_defaultprotectedmixedDefault value for the option -
$_helpprotectedstringHelp text for the option. -
$_multipleprotectedbooleanCan the option accept multiple value definition. -
$_nameprotectedstringName of the option -
$_shortprotectedstringShort (1 character) alias for the option.
Method Summary
-
__construct() public
Make a new Input Option -
acceptsMultiple() public
Check if this option accepts multiple values. -
defaultValue() public
Get the default value for this option -
help() public
Generate the help for this this option. -
isBoolean() public
Check if this option is a boolean option -
name() public
Get the value of the name attribute. -
short() public
Get the value of the short attribute. -
usage() public
Get the usage value for this option -
validChoice() public
Check that a value is a valid choice for this option. -
xml() public
Append the option's xml into the parent.
Method Detail
__construct() 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
acceptsMultiple() public ¶
acceptsMultiple( )
Check if this option accepts multiple values.
Returns
boolean
help() 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
short() public ¶
short( )
Get the value of the short attribute.
Returns
string
Value of this->_short.
Value of this->_short.
validChoice() public ¶
validChoice( string $value )
Check that a value is a valid choice for this option.
Parameters
- string $value
- The choice to validate.
Returns
boolean