Класс ConsoleInputOption

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

Пакет: Cake\Консоль
См.: ConsoleOptionParser::addOption()
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: 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
Получение значения атрибута name.
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( )

Получение значения атрибута 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–2016 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.9/class-ConsoleInputOption.html