Класс CommandRunner

__construct()source public

__construct( Cake\Core\ConsoleApplicationInterface $app , string $root 'cake' )

Конструктор

Параметры

Cake\Core\ConsoleApplicationInterface $app

Приложение, для которого выполняются команды CLI.

строка $root необязательно 'cake'

Имя корневой команды, которое нужно удалить из argv.

createShell()source protected

createShell( string $className , Cake\Console\ConsoleIo $io )

Оборачивающий метод для создания экземпляров оболочки.

Параметры

строка $className

Имя класса оболочки.

Cake\Console\ConsoleIo $io

Обёртка IO для созданного класса оболочки.

Возвращает

Cake\Console\Shell

getShell()source protected

getShell( Cake\Console\ConsoleIo $io , Cake\Console\CommandCollection $commands , string $name )

Получение экземпляра оболочки для заданного имени команды

Параметры

Cake\Console\ConsoleIo $io

Обёртка IO для созданного класса оболочки.

Cake\Console\CommandCollection $commands

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

строка $name

Имя команды для поиска

Возвращает

Cake\Console\Shell

run()source public

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

Выполнение команды, содержащейся в $argv.

Используйте приложение для следующих действий:

• Инициализация приложения
• Создание CommandCollection с помощью хука console() приложения.
• Вызов события Console.buildCommands автоматической подгрузки плагинов.
• Выполнение запрошенной команды.

Параметры

массив $argv

Аргументы из среды CLI.

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

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

Возвращает

целое число
Код завершения команды.

Исключения

RuntimeException

setAliases()source public

setAliases( array $aliases )

Замена всего отображения псевдонимов для исполнителя.

Псевдонимы позволяют определить альтернативные имена команд в коллекции. Это может быть полезно для добавления таких верхнего уровня переключателей, как --version или -h.

Использование

$runner->setAliases(['--version' => 'version']);

Параметры

массив $aliases

Карта псевдонимов для замены.

Возвращает

$this

[]