Класс ConsoleInputArgument

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

Пакет: Cake\Console
См.: ConsoleOptionParser::addArgument()
Авторские права: Авторские права (с) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: 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 необязательно '': Текст справки для данного параметра
boolean $required необязательно false: Является ли данный аргумент обязательным. Отсутствие обязательных аргументов вызовет исключения
array $choices необязательно array(): Допустимые значения для этого параметра.

help()source public

help( integer $width 0 )

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

Параметры

integer $width необязательно 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 допустимым значением для этого аргумента.

Параметры

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

Возвращаемое значение

boolean

Исключения

ConsoleException

xml()source public

xml( SimpleXmlElement $parent )

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

Параметры

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

Возвращаемое значение

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

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

$_choicessource

protected массив

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

$_helpsource

protected строка

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

$_namesource

protected строка

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

$_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.
https://api.cakephp.org/2.9/class-ConsoleInputArgument.html