Class ConsoleInputSubcommand

__constructsource public

__construct( string|array $name , string $help '' , Cake\Console\ConsoleOptionParser|array|null $parser null )

Make a new Subcommand

Parameters

string|array $name

The long name of the subcommand, or an array with all the properties.

string $help optional ''

The help text for this option.

Cake\Console\ConsoleOptionParser|array|null $parser optional null

A parser for this subcommand. Either a ConsoleOptionParser, or an array that can be used with ConsoleOptionParser::buildFromArray().

helpsource public

help( integer $width 0 )

Generate the help for this this subcommand.

Parameters

integer $width optional 0

The width to make the name of the subcommand.

Returns

string
string

namesource public

name( )

Get the value of the name attribute.

Returns

string
Value of this->_name.

parsersource public

parser( )

Get the usage value for this option

Returns

mixed
Either false or a ConsoleOptionParser

xmlsource public

xml( SimpleXmlElement $parent )

Append this subcommand to the Parent element

Parameters

SimpleXmlElement $parent

The parent element.

Returns

SimpleXmlElement
The parent with this subcommand appended.