Класс ConsoleInputSubcommand

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

Пакет: Cake\Console
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: Лицензия MIT
См.: ConsoleOptionParser::addSubcommand()
Расположение Cake/Console/ConsoleInputSubcommand.php

Подробное описание методов

__constructисходный код public

__construct( string|array $name , string $help '' , ConsoleOptionParser|array $parser null )

Создать новую подкоманду

Параметры

string|array $name: Полное имя подкоманды или массив со всеми свойствами.
string $help необязательно '': Текст справки для данного параметра
ConsoleOptionParser|array $parser необязательно null: Парсер для этой подкоманды. Либо ConsoleOptionParser, либо массив, который можно использовать с ConsoleOptionParser::buildFromArray()

helpисходный код public

help( integer $width 0 )

Генерирует справку для этой подкоманды.

Параметры

integer $width необязательно 0: Ширина, для отображения имени подкоманды.

Возвращает

string
строка

nameисходный код public

name( )

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

Возвращает

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

parserисходный код public

parser( )

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

Возвращает

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

xmlисходный код public

xml( SimpleXmlElement $parent )

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

Параметры

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

Возвращает

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

Краткое описание свойств

$_helpисходный код

protected строка

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

$_nameисходный код

protected строка

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

$_parserисходный код

protected 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/2.7/class-ConsoleInputSubcommand.html