Класс ConsoleInputOption

__construct()source public

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

Создание нового параметра ввода

Параметры

string|array $name

Полное имя параметра или массив со всеми свойствами.

string $short optional ''

Короткое обозначение для данного параметра

string $help optional ''

Текст справки для данного параметра

boolean $boolean optional false

Булевый ли этот параметр. Булевы параметры не потребляют дополнительные токены

string $default optional ''

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

array $choices optional []

Допустимые значения для этого параметра.

boolean $multiple optional false

Может ли данный параметр принимать несколько значений.

Исключения

Cake\Console\Exception\ConsoleException

acceptsMultiple()source public

acceptsMultiple( )

Проверка, принимает ли данный параметр несколько значений.

Возвращает

boolean

defaultValue()source public

defaultValue( )

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

Возвращает

mixed

help()source public

help( integer $width 0 )

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

Параметры

integer $width optional 0

Ширина для отображения имени параметра.

Возвращает

string

isBoolean()source public

isBoolean( )

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

Возвращает

boolean

name()source public

name( )

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

Возвращает

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

short()source public

short( )

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

Возвращает

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

usage()source public

usage( )

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

Возвращает

string

validChoice()source public

validChoice( string $value )

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

Параметры

string $value

Значение выбора для проверки.

Возвращает

boolean

Выбрасывает

Cake\Console\Exception\ConsoleException

xml()source public

xml( SimpleXmlElement $parent )

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

Параметры

SimpleXmlElement $parent

Родительский элемент.

Возвращает

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