Класс 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
$helpoptional '' - Текст справки для этого параметра.
-
Cake\Console\ConsoleOptionParser|array|null$parseroptional null Парсер для этой подкоманды. Либо ConsoleOptionParser, либо массив, который можно использовать с ConsoleOptionParser::buildFromArray().
help()source public
help( integer $width 0 )
Генерация справки по этой подкоманде.
Параметры
- integer
$widthoptional 0 - Ширина имени подкоманды.
Возвращаемое значение
stringname()source public
name( )
Получение значения атрибута имени.
Возвращаемое значение
stringЗначение this->_name.
parser()source public
parser( )
Получение значения использования для этого параметра
Возвращаемое значение
mixedЛибо false, либо ConsoleOptionParser
xml()source 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.2/class-Cake.Console.ConsoleInputSubcommand.html