Класс CommandRunner

__construct()source public

__construct( Cake\Core\ConsoleApplicationInterface $app , string $root = 'cake' , Cake\Console\CommandFactoryInterface $factory = null )

Конструктор

Параметры

Cake\Core\ConsoleApplicationInterface $app

Приложение для запуска команд CLI.

string $root необязательно 'cake'

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

Cake\Console\CommandFactoryInterface $factory необязательно null

Экземпляр фабрики команд.

bootstrap()source protected

bootstrap( )

Обёртка для загрузки приложения.

Вызывает bootstrap() и events() если приложение реализует EventApplicationInterface. После загрузки приложения и привязки событий, плагины загружаются и к ним привязываются события.

checkCollection()source protected deprecated

checkCollection( mixed $commands , string $method )

Проверка созданной коллекции команд

Устарело

3.6.0 Этот метод следует заменить типами возвращаемых значений в 4.x

Параметры

mixed $commands

Коллекция команд для проверки, может быть чем угодно.

string $method

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

Исключения

RuntimeException

createShell()source protected

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

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

Параметры

string $className

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

Cake\Console\ConsoleIo $io

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

Возвращает

Cake\Console\Shell|Cake\Console\Command

eventManager()source public deprecated

eventManager( Cake\Event\EventManager $events = null )

Получить/установить менеджер событий приложения.

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

Устарело

3.6.0 Будет удален в 4.0

Параметры

Cake\Event\EventManager $events необязательно null

Менеджер событий для установки.

Возвращает

Cake\Event\EventManager|Cake\Console\CommandRunner
$this

Реализация

Cake\Event\EventDispatcherInterface::eventManager()

getEventManager()source public

getEventManager( )

Получить менеджер событий приложения или глобальный менеджер.

Возвращает

Cake\Event\EventManagerInterface

getShell()source protected

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

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

Параметры

Cake\Console\ConsoleIo $io

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

Cake\Console\CommandCollection $commands

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

string $name

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

Возвращает

Cake\Console\Shell|Cake\Console\Command

loadRoutes()source protected

loadRoutes( )

Убедиться, что маршруты приложения загружены.

Команды консоли и оболочки часто нуждаются в генерации URL.

resolveName()source protected

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

Разрешить имя команды на имя, которое существует в коллекции.

Применить обратную совместимость с изгибами и псевдонимами.

Параметры

Cake\Console\CommandCollection $commands

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

Cake\Console\ConsoleIo $io

Объект ConsoleIo для ошибок.

string $name

Имя из аргументов CLI.

Возвращает

string
Разрешённое имя.

run()source public

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

Запустить команду, содержащуюся в $argv.

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

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

Параметры

array $argv

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

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

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

Возвращает

integer
Код завершения команды.

Исключения

RuntimeException

runShell()source protected

runShell( Cake\Console\Shell $shell , array $argv )

Выполнить класс Shell.

Параметры

Cake\Console\Shell $shell

Запускаемый shell.

массив $argv

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

Возвращает

целое число
Код выхода

setAliases()source public

setAliases( array $aliases )

Заменить весь массив псевдонимов для исполнителя.

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

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

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

Параметры

массив $aliases

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

Возвращает

$this

setEventManager()source public

setEventManager( Cake\Event\EventManager $events )

Получение/установка менеджера событий приложения.

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

Параметры

Cake\Event\EventManager $events

Менеджер событий для установки.

Возвращает

$this

dispatchEvent()source public

dispatchEvent( string $name , array|null $data = null , object|null $subject = null )

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

Возвращает отправленное событие.

Параметры

строка $name

Имя события.

массив|null $data необязательно null

Любое значение, которое вы хотите передать вместе с этим событием, чтобы его могли прочитать слушатели.

объект|null $subject необязательно null

Объект, к которому относится это событие ($this по умолчанию).

Возвращает

Cake\Event\Event

[]