Class ConsoleInputOption
An object to represent a single option used in the command line. ConsoleOptionParser creates these when you use addOption()
Method Detail
__constructsource public
__construct( string|array $name , string $short null , string $help '' , boolean $boolean false , string $default '' , array $choices array() )
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 null - 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 array() - Valid choices for this option.
Throws
ConsoleExceptionConsoleException
defaultValuesource public
defaultValue( )
Get the default value for this option
Returns
mixedmixed
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
stringstring
isBooleansource public
isBoolean( )
Check if this option is a boolean option
Returns
booleanbool
name( )
Get the value of the name attribute.
Returns
stringValue of this->_name.
short( )
Get the value of the short attribute.
Returns
stringValue of this->_short.
usage( )
Get the usage value for this option
Returns
stringstring
validChoicesource public
validChoice( string $value )
Check that a value is a valid choice for this option.
Parameters
- string
$value - The choice to validate.
Returns
booleanbool
Throws
ConsoleExceptionConsoleException
xml( SimpleXmlElement $parent )
Append the option's xml into the parent.
Parameters
- SimpleXmlElement
$parent - The parent element.
Returns
SimpleXmlElementThe parent with this option appended.
Properties summary
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 string
Name of the option
protected string
Short (1 character) alias for the option.