Класс ConsoleInputSubcommand

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

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

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

$_help protected

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

string
Имя подкоманды
$_parser protected

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

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

__construct() public
Создание новой подкоманды
help() public
Генерация справки для этой подкоманды.
name() public
Получение значения атрибута имени.
parser() public
Получение значения использования для этого параметра
xml() public
Добавление этой подкоманды к элементу родителя

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

__construct()source public

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

Создание новой подкоманды

Параметры

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

help()source public

help( integer $width 0 )

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

Параметры

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

Возвращает

string

name()source public

name( )

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

Возвращает

string
Значение this->_name.

parser()source public

parser( )

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

Возвращает

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

xml()source public

xml( SimpleXmlElement $parent )

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

Параметры

SimpleXmlElement $parent: Родительский элемент.

Возвращает

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

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

$_helpsource

protected string

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

$_namesource

protected string

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

$_parsersource

protected ConsoleOptionParser

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

© 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/2.10/class-ConsoleInputSubcommand.html