Класс CommandRunner
Выполняет команды CLI для предоставленного приложения.
- Cake\Console\CommandRunner использует Cake\Event\EventManagerTrait
Краткое описание свойств
-
$aliasesprotectedСопоставления псевдонимов.array - Приложение, для которого выполняются команды консоли.
$appprotected -
$rootprotectedИмя корневой команды. По умолчаниюstringcake.
Краткое описание методов
- __construct() publicКонструктор
- createShell() protectedОбертка для создания экземпляров оболочек.
- getShell() protectedПолучить экземпляр оболочки для заданного имени команды
- run() publicВыполнить команду, содержащуюся в $argv.
- setAliases() publicЗаменить весь массив псевдонимов для исполнителя.
Подробное описание методов
__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 - Обёртка ввода/вывода для созданного класса оболочки.
Возвращает
Cake\Console\ShellgetShell()source protected
getShell( Cake\Console\ConsoleIo $io , Cake\Console\CommandCollection $commands , string $name )
Получить экземпляр оболочки для заданного имени команды
Параметры
-
Cake\Console\ConsoleIo$io - Обёртка ввода/вывода для созданного класса оболочки.
-
Cake\Console\CommandCollection$commands - Коллекция команд для поиска оболочки в ней.
- строка
$name - Имя команды для поиска
Возвращает
Cake\Console\Shellrun()source public
run( array $argv , Cake\Console\ConsoleIo $io null )
Выполнить команду, содержащуюся в $argv.
Используйте приложение для следующих действий:
- Инициализировать приложение
- Создать CommandCollection, используя метод console() приложения.
- Сгенерировать событие
Console.buildCommandsавтоподключения плагинов. - Выполнить запрошенную команду.
Параметры
- массив
$argv - Аргументы из среды CLI.
-
Cake\Console\ConsoleIo$ioнеобязательно null - Экземпляр ConsoleIo. Используется в основном для тестирования.
Возвращает
целое числоКод завершения команды.
Использует
RuntimeExceptionsetAliases()source public
setAliases( array $aliases )
Заменить весь массив псевдонимов для исполнителя.
Псевдонимы позволяют определять альтернативные имена для команд в коллекции. Это может быть полезно для добавления верхнего уровня переключателей, таких как --version или -h
Использование
$runner->setAliases(['--version' => 'version']);
Параметры
- массив
$aliases - Массив псевдонимов для замены.
Возвращает
$this
Подробное описание свойств
$appsource
protected Cake\Core\ConsoleApplicationInterface
Приложение, для которого выполняются команды консоли.
© 2005–2017 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/3.4/class-Cake.Console.CommandRunner.html