Класс 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Получает значение атрибута имени.
- short() publicПолучает значение атрибута короткого имени.
- 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
$widthoptional 0 - Ширина для отображения имени параметра.
Возвращаемое значение
stringisBoolean()source public
isBoolean( )
Проверка, является ли данный параметр логическим.
Возвращает
booleanname()source public
name( )
Получение значения атрибута name.
Возвращает
stringЗначение this->_name.
short()source public
short( )
Получение значения атрибута short.
Возвращает
stringЗначение this->_short.
usage()source public
usage( )
Получение значения использования для данного параметра.
Возвращает
stringvalidChoice()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.6/class-Cake.Console.ConsoleInputOption.html
