Class ConsoleInputOption

__constructsource public

__construct( string|array $name , string $short '' , string $help '' , boolean $boolean false , string $default '' , array $choices [] )

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.

Throws

Cake\Console\Exception\ConsoleException
\Cake\Console\Exception\ConsoleException

defaultValuesource public

defaultValue( )

Get the default value for this option

Returns

mixed
mixed

helpsource 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
string

isBooleansource public

isBoolean( )

Check if this option is a boolean option

Returns

boolean
bool

namesource public

name( )

Get the value of the name attribute.

Returns

string
Value of this->_name.

shortsource public

short( )

Get the value of the short attribute.

Returns

string
Value of this->_short.

usagesource public

usage( )

Get the usage value for this option

Returns

string
string

validChoicesource public

validChoice( string $value )

Check that a value is a valid choice for this option.

Parameters

string $value

The choice to validate.

Returns

boolean
bool

Throws

Cake\Console\Exception\ConsoleException
\Cake\Console\Exception\ConsoleException

xmlsource public

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.