Spec-Zone.ru › CakePHP 4.4

Class HelpCommand

Вывод списка команд

Пространство имен: Cake\Console\Command

Константы

  • int
    CODE_ERROR 
    1

    Значение кода ошибки по умолчанию

  • int
    CODE_SUCCESS 
    0

    Значение кода успеха по умолчанию

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

  • $commands protected
    Cake\Console\CommandCollection

    Коллекция команд для получения справки.

  • $name protected
    string

    Имя этой команды.

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

  • abort() public

    Прекратить текущий процесс с исключением StopException.

  • asText() protected

    Вывод текста.

  • asXml() protected

    Вывод в формате XML

  • buildOptionParser() protected

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

  • defaultName() public static

    Получить имя команды.

  • displayHelp() protected

    Вывод содержимого справки

  • execute() public

    Главная функция. Выводит список команд.

  • executeCommand() public

    Выполнить другую команду с заданным набором аргументов.

  • getDescription() public static

    Получить описание команды.

  • getName() public

    Получить имя команды.

  • getOptionParser() public

    Получить парсер опций.

  • getRootName() public

    Получить имя корневой команды.

  • getShortestName() protected
  • initialize() public

    Метод обратного вызова, вызываемый CakePHP, когда команда собирается быть выполнена.

  • outputPaths() protected

    Вывод соответствующих путей, если они определены

  • run() public

    Выполнить команду.

  • setCommandCollection() public

    Установить используемую коллекцию команд.

  • setName() public

    Установить имя, используемое этой командой в коллекции.

  • setOutputLevel() protected

    Установить уровень вывода на основе аргументов.

END_OF_DOCUMENT_MARKER

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

abort() public 

abort(int $code = self::CODE_ERROR): void

Прервать текущий процесс с исключением StopException.

Параметры

int $code необязательно

Код завершения.

Возвращает

void

Исключения

Cake\Console\Exception\StopException

asText() protected 

asText(Cake\Console\ConsoleIo $io, iterable $commands): void

Вывод текста.

Параметры

Cake\Console\ConsoleIo $io

Ввод-вывод консоли.

iterable $commands

Коллекция команд для вывода.

Возвращает

void

asXml() protected 

asXml(Cake\Console\ConsoleIo $io, iterable $commands): void

Вывод в формате XML.

Параметры

Cake\Console\ConsoleIo $io

Ввод-вывод консоли.

iterable $commands

Коллекция команд для вывода.

Возвращает

void

buildOptionParser() protected 

buildOptionParser(Cake\Console\ConsoleOptionParser $parser): Cake\Console\ConsoleOptionParser

Возвращает экземпляр парсера опций и настраивает его.

Параметры

Cake\Console\ConsoleOptionParser $parser

Парсер для настройки.

Возвращает

Cake\Console\ConsoleOptionParser

defaultName() public static 

defaultName(): string

Получить имя команды.

Возвращает имя команды, основанное на имени класса. Например, для команды с именем класса UpdateTableCommand возвращаемое имя будет 'update_table'.

Возвращает

string

displayHelp() protected 

displayHelp(Cake\Console\ConsoleOptionParser $parser, Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void

Вывод справки.

Параметры

Cake\Console\ConsoleOptionParser $parser

Парсер опций.

Cake\Console\Arguments $args

Аргументы команды.

Cake\Console\ConsoleIo $io

Ввод-вывод консоли.

Возвращает

void

execute() public 

execute(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): int

Главная функция. Выводит список команд.

Параметры

Cake\Console\Arguments $args

Аргументы команды.

Cake\Console\ConsoleIo $io

Ввод-вывод консоли.

Возвращает

int

executeCommand() public 

executeCommand(Cake\Console\CommandInterface|string $command, array $args = [], Cake\Console\ConsoleIo|null $io = null): int|null

Выполняет другую команду с заданным набором аргументов.

Если вы используете строковое имя команды, зависимости этой команды не будут разрешены контейнером приложения. Вместо этого вам нужно передать команду как объект со всеми ее зависимостями.

Параметры

Cake\Console\CommandInterface|string $command

Имя класса команды или экземпляр команды.

array $args необязательно

Аргументы для вызова команды.

Cake\Console\ConsoleIo|null $io необязательно

Экземпляр ConsoleIo для использования в исполняемой команде.

Возвращает

int|null

getDescription() public static 

getDescription(): string

Получить описание команды.

Возвращает

string

getName() public 

getName(): string

Получить имя команды.

Возвращает

string

getOptionParser() public 

getOptionParser(): Cake\Console\ConsoleOptionParser

Получить парсер опций.

Вы можете переопределить buildOptionParser(), чтобы определить свои опции и аргументы.

Возвращает

Cake\Console\ConsoleOptionParser

Исключения

RuntimeException
При невалидном парсере

getRootName() public 

getRootName(): string

Получить имя корневой команды.

Возвращает

string

getShortestName() protected 

getShortestName(array<string> $names): string

Параметры

array<string> $names

Имена

Возвращает

string

initialize() public 

initialize(): void

Метод-хук, вызываемый CakePHP, когда команда собирается быть выполнена.

Переопределите этот метод и реализуйте дорогостоящие/важные шаги настройки, которые не должны выполняться при каждом запуске команды. Этот метод будет вызван перед валидацией и обработкой опций и аргументов.

Возвращает

void

outputPaths() protected 

outputPaths(Cake\Console\ConsoleIo $io): void

Выводит релевантные пути, если они определены.

Параметры

Cake\Console\ConsoleIo $io

Объект ввода-вывода.

Возвращает

void

run() public 

run(array $argv, Cake\Console\ConsoleIo $io): int|null

Выполнить команду.

Параметры

array $argv
Cake\Console\ConsoleIo $io

Возвращает

int|null

setCommandCollection() public 

setCommandCollection(Cake\Console\CommandCollection $commands): void

Установить используемую коллекцию команд.

Параметры

Cake\Console\CommandCollection $commands

Возвращает

void

setName() public 

setName(string $name): $this

Установить имя, используемое этой командой в коллекции.

Обычно вызывается CommandCollection при добавлении команды. Требуется иметь хотя бы один пробел в имени, чтобы можно было вычислить корневую команду.

Параметры

string $name

Возвращает

$this

setOutputLevel() protected 

setOutputLevel(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void

Установить уровень вывода на основе аргументов.

Параметры

Cake\Console\Arguments $args

Аргументы команды.

Cake\Console\ConsoleIo $io

Ввод-вывод консоли.

Возвращает

void

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

$commands protected

Коллекция команд для получения справки.

Тип

Cake\Console\CommandCollection

$name protected

Имя этой команды.

Тип

string

© 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.Command.HelpCommand.html

Spec-Zone.ru

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