Класс ConsoleInputOption

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

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

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

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

__construct( string|array $name , string $short null , string $help '' , boolean $boolean false , string $default '' , array $choices array() )

Создать новый параметр ввода

Параметры

string|array $name: Полное имя параметра или массив со всеми свойствами.
string $short необязательно null: Короткое имя параметра
string $help необязательно '': Текст справки для данного параметра
boolean $boolean необязательно false: Является ли этот параметр булевым. Булевы параметры не потребляют дополнительные токены
string $default необязательно '': Значение по умолчанию для этого параметра.
array $choices необязательно array(): Допустимые значения для этого параметра.

Исключения

ConsoleException
ConsoleException

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

defaultValue( )

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

Возвращает

mixed
mixed

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

help( integer $width 0 )

Сгенерировать справку для этого параметра.

Параметры

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

Возвращает

string
string

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

isBoolean( )

Проверить, является ли данный параметр булевым

Возвращает

boolean
bool

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

name( )

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

Возвращает

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

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

short( )

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

Возвращает

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

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

usage( )

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

Возвращает

string
string

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

validChoice( string $value )

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

Параметры

string $value: Значение для проверки.

Возвращает

boolean
bool

Исключения

ConsoleException
ConsoleException

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

xml( SimpleXmlElement $parent )

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

Параметры

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

Возвращает

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

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

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

protected boolean

Является ли параметр булевым. Булевы параметры не потребляют параметр.

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

protected array

Массив допустимых значений для параметра.

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

protected mixed

Значение по умолчанию для параметра

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

protected string

Текст справки для параметра.

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

protected string

Имя параметра

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

protected string

Короткое (1 символ) имя параметра.

© 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-ConsoleInputOption.html