Spec-Zone.ru › CakePHP 4.3

Интерфейс CommandInterface

Описание интерфейса между командой и окружающими библиотеками консоли.

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

Константы

  • int
    CODE_ERROR
    1

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

  • int
    CODE_SUCCESS
    0

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

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

  • run() public

    Выполнение команды.

  • setName() public

    Установить имя команды в коллекции.

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

run() public

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

Выполнение команды.

Параметры

array $argv

Аргументы из среды командной строки.

Cake\Console\ConsoleIo $io

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

Возвращает

int|null

setName() public

setName(string $name): $this

Установить имя команды в коллекции.

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

Параметры

string $name

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

Возвращает

$this

Исключения

InvalidArgumentException

© 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/interface-Cake.Console.CommandInterface.html

Spec-Zone.ru

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