Класс CommandRunner

__construct()source public

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

Конструктор

Параметры

Cake\Core\ConsoleApplicationInterface $app

Приложение для выполнения команд CLI.

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

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

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

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

bootstrap()source protected

bootstrap( )

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

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

checkCollection()source protected deprecated

checkCollection( mixed $commands , string $method )

Проверка созданной CommandCollection

Устарело

3.6.0 Этот метод должен быть заменён на возвращаемые типы в 4.x

Параметры

смешанный $commands

CommandCollection для проверки, хотя это может быть что угодно.

строка $method

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

Выбрасывает

RuntimeException

createShell()source protected

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

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

Параметры

строка $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

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

строка $name

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

Возвращает

Cake\Console\Shell|Cake\Console\Command

loadRoutes()source protected

loadRoutes( )

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

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

longestCommandName()source protected

longestCommandName( Cake\Console\CommandCollection $commands , array $argv )

Построение самого длинного имени команды, которое существует в коллекции

Построение самого длинного имени команды, которое соответствует определённой команде. Это будет проходить по максимуму 3 токенам.

Параметры

Cake\Console\CommandCollection $commands

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

массив $argv

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

Возвращает

массив
Массив разрешённого имени и изменённого argv.

resolveName()source protected

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

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

Применение обратной совместимости с наклонами и псевдонимами. Будет переходить вперёд до 3 токенов в $argv для генерации имени команды в CommandCollection. Более конкретные имена команд имеют приоритет над менее конкретными.

Параметры

Cake\Console\CommandCollection $commands

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

Cake\Console\ConsoleIo $io

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

строка $name

Имя

Возвращает

строка
Разрешённое имя класса

run()source public

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

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

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

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

Параметры

массив $argv

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

Cake\Console\ConsoleIo $io дополнительно null

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

Возвращаемое значение

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

Исключения

RuntimeException

runCommand()source protected

runCommand( Cake\Console\Command $command , array $argv , Cake\Console\ConsoleIo $io )

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

Параметры

Cake\Console\Command $command

Команда для выполнения.

массив $argv

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

Cake\Console\ConsoleIo $io

объект консольного ввода-вывода

Возвращаемое значение

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

runShell()source protected

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

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

Параметры

Cake\Console\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

[]