Класс ConsoleInputArgument

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

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

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

__constructsource public

__construct( string|array $name , string $help '' , boolean $required false , array $choices array() )

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

Параметры

string|array $name: Полное имя опции или массив со всеми свойствами.
string $help необязательно '': Текст справки для этой опции
boolean $required необязательно false: Является ли этот аргумент обязательным. Отсутствие обязательных аргументов приведет к исключениям
array $choices необязательно array(): Допустимые значения для этой опции.

helpsource public

help( integer $width 0 )

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

Параметры

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

Возвращает

string
string

isRequiredsource public

isRequired( )

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

Возвращает

boolean
bool

namesource public

name( )

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

Возвращает

string
Значение этого->_name.

usagesource public

usage( )

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

Возвращает

string
string

validChoicesource public

validChoice( string $value )

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

Параметры

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

Возвращает

boolean
bool

Исключения

ConsoleException
ConsoleException

xmlsource public

xml( SimpleXmlElement $parent )

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

Параметры

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

Возвращает

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

Резюме свойств

$_choicessource

protected array

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

$_helpsource

protected string

Строка справки

$_namesource

protected string

Имя аргумента.

$_requiredsource

protected boolean

Требуется ли эта опция?

© 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.
http://api.cakephp.org/2.7/class-ConsoleInputArgument.html