Класс ConsoleInputArgument

__construct()source public

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

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

Параметры

строка|массив $name

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

строка $help необязательно ''

Текст справки для этой опции

логическое значение $required необязательно false

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

массив $choices необязательно []

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

help()source public

help( integer $width 0 )

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

Параметры

целое число $width необязательно 0

Ширина, используемая для имени опции.

Возвращает

строку

isEqualTo()source public

isEqualTo( Cake\Console\ConsoleInputArgument $argument )

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

Параметры

Cake\Console\ConsoleInputArgument $argument

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

Возвращает

логическое значение

isRequired()source public

isRequired( )

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

Возвращает

логическое значение

name()source public

name( )

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

Возвращает

строка
Значение this->_name.

usage()source public

usage( )

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

Возвращает

строка

validChoice()source public

validChoice( string $value )

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

Параметры

строка $value

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

Возвращает

логическое значение

Исключения

Cake\Console\Exception\ConsoleException

xml()source public

xml( SimpleXmlElement $parent )

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

Параметры

SimpleXmlElement $parent

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

Возвращает

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