InputArgument

__construct(string $name, int $mode = null, string $description = '', mixed $default = null)

Конструктор.

Параметры

string	$name	Имя аргумента
int	$mode	Режим аргумента: self::REQUIRED или self::OPTIONAL
string	$description	Текст описания
mixed	$default	Значение по умолчанию (только для режима self::OPTIONAL)

Исключения

InvalidArgumentException

Когда режим аргумента недействителен

string getName()

Возвращает имя аргумента.

Возвращаемое значение

string

Имя аргумента

bool isRequired()

Возвращает true, если аргумент обязателен.

Возвращаемое значение

bool	true, если режим параметра self::REQUIRED, иначе false

bool isArray()

Возвращает true, если аргумент может принимать несколько значений.

Возвращаемое значение

bool	true, если режим self::IS_ARRAY, иначе false

setDefault(mixed $default = null)

Устанавливает значение по умолчанию.

Параметры

mixed

$default

Значение по умолчанию

Исключения

LogicException

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

mixed getDefault()

Возвращает значение по умолчанию.

Возвращаемое значение

mixed

Значение по умолчанию

string getDescription()

Возвращает текст описания.

Возвращаемое значение

string

Текст описания