Class ConsoleInputArgument

__constructsource public

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

Make a new Input Argument

Parameters

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

boolean $required optional false

Whether this argument is required. Missing required args will trigger exceptions

array $choices optional []

Valid choices for this option.

helpsource public

help( integer $width 0 )

Generate the help for this argument.

Parameters

integer $width optional 0

The width to make the name of the option.

Returns

string
string

isEqualTosource public

isEqualTo( Cake\Console\ConsoleInputArgument $argument )

Checks if this argument is equal to another argument.

Parameters

Cake\Console\ConsoleInputArgument $argument

ConsoleInputArgument to compare to.

Returns

boolean
bool

isRequiredsource public

isRequired( )

Check if this argument is a required argument

Returns

boolean
bool

namesource public

name( )

Get the value of the name attribute.

Returns

string
Value of this->_name.

usagesource public

usage( )

Get the usage value for this argument

Returns

string
string

validChoicesource public

validChoice( string $value )

Check that $value is a valid choice for this argument.

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 this arguments XML representation to the passed in SimpleXml object.

Parameters

SimpleXmlElement $parent

The parent element.

Returns

SimpleXmlElement
The parent with this argument appended.