Spec-Zone.ru › CakePHP 3.2

Класс ConsoleInputSubcommand

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

Пространство имён: Cake\Console
См.: \Cake\Console\ConsoleOptionParser::addSubcommand()
Расположение: Console/ConsoleInputSubcommand.php

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

  • $_help protected
    string
    Строка справки для подкоманды
  • $_name protected
    string
    Имя подкоманды
  • $_parser protected
    Cake\Console\ConsoleOptionParser
    ConsoleOptionParser для этой подкоманды.

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

  • __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 optional ''
Текст справки для этого параметра.
Cake\Console\ConsoleOptionParser|array|null $parser optional null

Парсер для этой подкоманды. Либо ConsoleOptionParser, либо массив, который можно использовать с ConsoleOptionParser::buildFromArray().

help()source public

help( integer $width 0 )

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

Параметры

integer $width optional 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 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.2/class-Cake.Console.ConsoleInputSubcommand.html

Spec-Zone.ru

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