Класс ConsoleInputSubcommand
Объект для представления отдельной подкоманды, используемой в командной строке. Создается при вызове ConsoleOptionParser::addSubcommand()
Краткое описание свойств
Краткое описание методов
-
__construct() общедоступный
Создать новую подкоманду
-
getRawHelp() общедоступный
Получить исходную строку справки для этой команды
-
help() общедоступный
Сгенерировать справку для этой подкоманды.
-
name() общедоступный
Получить значение атрибута имени.
-
parser() общедоступный
Получить значение использования для этого параметра
-
xml() общедоступный
Добавить эту подкоманду к элементу Родитель
Подробное описание методов
__construct() общедоступный
__construct(array<string, mixed>|string $name, string $help = '', Cake\Console\ConsoleOptionParser|array<string, mixed>|null $parser = null)
Создать новую подкоманду
Параметры
-
array<string, mixed>|string$name Полное имя подкоманды или массив со всеми свойствами.
-
string$help необязательный Текст справки для этого параметра.
-
Cake\Console\ConsoleOptionParser|array<string, mixed>|null$parser необязательный Парсер для этой подкоманды. Либо ConsoleOptionParser, либо массив, который можно использовать с ConsoleOptionParser::buildFromArray().
getRawHelp() общедоступный
getRawHelp(): string
Получить исходную строку справки для этой команды
Возвращает
stringhelp() общедоступный
help(int $width = 0): string
Сгенерировать справку для этой подкоманды.
Параметры
-
int$width необязательный Ширина для отображения имени подкоманды.
Возвращает
stringname() общедоступный
name(): string
Получить значение атрибута имени.
Возвращает
stringparser() общедоступный
parser(): Cake\Console\ConsoleOptionParser|null
Получить значение использования для этого параметра
Возвращает
Cake\Console\ConsoleOptionParser|nullxml() общедоступный
xml(SimpleXMLElement $parent): SimpleXMLElement
Добавить эту подкоманду к элементу Родитель
Параметры
-
SimpleXMLElement$parent Родительский элемент.
Возвращает
SimpleXMLElementПодробное описание свойств
$_help защищённое
Строка помощи для подкоманды
Тип
string$_name защищённое
Имя подкоманды
Тип
string$_parser защищённое
The ConsoleOptionParser для этой подкоманды.
Тип
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.3/class-Cake.Console.ConsoleInputSubcommand.html
