Docs4dev
Docs
cakephp / 4.4 / class-cake.console.consoleinputsubcommand.html

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()

Property Summary

  • $_help protected
    string

    Help string for the subcommand

  • $_name protected
    string

    Name of the subcommand

  • $_parser protected
    Cake\Console\ConsoleOptionParser|null

    The ConsoleOptionParser for this subcommand.

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(array<string, mixed>|string $name, string $help = '', Cake\Console\ConsoleOptionParser|array<string, mixed>|null $parser = null)

Make a new Subcommand

Parameters

array<string, mixed>|string $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<string, mixed>|null $parser optional

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

getRawHelp() public

getRawHelp(): string

Get the raw help string for this command

Returns

string

help() public

help(int $width = 0): string

Generate the help for this this subcommand.

Parameters

int $width optional

The width to make the name of the subcommand.

Returns

string

name() public

name(): string

Get the value of the name attribute.

Returns

string

parser() public

parser(): Cake\Console\ConsoleOptionParser|null

Get the usage value for this option

Returns

Cake\Console\ConsoleOptionParser|null

xml() public

xml(SimpleXMLElement $parent): SimpleXMLElement

Append this subcommand to the Parent element

Parameters

SimpleXMLElement $parent

The parent element.

Returns

SimpleXMLElement

Property Detail

$_help protected

Help string for the subcommand

Type

string

$_name protected

Name of the subcommand

Type

string

$_parser protected

The ConsoleOptionParser for this subcommand.

Type

Cake\Console\ConsoleOptionParser|null

© 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/4.4/class-Cake.Console.ConsoleInputSubcommand.html