Класс ConsoleInputArgument
Объект для представления одного аргумента, используемого в командной строке. ConsoleOptionParser создаёт их при использовании addArgument()
Краткое описание свойств
- $_choices protected
string[]Массив допустимых вариантов для этого аргумента.
- $_help protected
stringСтрока справки
- $_name protected
stringИмя аргумента.
- $_required protected
boolТребуется ли этот параметр?
Краткое описание методов
-
__construct() public
Создать новый аргумент ввода
-
help() public
Сгенерировать справку по этому аргументу.
-
isEqualTo() public
Проверяет, равен ли этот аргумент другому аргументу.
-
isRequired() public
Проверить, является ли этот аргумент обязательным.
-
name() public
Получить значение атрибута имени.
-
usage() public
Получить значение использования для этого аргумента
-
validChoice() public
Проверить, является ли $value допустимым вариантом для этого аргумента.
-
xml() public
Добавить XML-представление этого аргумента к переданному объекту SimpleXml.
Подробное описание методов
__construct() public
__construct(string|array $name, string $help = '', bool $required = false, string[] $choices = [])
Создать новый аргумент ввода
Параметры
-
string|array$name Полное имя параметра или массив со всеми свойствами.
-
string$help необязательно Текст справки для этого параметра
-
bool$required необязательно Является ли этот аргумент обязательным. Отсутствие обязательных аргументов вызовет исключение
-
string[]$choices необязательно Допустимые значения для этого параметра.
help() public
help(int $width = 0): string
Сгенерировать справку по этому аргументу.
Параметры
-
int$width необязательно Ширина, для отображения имени параметра.
Возвращает
stringisEqualTo() public
isEqualTo(Cake\Console\ConsoleInputArgument $argument): bool
Проверяет, равен ли этот аргумент другому аргументу.
Параметры
-
Cake\Console\ConsoleInputArgument$argument ConsoleInputArgument для сравнения.
Возвращает
boolisRequired() public
isRequired(): bool
Проверить, является ли этот аргумент обязательным
Возвращает
boolname() public
name(): string
Получить значение атрибута имени.
Возвращает
stringusage() public
usage(): string
Получить значение использования для этого аргумента
Возвращает
stringvalidChoice() public
validChoice(string $value): true
Проверить, является ли $value допустимым вариантом для этого аргумента.
Параметры
-
string$value Вариант для проверки.
Возвращает
trueИсключения
Cake\Console\Exception\ConsoleExceptionxml() public
xml(SimpleXMLElement $parent): SimpleXMLElement
Добавить XML-представление этого аргумента к переданному объекту SimpleXml.
Параметры
-
SimpleXMLElement$parent Элемент родитель.
Возвращает
SimpleXMLElementПодробное описание свойств
$_choices protected
Массив допустимых вариантов для этого аргумента.
Тип
string[]$_help protected
Строка справки
Тип
string$_name protected
Имя аргумента.
Тип
string$_required protected
Является ли этот параметр обязательным?
Тип
bool
© 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/4.2/class-Cake.Console.ConsoleInputArgument.html
