Класс ConsoleInputSubcommand
Объект для представления отдельной подкоманды, используемой в командной строке. Создается при вызове ConsoleOptionParser::addSubcommand()
Пространство имён: Cake\Console
См.:
Расположено в Console/ConsoleInputSubcommand.php
См.:
Cake\Console\ConsoleOptionParser::addSubcommand()Расположено в Console/ConsoleInputSubcommand.php
Подробное описание методов
__constructsource 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().
helpsource public
help( integer $width 0 )
Генерирует справку для этой подкоманды.
Параметры
- integer
$widthнеобязательно 0 - Ширина для отображения имени подкоманды.
Возвращает
stringstring
parsersource public
parser( )
Получить значение использования для этого параметра
Возвращает
mixedЛибо false, либо ConsoleOptionParser
xmlsource public
xml( SimpleXmlElement $parent )
Добавить эту подкоманду к элементу Родитель
Параметры
- SimpleXmlElement
$parent - Элемент родителя.
Возвращает
SimpleXmlElementРодительский элемент с добавленной подкомандой.
Сводка свойств
© 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/3.1/class-Cake.Console.ConsoleInputSubcommand.html