Spec-Zone.ru › Symfony 4.1

InputArgument

class InputArgument

Представляет аргумент командной строки.

Постоянные значения

REQUIRED
OPTIONAL
IS_ARRAY

Методы

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

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

bool isRequired()

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

bool isArray()

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

setDefault(string|string[]|null $default = null)

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

string|string[]|null getDefault()

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

string getDescription()

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

Подробности

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

Параметры

string $name Имя аргумента
int $mode Режим аргумента: self::REQUIRED или self::OPTIONAL
string $description Текст описания
string|string[]|null $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(string|string[]|null $default = null)

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

Параметры

string|string[]|null $default Значение по умолчанию

Исключения

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

string|string[]|null getDefault()

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

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

string|string[]|null Значение по умолчанию

string getDescription()

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

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

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

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Console/Input/InputArgument.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API