Spec-Zone.ru › CakePHP 4.2

Класс 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

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

  • 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 возвращаемое значение будет %%%CODE_BLOCK_23%%.

Возвращает

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(stringCake\Console\CommandInterface $command, array $args = [], Cake\Console\ConsoleIo $io = null): int|null

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

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

Параметры

stringCake\Console\CommandInterface $command

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

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

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

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

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

Возвращает

int|null

getName() public 

getName(): string

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

Возвращает

string

getOptionParser() public 

getOptionParser(): Cake\Console\ConsoleOptionParser

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

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

Возвращает

Cake\Console\ConsoleOptionParser

Исключения

RuntimeException
При некорректном парсере

getRootName() public 

getRootName(): string

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

Возвращает

string

getShortestName() protected 

getShortestName(string[] $names): string

Параметры

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.2/class-Cake.Console.Command.HelpCommand.html

Spec-Zone.ru

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