Spec-Zone.ru › CakePHP 4.4

Класс ConsoleInputOption

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

Пространство имён: Cake\Console
См.: \Cake\Console\ConsoleOptionParser::addOption()

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

  • $_boolean protected
    bool

    Является ли параметр логическим. Логические параметры не потребляют параметр.

  • $_choices protected
    array<string>

    Массив вариантов для параметра.

  • $_default protected
    string|bool|null

    Значение по умолчанию для параметра

  • $_help protected
    string

    Текст справки для параметра.

  • $_multiple protected
    bool

    Может ли параметр принимать несколько значений.

  • $_name protected
    string

    Имя параметра

  • $_short protected
    string

    Короткое (1 символ) псевдоним для параметра.

  • $prompt protected
    string|null

    Строка подсказки

  • $required protected
    bool

    Требуется ли параметр.

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

  • __construct() public

    Создать новую опцию ввода

  • acceptsMultiple() public

    Проверить, принимает ли эта опция несколько значений.

  • choices() public

    Получить список доступных значений для этой опции.

  • defaultValue() public

    Получить значение по умолчанию для этой опции

  • help() public

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

  • isBoolean() public

    Проверить, является ли эта опция булевой.

  • isRequired() public

    Проверить, является ли эта опция обязательной.

  • name() public

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

  • prompt() public

    Получить строку подсказки.

  • short() public

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

  • usage() public

    Получить значение использования для этой опции.

  • validChoice() public

    Проверить, является ли значение допустимым для этой опции.

  • xml() public

    Добавить XML опции в родительский элемент.

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

__construct() public 

__construct(string $name, string $short = '', string $help = '', bool $isBoolean = false, string|bool|null $default = null, array<string> $choices = [], bool $multiple = false, bool $required = false, string|null $prompt = null)

Создать новую опцию ввода

Параметры

string $name

Полное имя опции или массив со всеми свойствами.

string $short optional

Короткое имя опции

string $help optional

Текст справки для этой опции

bool $isBoolean optional

Является ли опция булевой. Булевы опции не потребляют дополнительные токены

string|bool|null $default optional

Значение по умолчанию для этой опции.

array<string> $choices optional

Допустимые значения для этой опции.

bool $multiple optional

Может ли эта опция принимать несколько значений.

bool $required optional

Является ли опция обязательной.

string|null $prompt optional

Строка подсказки.

Исключения

Cake\Console\Exception\ConsoleException

acceptsMultiple() public 

acceptsMultiple(): bool

Проверить, принимает ли эта опция несколько значений.

Возвращает

bool

choices() public 

choices(): array

Получить список доступных значений для этой опции.

Возвращает

array

defaultValue() public 

defaultValue(): string|bool|null

Получить значение по умолчанию для этой опции

Возвращает

string|bool|null

help() public 

help(int $width = 0): string

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

Параметры

int $width optional

Ширина имени опции.

Возвращает

string

isBoolean() public 

isBoolean(): bool

Проверить, является ли эта опция булевой.

Возвращает

bool

isRequired() public 

isRequired(): bool

Проверить, является ли эта опция обязательной.

Возвращает

bool

name() public 

name(): string

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

Возвращает

string

prompt() public 

prompt(): string

Получить строку подсказки.

Возвращает

string

short() public 

short(): string

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

Возвращает

string

usage() public 

usage(): string

Получить значение использования для этой опции.

Возвращает

string

validChoice() public 

validChoice(string|bool $value): true

Проверить, является ли значение допустимым для этой опции.

Параметры

string|bool $value

Значение для проверки.

Возвращает

true

Исключения

Cake\Console\Exception\ConsoleException

xml() public 

xml(SimpleXMLElement $parent): SimpleXMLElement

Добавить XML опции в родительский элемент.

Параметры

SimpleXMLElement $parent

Родительский элемент.

Возвращает

SimpleXMLElement

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

$_boolean protected

Является ли опция булевой. Булевы опции не потребляют параметр.

Тип

bool

$_choices protected

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

Тип

array<string>

$_default protected

Значение по умолчанию для опции

Тип

string|bool|null

$_help protected

Текст справки для опции.

Тип

string

$_multiple protected

Может ли опция принимать несколько значений.

Тип

bool

$_name protected

Имя опции

Тип

string

$_short protected

Короткое (1 символ) имя опции.

Тип

string

$prompt protected

Строка подсказки

Тип

string|null

$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.4/class-Cake.Console.ConsoleInputOption.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API