InputOption

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

Параметры

string	$name	Имя параметра
string|array	$shortcut	Сокращения, может быть null, строка со сокращениями через | или массив сокращений
int	$mode	Режим параметра: Одна из констант VALUE_*
string	$description	Текст описания
string|string[]|int|bool|null	$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(string|string[]|int|bool|null $default = null)

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

Параметры

string|string[]|int|bool|null

$default

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

Исключения

LogicException

Когда задано неверное значение по умолчанию

string|string[]|int|bool|null getDefault()

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

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

string|string[]|int|bool|null

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

string getDescription()

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

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

string

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

bool equals(InputOption $option)

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

Параметры

InputOption

$option

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

bool