Класс ConsoleInputOption

__constructsource public

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

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

Параметры

string|array $name

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

string $short optional ''

Короткое сокращение для этого параметра

string $help optional ''

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

boolean $boolean optional false

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

string $default optional ''

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

array $choices optional []

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

Исключения

Cake\Console\Exception\ConsoleException
\Cake\Console\Exception\ConsoleException

defaultValuesource public

defaultValue( )

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

Возвращает

mixed
mixed

helpsource public

help( integer $width 0 )

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

Параметры

integer $width optional 0

Ширина, чтобы сделать имя параметра.

Возвращает

string
string

isBooleansource public

isBoolean( )

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

Возвращает

boolean
bool

namesource public

name( )

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

Возвращает

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

shortsource public

short( )

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

Возвращает

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

usagesource public

usage( )

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

Возвращает

string
string

validChoicesource public

validChoice( string $value )

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

Параметры

string $value

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

Возвращает

boolean
bool

Исключения

Cake\Console\Exception\ConsoleException
\Cake\Console\Exception\ConsoleException

xmlsource public

xml( SimpleXmlElement $parent )

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

Параметры

SimpleXmlElement $parent

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

Возвращает

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