Класс ConsoleInputArgument

__construct()source public

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

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

Параметры

string|array $name

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

string $help optional ''

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

boolean $required optional false

Является ли этот аргумент обязательным. Отсутствие обязательных аргументов вызовет исключение

array $choices optional []

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

help()source public

help( integer $width 0 )

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

Параметры

integer $width optional 0

Ширина имени параметра.

Возвращает

string

isEqualTo()source public

isEqualTo( Cake\Console\ConsoleInputArgument $argument )

Проверка, равен ли этот аргумент другому аргументу.

Параметры

Cake\Console\ConsoleInputArgument $argument

ConsoleInputArgument для сравнения.

Возвращает

boolean

isRequired()source public

isRequired( )

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

Возвращает

boolean

name()source public

name( )

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

Возвращает

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

usage()source public

usage( )

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

Возвращает

string

validChoice()source public

validChoice( string $value )

Проверка, является ли $value допустимым выбором для этого аргумента.

Параметры

string $value

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

Возвращает

boolean

Исключения

Cake\Console\Exception\ConsoleException

xml()source public

xml( SimpleXmlElement $parent )

Добавление XML-представления этого аргумента к переданному объекту SimpleXml.

Параметры

SimpleXmlElement $parent

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

Возвращает

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