Spec-Zone.ru › CakePHP 3.4

Класс CommandRunner

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

Cake\Console\CommandRunner использует Cake\Event\EventManagerTrait
Пространство имён: Cake\Console
Расположение: Console/CommandRunner.php

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

  • $aliases protected
    array
    Сопоставления псевдонимов.
  • $app protected
    Cake\Core\ConsoleApplicationInterface
    Приложение, для которого выполняются команды консоли.
  • $root protected
    string
    Имя корневой команды. По умолчанию cake.

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

  • __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\Shell

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

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

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

$aliasessource

protected массив

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

[]

$appsource

protected Cake\Core\ConsoleApplicationInterface

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

$rootsource

protected строка

Имя корневой команды. По умолчанию cake.

© 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

Spec-Zone.ru

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