Класс ConsoleInputOption

Объект для представления одного параметра, используемого в командной строке. ConsoleOptionParser создает их при использовании addOption()

Пространство имен: Cake\Console
См.: \Cake\Console\ConsoleOptionParser::addOption()
Расположение: Console/ConsoleInputOption.php

Краткое описание свойств

$_boolean protected

boolean
Является ли параметр булевым. Булевые параметры не потребляют параметр.
$_choices protected

array
Массив возможных значений для параметра.
$_default protected

mixed
Значение по умолчанию для параметра
$_help protected

string
Текст справки для параметра.
$_multiple protected

boolean
Может ли параметр принимать несколько значений.
$_name protected

string
Имя параметра
$_short protected

string
Короткое (1 символ) псевдоним для параметра.

Краткое описание методов

__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 $short необязательно '': Короткое обозначение для этого параметра
string $help необязательно '': Текст справки для этого параметра
boolean $boolean необязательно false: Булевый параметр. Булевые параметры не потребляют дополнительные токены
string $default необязательно '': Значение по умолчанию для этого параметра.
array $choices необязательно []: Допустимые значения для этого параметра.
boolean $multiple необязательно false: Принимает ли параметр несколько значений.

Исключения

Cake\Console\Exception\ConsoleException

acceptsMultiple()source public

acceptsMultiple( )

Проверить, принимает ли этот параметр несколько значений.

Возвращает

boolean

defaultValue()source public

defaultValue( )

Получить значение по умолчанию для этого параметра

Возвращает

mixed

help()source public

help( integer $width = 0 )

Сгенерировать справку для этого параметра.

Параметры

integer $width необязательно 0: Ширина имени параметра.

Возвращает

string

isBoolean()source public

isBoolean( )

Проверить, является ли этот параметр булевым

Возвращает

boolean

name()source public

name( )

Получить значение атрибута имени.

Возвращает

string
Значение this->_name.

short()source public

short( )

Получить значение атрибута короткого имени.

Возвращает

string
Значение this->_short.

usage()source public

usage( )

Получить значение использования для этого параметра

Возвращает

string

validChoice()source public

validChoice( string $value )

Проверить, является ли значение допустимым выбором для этого параметра.

Параметры

string $value: Значение для проверки.

Возвращает

boolean

Исключения

Cake\Console\Exception\ConsoleException

xml()source public

xml( SimpleXMLElement $parent )

Добавить XML параметра в родительский элемент.

Параметры

SimpleXMLElement $parent: Родительский элемент.

Возвращает

SimpleXMLElement
Родительский элемент с добавленным параметром.

Подробное описание свойств

$_booleansource

protected boolean

Является ли параметр булевым. Булевые параметры не потребляют параметр.

$_choicessource

protected array

Массив возможных значений для параметра.

$_defaultsource

protected mixed

Значение по умолчанию для параметра

$_helpsource

protected string

Текст справки для параметра.

$_multiplesource

protected boolean

Может ли параметр принимать несколько значений.

$_namesource

protected string

Имя параметра

END_OF_DOCUMENT_MARKER

$_shortsource

protected string

Короткое (1 символ) псевдоним для опции.

© 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.7/class-Cake.Console.ConsoleInputOption.html