InputOption

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

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

Параметры

string	$name	Имя параметра
string|array	$shortcut	Сокращения, может быть null, строка сокращений, разделенных |, или массив сокращений
int	$mode	Режим параметра: Одна из констант VALUE_*
string	$description	Текст описания
mixed	$default	Значение по умолчанию (должно быть null для self::VALUE_NONE)

Исключения

InvalidArgumentException

Если режим параметра некорректен или несовместим

string getShortcut()

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

Значение возврата

string

Сокращение

string getName()

Возвращает имя параметра.

Значение возврата

string

Имя

bool acceptValue()

Возвращает true, если параметр принимает значение.

Значение возврата

bool	true, если режим значения не self::VALUE_NONE, в противном случае false

bool isValueRequired()

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

Значение возврата

bool	true, если режим значения self::VALUE_REQUIRED, в противном случае false

bool isValueOptional()

Возвращает true, если параметр принимает необязательное значение.

Значение возврата

bool	true, если режим значения self::VALUE_OPTIONAL, в противном случае false

bool isArray()

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

Значение возврата

bool	true, если режим self::VALUE_IS_ARRAY, в противном случае false

setDefault(mixed $default = null)

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

Параметры

mixed

$default

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

Исключения

LogicException

При неправильном задании значения по умолчанию

mixed getDefault()

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

Значение возврата

mixed

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

string getDescription()

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

Значение возврата

string

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

bool equals(InputOption $option)

Проверяет, равен ли заданный параметр этому.

Параметры

InputOption

$option

Сравниваемый параметр

Значение возврата

bool