Класс ConsoleInputOption
Объект для представления одного параметра, используемого в командной строке. ConsoleOptionParser создаёт их при использовании addOption()
Краткое описание свойств
- $_boolean protected
boolЯвляется ли параметр логическим. Логические параметры не потребляют параметр.
- $_choices protected
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, string[] $choices = [], bool $multiple = false, bool $required = false)
Создать новую опцию ввода
Параметры
string$nameПолное имя опции или массив со всеми свойствами.
string$short optionalКороткое имя-псевдоним для этой опции
string$help optionalТекст справки для этой опции
bool$isBoolean optionalЯвляется ли эта опция булевой опцией. Булевы опции не потребляют дополнительные токены
string|bool|null$default optionalЗначение по умолчанию для этой опции.
string[]$choices optionalДопустимые варианты для этой опции.
bool$multiple optionalМожет ли эта опция принимать несколько значений.
bool$required optionalЯвляется ли эта опция обязательной.
Исключения
Cake\Console\Exception\ConsoleExceptionacceptsMultiple() public
acceptsMultiple(): bool
Проверить, принимает ли эта опция несколько значений.
Возвращаемое значение
booldefaultValue() public
defaultValue(): string|bool|null
Получить значение по умолчанию для этой опции
Возвращаемое значение
string|bool|nullhelp() public
help(int $width = 0): string
Сгенерировать справку для этой опции.
Параметры
-
int$width optional Ширина для отображения имени опции.
Возвращаемое значение
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
Массив допустимых вариантов для опции.
Тип
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.2/class-Cake.Console.ConsoleInputOption.html
