W3cubDocs

Class ConsoleInputSubcommand

An object to represent a single subcommand used in the command line. Created when you call ConsoleOptionParser::addSubcommand()

Package: Cake\Console
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
See: ConsoleOptionParser::addSubcommand()
Located at Cake/Console/ConsoleInputSubcommand.php

Method Detail

__constructsource public

__construct( string|array $name , string $help '' , ConsoleOptionParser|array $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
ConsoleOptionParser|array $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.

Properties summary

$_helpsource

protected string

Help string for the subcommand

$_namesource

protected string

Name of the subcommand

$_parsersource

protected ConsoleOptionParser

The ConsoleOptionParser for this subcommand.

© 2005–2016 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.
http://api.cakephp.org/2.7/class-ConsoleInputSubcommand.html