Класс ConsoleInputArgument
Объект для представления одного аргумента, используемого в командной строке. ConsoleOptionParser создает их при использовании addArgument()
См.: \Cake\Console\ConsoleOptionParser::addArgument()
Расположение: Console/ConsoleInputArgument.php
Краткое описание свойств
-
$_choicesprotectedМассив допустимых вариантов для этого аргумента.array -
$_helpprotectedСтрока справкиstring -
$_nameprotectedИмя аргумента.string -
$_requiredprotectedТребуется ли этот параметр?boolean
Краткое описание методов
- __construct() publicСоздать новый аргумент ввода
- help() publicГенерирует справку для этого аргумента.
- isEqualTo() publicПроверяет, равен ли этот аргумент другому аргументу.
- isRequired() publicПроверка, является ли этот аргумент обязательным
- name() publicПолучить значение атрибута имени.
- usage() publicПолучить значение использования для этого аргумента
- validChoice() publicПроверить, является ли $value допустимым вариантом для этого аргумента.
- xml() publicДобавить XML-представление этого аргумента в переданный объект SimpleXml.
Подробное описание методов
__construct()source public
__construct( string|array $name , string $help = '' , boolean $required = false , array $choices = [] )
Создать новый аргумент ввода
Параметры
- string|array
$name - Полное имя параметра или массив со всеми свойствами.
- string
$helpoptional '' - Текст справки для этого параметра
- boolean
$requiredoptional false - Является ли этот аргумент обязательным. Отсутствие обязательных аргументов приведет к исключениям
- array
$choicesoptional [] - Допустимые варианты для этого параметра.
help()source public
help( integer $width = 0 )
Генерирует справку для этого аргумента.
Параметры
- integer
$widthoptional 0 - Ширина для отображения имени параметра.
Возвращаемое значение
stringisEqualTo()source public
isEqualTo( Cake\Console\ConsoleInputArgument $argument )
Проверяет, равен ли этот аргумент другому аргументу.
Параметры
-
Cake\Console\ConsoleInputArgument$argument - ConsoleInputArgument для сравнения.
Возвращаемое значение
booleanisRequired()source public
isRequired( )
Проверка, является ли этот аргумент обязательным
Возвращаемое значение
booleanname()source public
name( )
Получить значение атрибута имени.
Возвращаемое значение
stringЗначение этого->_name.
usage()source public
usage( )
Получить значение использования для этого аргумента
Возвращаемое значение
stringvalidChoice()source public
validChoice( string $value )
Проверить, является ли $value допустимым вариантом для этого аргумента.
Параметры
- string
$value - Вариант для проверки.
Возвращаемое значение
booleanИсключения
Cake\Console\Exception\ConsoleExceptionxml()source public
xml( SimpleXMLElement $parent )
Добавить XML-представление этого аргумента в переданный объект SimpleXml.
Параметры
- SimpleXMLElement
$parent - Родительский элемент.
Возвращаемое значение
SimpleXMLElementРодительский элемент с добавленным аргументом.
Подробное описание свойств
© 2005–present 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/3.7/class-Cake.Console.ConsoleInputArgument.html
