Класс ConsoleInputOption
Объект для представления одного параметра, используемого в командной строке. ConsoleOptionParser создаёт их при использовании addOption()
Краткое описание свойств
- $_boolean protected
boolЯвляется ли параметр булевым. Булевы параметры не потребляют параметр.
- $_choices protected
array<string>Массив вариантов для параметра.
- $_default protected
string|bool|nullЗначение по умолчанию для параметра
- $_help protected
stringТекст справки для параметра.
- $_multiple protected
boolМожет ли параметр принимать несколько значений.
- $_name protected
stringИмя параметра
- $_short protected
stringКороткое (1 символ) псевдоним параметра.
- $required protected
boolЯвляется ли параметр обязательным.
Краткое описание методов
__construct()public
Создать новый параметр ввода
acceptsMultiple()public
Проверить, принимает ли этот параметр несколько значений.
defaultValue()public
Получить значение по умолчанию для этого параметра
help()public
Сгенерировать справку для этого параметра.
isBoolean()public
Проверить, является ли этот параметр логическим.
isRequired()public
Проверить, является ли этот параметр обязательным.
name()public
Получить значение атрибута name.
short()public
Получить значение атрибута short.
usage()public
Получить значение использования для этого параметра
validChoice()public
Проверить, является ли значение допустимым выбором для этого параметра.
xml()public
Добавить XML-представление параметра в родительский элемент.
Подробное описание методов
__construct() public
__construct(string $name, string $short = '', string $help = '', bool $isBoolean = false, string|bool|null $default = null, array<string> $choices = [], bool $multiple = false, bool $required = false)
Создать новый параметр ввода
Параметры
string$nameПолное имя параметра или массив со всеми свойствами.
string$short необязательноКороткое сокращение для этого параметра
string$help необязательноТекст справки для этого параметра
bool$isBoolean необязательноЯвляется ли этот параметр логическим. Логические параметры не потребляют дополнительные токены
string|bool|null$default необязательноЗначение по умолчанию для этого параметра.
array<string>$choices необязательноДопустимые варианты для этого параметра.
bool$multiple необязательноМожно ли задавать для этого параметра несколько значений.
bool$required необязательноЯвляется ли параметр обязательным.
Исключения
Cake\Console\Exception\ConsoleExceptionacceptsMultiple() public
acceptsMultiple(): bool
Проверить, принимает ли этот параметр несколько значений.
Возвращает
booldefaultValue() public
defaultValue(): string|bool|null
Получить значение по умолчанию для этого параметра
Возвращает
string|bool|nullhelp() public
help(int $width = 0): string
Сгенерировать справку для этого параметра.
Параметры
int$width необязательноШирина, для отображения имени параметра.
Возвращает
stringisBoolean() public
isBoolean(): bool
Проверить, является ли этот параметр логическим
Возвращает
boolisRequired() public
isRequired(): bool
Проверить, является ли этот параметр обязательным
Возвращает
boolname() public
name(): string
Получить значение атрибута name.
Возвращает
stringshort() public
short(): string
Получить значение атрибута short.
Возвращает
stringusage() public
usage(): string
Получить значение использования для этого параметра
Возвращает
stringvalidChoice() public
validChoice(string|bool $value): true
Проверить, является ли значение допустимым выбором для этого параметра.
Параметры
string|bool$valueВариант для проверки.
Возвращает
trueИсключения
Cake\Console\Exception\ConsoleExceptionxml() public
xml(SimpleXMLElement $parent): SimpleXMLElement
Добавить XML-представление параметра в родительский элемент.
Параметры
SimpleXMLElement$parentРодительский элемент.
Возвращает
SimpleXMLElementПодробное описание свойств
$_boolean protected
Является ли параметр логическим. Логические параметры не потребляют параметр.
Тип
bool$_choices protected
Массив вариантов для параметра.
Тип
array<string>$_default protected
Значение по умолчанию для параметра
Тип
string|bool|null$_help protected
Текст справки для параметра.
Тип
string$_multiple protected
Может ли параметр принимать несколько значений.
Тип
bool$_name protected
Имя параметра
Тип
string$_short protected
Короткое (1 символ) сокращение для параметра.
Тип
string$required protected
Является ли параметр обязательным.
Тип
bool
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.3/class-Cake.Console.ConsoleInputOption.html
