Класс ConsoleInputSubcommand

__construct()source public

__construct( string|array $name , string $help = '' , Cake\Console\ConsoleOptionParser|array|null $parser = null )

Создание новой подкоманды

Параметры

string|array $name

Полное имя подкоманды или массив со всеми свойствами.

string $help необязательно ''

Текст справки для этого параметра.

Cake\Console\ConsoleOptionParser|array|null $parser необязательно null

Парсер для этой подкоманды. Либо ConsoleOptionParser, либо массив, который можно использовать с ConsoleOptionParser::buildFromArray().

getRawHelp()source public

getRawHelp( )

Получить исходную строку справки для этой команды

Возвращает

string

help()source public

help( integer $width = 0 )

Сгенерировать справку для этой подкоманды.

Параметры

integer $width необязательно 0

Ширина для имени подкоманды.

Возвращает

string

name()source public

name( )

Получить значение атрибута имени.

Возвращает

string
Значение этого->_name.

parser()source public

parser( )

Получить значение использования для этого параметра

Возвращает

Cake\Console\ConsoleOptionParser|boolean
Либо false, либо ConsoleOptionParser

xml()source public

xml( SimpleXMLElement $parent )

Добавить эту подкоманду к родительскому элементу

Параметры

SimpleXMLElement $parent

Родительский элемент.

Возвращает

SimpleXMLElement
Родительский элемент с добавленной подкомандой.

''

''