Class ConsoleInputSubcommand
An object to represent a single subcommand used in the command line. Created when you call ConsoleOptionParser::addSubcommand()
See: \Cake\Console\ConsoleOptionParser::addSubcommand()
Location: Console/ConsoleInputSubcommand.php
Properties summary
-
$_help
protectedstring
-
$_name
protectedstring
-
$_parser
protected
Method Summary
-
__construct() publicMake a new Subcommand
-
getRawHelp() publicGet the raw help string for this command
-
help() publicGenerate the help for this this subcommand.
-
name() publicGet the value of the name attribute.
-
parser() publicGet the usage value for this option
-
xml() publicAppend this subcommand to the Parent element
Method Detail
__construct()source 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()source 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
stringname()source public
name( )
Get the value of the name attribute.
Returns
stringValue of this->_name.
parser()source public
parser( )
Get the usage value for this option
Returns
Cake\Console\ConsoleOptionParser
|boolean
Either false or a ConsoleOptionParser
xml()source public
xml( SimpleXMLElement $parent )
Append this subcommand to the Parent element
Parameters
-
SimpleXMLElement
$parent
- The parent element.
Returns
SimpleXMLElementThe parent with this subcommand appended.
Properties detail
$_parsersource
protected Cake\Console\ConsoleOptionParser
The ConsoleOptionParser for this subcommand.
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.8/class-Cake.Console.ConsoleInputSubcommand.html