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