Класс ConsoleInputArgument

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

Пакет: Cake\Console
См.: ConsoleOptionParser::addArgument()
Авторские права: Copyright (c) Cake Software Foundation, Inc. (https://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 допустимым выбором для этого аргумента.

Параметры

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

Возвращает

boolean

Исключения

ConsoleException

xml()source public

xml( SimpleXmlElement $parent )

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

Параметры

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

Возвращает

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

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

$_choicessource

protected массив

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

$_helpsource

protected string

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

$_namesource

protected string

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

$_requiredsource

protected boolean

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

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