Class ConsoleInputSubcommand
An object to represent a single subcommand used in the command line. Created when you call ConsoleOptionParser::addSubcommand()
Namespace: Cake\Console
See: \Cake\Console\ConsoleOptionParser::addSubcommand()
Location: Console/ConsoleInputSubcommand.php
See: \Cake\Console\ConsoleOptionParser::addSubcommand()
Location: Console/ConsoleInputSubcommand.php
Properties summary
Method Summary
-
__construct() public
Make a new Subcommand -
getRawHelp() public
Get the raw help string for this command -
help() public
Generate the help for this this subcommand. -
name() public
Get the value of the name attribute. -
parser() public
Get the usage value for this option -
xml() public
Append this subcommand to the Parent element
Method Detail
__construct() 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().
help() 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