Spec-Zone.ru › CakePHP 3.1

Класс ConsoleInputSubcommand

Объект для представления отдельной подкоманды, используемой в командной строке. Создается при вызове ConsoleOptionParser::addSubcommand()

Пространство имён: Cake\Console
См.: 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
Ширина для отображения имени подкоманды.

Возвращает

string
string

namesource public

name( )

Получить значение атрибута имени.

Возвращает

string
Значение этого->_name.

parsersource public

parser( )

Получить значение использования для этого параметра

Возвращает

mixed
Либо false, либо ConsoleOptionParser

xmlsource public

xml( SimpleXmlElement $parent )

Добавить эту подкоманду к элементу Родитель

Параметры

SimpleXmlElement $parent
Элемент родителя.

Возвращает

SimpleXmlElement
Родительский элемент с добавленной подкомандой.

Сводка свойств

$_helpsource

protected string

Строка справки для подкоманды

$_namesource

protected string

Имя подкоманды

$_parsersource

protected Cake\Console\ConsoleOptionParser

ConsoleOptionParser для этой подкоманды.

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API