Class ConsoleInputSubcommand
An object to represent a single subcommand used in the command line. Created when you call ConsoleOptionParser::addSubcommand()
Property 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 A parser for this subcommand. Either a ConsoleOptionParser, or an array that can be used with ConsoleOptionParser::buildFromArray().
help() ¶ public
help(int $width = 0): stringGenerate the help for this this subcommand.
Parameters
-
int$width optional The width to make the name of the subcommand.
Returns
stringname() ¶ public
name(): stringGet the value of the name attribute.
Returns
stringValue of this->_name.
parser() ¶ public
parser(): Cake\Console\ConsoleOptionParser|boolGet the usage value for this option
Returns
Cake\Console\ConsoleOptionParser|boolEither false or a ConsoleOptionParser
xml() ¶ public
xml(SimpleXMLElement $parent): SimpleXMLElementAppend this subcommand to the Parent element
Parameters
-
SimpleXMLElement$parent The parent element.
Returns
SimpleXMLElementThe parent with this subcommand appended.