Класс ConsoleInputSubcommand

Объект для представления одной подкоманды, используемой в командной строке. Создается при вызове ConsoleOptionParser::addSubcommand()

Пространство имен: Cake\Console
См.: \Cake\Console\ConsoleOptionParser::addSubcommand()
Расположение: Console/ConsoleInputSubcommand.php

Краткое описание свойств

$_help protected

string
Строка справки для подкоманды
$_name protected

string
Имя подкоманды
$_parser protected

Cake\Console\ConsoleOptionParser
ConsoleOptionParser для этой подкоманды.

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

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

string

help( integer $width = 0 )

Генерация справки для этой подкоманды.

string

name( )

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

string
Значение this->_name.

parser( )

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

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

xml( SimpleXMLElement $parent )

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

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

protected string

Строка справки для подкоманды

''

protected string

Имя подкоманды

''

ConsoleOptionParser для этой подкоманды.

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