Класс ConsoleInputOption
Объект для представления одного параметра, используемого в командной строке. ConsoleOptionParser создаёт их при использовании addOption()
См.: \Cake\Console\ConsoleOptionParser::addOption()
Расположение: Console/ConsoleInputOption.php
Краткое описание свойств
-
$_booleanprotectedЯвляется ли параметр булевым. Булевые параметры не потребляют параметр.boolean -
$_choicesprotectedМассив вариантов для параметра.array -
$_defaultprotectedЗначение по умолчанию для параметраmixed -
$_helpprotectedТекст справки для параметра.string -
$_multipleprotectedМожет ли параметр принимать несколько значений.boolean -
$_nameprotectedИмя параметраstring -
$_shortprotectedКороткое (1 символ) псевдоним для параметра.string
Краткое описание методов
- __construct() publicСоздать новый параметр ввода
- acceptsMultiple() publicПроверить, принимает ли данный параметр несколько значений.
- defaultValue() publicПолучить значение по умолчанию для данного параметра
- help() publicСгенерировать справку для данного параметра.
- isBoolean() publicПроверить, является ли данный параметр булевым.
- name() publicПолучить значение атрибута name.
- short() publicПолучить значение атрибута short.
- usage() publicПолучить значение использования для данного параметра
- validChoice() publicПроверить, является ли значение допустимым выбором для данного параметра.
- xml() publicДобавить xml параметра в родительский элемент.
Подробное описание методов
__construct()source public
__construct( string|array $name , string $short = '' , string $help = '' , boolean $boolean = false , string $default = '' , array $choices = [] , boolean $multiple = false )
Создать новый параметр ввода
Параметры
- string|array
$name - Полное имя параметра или массив со всеми свойствами.
- string
$shortoptional '' - Короткий псевдоним для этого параметра
- string
$helpoptional '' - Текст справки для этого параметра
- boolean
$booleanoptional false - Является ли этот параметр булевым. Булевые параметры не потребляют дополнительные токены
- string
$defaultoptional '' - Значение по умолчанию для этого параметра.
- array
$choicesoptional [] - Допустимые варианты для этого параметра.
- boolean
$multipleoptional false - Может ли этот параметр принимать несколько значений.
Исключения
Cake\Console\Exception\ConsoleExceptionacceptsMultiple()source public
acceptsMultiple( )
Проверить, принимает ли данный параметр несколько значений.
Возвращает
booleandefaultValue()source public
defaultValue( )
Получить значение по умолчанию для этого параметра
Возвращает
mixedhelp()source public
help( integer $width = 0 )
Сгенерировать справку для этого параметра.
Параметры
- integer
$widthнеобязательный 0 - Ширина, чтобы задать имя параметра.
Возвращает
stringisBoolean()source public
isBoolean( )
Проверить, является ли этот параметр логическим
Возвращает
booleanname()source public
name( )
Получить значение атрибута имени.
Возвращает
stringЗначение this->_name.
short()source public
short( )
Получить значение атрибута короткого имени.
Возвращает
stringЗначение this->_short.
validChoice()source public
validChoice( string $value )
Проверить, является ли значение допустимым вариантом для этого параметра.
Параметры
- string
$value - Вариант для проверки.
Возвращает
booleanИсключения
Cake\Console\Exception\ConsoleExceptionxml()source public
xml( SimpleXMLElement $parent )
Добавить XML параметра в родительский элемент.
Параметры
- SimpleXMLElement
$parent - Родительский элемент.
Возвращает
SimpleXMLElementРодительский элемент с добавленным параметром.
Подробное описание свойств
$_booleansource
protected boolean
Является ли параметр логическим. Логические параметры не потребляют параметр.
© 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/3.8/class-Cake.Console.ConsoleInputOption.html
