Класс ConsoleInputOption

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

Пакет: Cake\Console
См.: ConsoleOptionParser::addOption()
Авторские права: Авторские права (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Console/ConsoleInputOption.php

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

$_boolean protected

boolean
Является ли параметр логическим. Логические параметры не потребляют параметр.
$_choices protected

array
Массив вариантов для параметра.
$_default protected

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

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

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

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

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

__construct() public
Создать новый параметр ввода
defaultValue() public
Получить значение по умолчанию для этого параметра
help() public
Сгенерировать справку для этого параметра.
isBoolean() public
Проверить, является ли этот параметр логическим
name() public
Получить значение атрибута имени.
short() public
Получить значение атрибута short.
usage() public
Получить значение использования для этого параметра
validChoice() public
Проверить, является ли значение допустимым вариантом для этого параметра.
xml() public
Добавить xml параметра в родителя.

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

__construct()source public

__construct( string|array $name , string $short null , string $help '' , boolean $boolean false , string $default '' , array $choices array() )

Создать новый параметр ввода

Параметры

string|array $name: Полное имя параметра или массив со всеми свойствами.
string $short optional null: Короткое обозначение для этого параметра
string $help optional '': Текст справки для этого параметра
boolean $boolean optional false: Является ли этот параметр логическим. Логические параметры не потребляют дополнительные токены
string $default optional '': Значение по умолчанию для этого параметра.
array $choices optional array(): Допустимые значения для этого параметра.

Исключения

ConsoleException

defaultValue()source public

defaultValue( )

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

Возвращает

mixed

help()source public

help( integer $width 0 )

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

Параметры

integer $width optional 0: Ширина, для отображения имени параметра.

Возвращает

string

isBoolean()source public

isBoolean( )

Проверить, является ли этот параметр логическим

Возвращает

boolean

name()source public

name( )

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

Возвращает

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

short()source public

short( )

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

Возвращает

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

usage()source public

usage( )

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

Возвращает

string

validChoice()source public

validChoice( string $value )

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

Параметры

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

Возвращает

boolean

Исключения

ConsoleException

xml()source public

xml( SimpleXmlElement $parent )

Добавить xml параметра в родителя.

Параметры

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

Возвращает

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

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

$_booleansource

protected boolean

Является ли параметр логическим. Логические параметры не потребляют параметр.

$_choicessource

protected array

Массив вариантов для параметра.

$_defaultsource

protected mixed

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

$_helpsource

protected string

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

$_namesource

protected string

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

$_shortsource

protected string

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

© 2005–2017 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/2.10/class-ConsoleInputOption.html