Класс ConsoleInputArgument

__constructsource public

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

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

Параметры

string|array $name

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

string $help необязательно ''

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

boolean $required необязательно false

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

array $choices необязательно []

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

helpsource public

help( integer $width 0 )

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

Параметры

integer $width необязательно 0

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

Возвращает

string
string

isEqualTosource public

isEqualTo( Cake\Console\ConsoleInputArgument $argument )

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

Параметры

Cake\Console\ConsoleInputArgument $argument

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

Возвращает

boolean
bool

isRequiredsource public

isRequired( )

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

Возвращает

boolean
bool

namesource public

name( )

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

Возвращает

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

usagesource public

usage( )

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

Возвращает

string
string

validChoicesource public

validChoice( string $value )

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

Параметры

string $value

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

Возвращает

boolean
bool

Исключения

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

xmlsource public

xml( SimpleXmlElement $parent )

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

Параметры

SimpleXmlElement $parent

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

Возвращает

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