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