Класс ConsoleInputSubcommand
Объект для представления одной подкоманды, используемой в командной строке. Создается при вызове ConsoleOptionParser::addSubcommand()
См.: \Cake\Console\ConsoleOptionParser::addSubcommand()
Расположение: Console/ConsoleInputSubcommand.php
Краткое описание свойств
-
$_helpprotectedСтрока справки для подкомандыstring -
$_nameprotectedИмя подкомандыstring - ConsoleOptionParser для этой подкоманды.
$_parserprotected
Краткое описание методов
- __construct() publicСоздание новой подкоманды
- getRawHelp() publicПолучение исходной строки справки для этой команды
- help() publicГенерация справки для этой подкоманды.
- name() publicПолучение значения атрибута имени.
- parser() publicПолучение значения использования для этого параметра
- xml() publicДобавление этой подкоманды к элементу родителя
Подробное описание методов
__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( )
Получение исходной строки справки для этой команды
Возвращаемое значение
stringhelp()source public
help( integer $width = 0 )
Генерация справки для этой подкоманды.
Параметры
- integer
$widthнеобязательно 0 - Ширина, для имени подкоманды.
Возвращаемое значение
stringname()source public
name( )
Получение значения атрибута имени.
Возвращаемое значение
stringЗначение этого->_name.
parser()source public
parser( )
Получение значения использования для этого параметра
Возвращаемое значение
Cake\Console\ConsoleOptionParser|booleanЛибо false, либо ConsoleOptionParser
xml()source public
xml( SimpleXMLElement $parent )
Добавление этой подкоманды к элементу родителя
Параметры
- SimpleXMLElement
$parent - Элемент родителя.
Возвращаемое значение
SimpleXMLElementРодительский элемент с добавленной подкомандой.
Подробное описание свойств
© 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.7/class-Cake.Console.ConsoleInputSubcommand.html