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