Класс ConsoleInputArgument

__construct()source public

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

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

Параметры

string|array $name

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

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

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

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

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

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

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

help()source public

help( integer $width = 0 )

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

Параметры

integer $width необязательно 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
Родительский элемент с добавленным аргументом.