Класс ConsoleInputArgument

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

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

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

$_choices protected

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

string
Строка справки
$_name protected

string
Имя аргумента.
$_required protected

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

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

__construct() public
Создать новый аргумент ввода
help() public
Сгенерировать справку по этому аргументу.
isRequired() public
Проверить, является ли этот аргумент обязательным
name() public
Получить значение атрибута name.
usage() public
Получить значение использования для этого аргумента
validChoice() public
Проверить, является ли $value допустимым значением для этого аргумента.
xml() public
Добавить XML-представление этого аргумента в переданный объект SimpleXml.

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

__construct()source public

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

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

Параметры

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

help()source public

help( integer $width 0 )

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

Параметры

integer $width optional 0: Ширина имени параметра.

Возвращает

string

isRequired()source public

isRequired( )

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

Возвращает

boolean

name()source public

name( )

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

Возвращает

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

usage()source public

usage( )

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

Возвращает

string

validChoice()source public

validChoice( string $value )

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

Параметры

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

Возвращает

boolean

Исключения

ConsoleException

xml()source public

xml( SimpleXmlElement $parent )

Добавление XML-представления данного аргумента к переданному объекту SimpleXml.

Параметры

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

Возвращает

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

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

$_choicessource

protected массив

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

$_helpsource

protected строка

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

$_namesource

protected строка

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

$_requiredsource

protected логическое

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

© 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.8/class-ConsoleInputArgument.html