Класс ShellDispatcher

__construct()source public

__construct( array $args [] , boolean $bootstrap true )

Конструктор

Выполнение скрипта останавливается после отправки запроса со кодом состояния 0 или 1 в соответствии с результатом отправки.

Параметры

массив $args необязательно []

argv из PHP

булево $bootstrap необязательно true

Нужно ли инициализировать среду?

_bootstrap()source protected

_bootstrap( )

Инициализирует среду и загружает ядро CakePHP.

Возвращает

boolean
Успех.

_createShell()source protected

_createShell( string $className , string $shortName )

Создаёт указанную оболочку и устанавливает свойство плагина

Параметры

строка $className

Имя класса для создания экземпляра

строка $shortName

Имя оболочки с префиксом плагина

Возвращает

Cake\Console\Shell
Экземпляр оболочки.

_dispatch()source protected

_dispatch( array $extra [] )

Отправить запрос.

Параметры

массив $extra необязательно []

Дополнительные параметры, которые можно вручную передать в оболочку для отправки. Встроенный дополнительный параметр: - requested : если используется, предотвратит отображение приветственного сообщения оболочки

Возвращает

boolean

Выбрасывает

Cake\Console\Exception\MissingShellMethodException

_handleAlias()source protected

_handleAlias( string $shell )

Если вход соответствует псевдониму, возвращает имя оболочки с псевдонимом

Параметры

строка $shell

Необязательно имя плагина или псевдонима

Возвращает

строка
Имя оболочки с префиксом плагина

_initEnvironment()source protected

_initEnvironment( )

Определяет текущую рабочую среду.

Выбрасывает

Cake\Core\Exception\Exception

_shellExists()source protected

_shellExists( string $shell )

Проверяет, существует ли класс оболочки для данного имени.

Параметры

строка $shell

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

Возвращает

строка|boolean
Имя класса или false.

addShortPluginAliases()source public

addShortPluginAliases( )

Для всех загруженных плагинов добавляет короткий псевдоним

Это позволяет получить доступ к плагину, реализующему оболочку с тем же именем, используя только имя оболочки

Возвращает

массив
результирующий список псевдонимов

alias()source public static

alias( string $short , string|null $original null )

Добавляет псевдоним для команды оболочки.

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

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

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

Создание псевдонима для оболочки с именем ClassName:

$this->alias('alias', 'ClassName');

Получение оригинального имени для заданного псевдонима:

$this->alias('alias');

Параметры

строка $short

Новое короткое имя для оболочки.

строка|null $original необязательно null

Оригинальное полное имя оболочки.

Возвращает

строка|false
Имя алиасового класса или false, если псевдоним не существует

dispatch()source public

dispatch( array $extra [] )

Отправляет запрос CLI

Преобразует результат команды оболочки в код выхода. Null/True обрабатываются как успех. Все другие возвращаемые значения являются ошибкой.

Параметры

массив $extra необязательно []

Дополнительные параметры, которые можно вручную передать в оболочку для отправки. Встроенный дополнительный параметр: - requested : если используется, предотвратит отображение приветственного сообщения оболочки

Возвращает

целое число
Код выхода команды cli. 0 - успех.

findShell()source public

findShell( string $shell )

Получить оболочку для использования, либо плагин-оболочку, либо оболочку приложения

Все пути в загруженных путях оболочки проверяются, обработка перенаправлений псевдонимов

Параметры

строка $shell

Необязательно имя плагина

Возвращает

Cake\Console\Shell
Экземпляр оболочки.

Выбрасывает

Cake\Console\Exception\MissingShellException
при возникновении ошибок.

help()source public

help( )

Отображает справку консоли. Выполняет внутреннее распределение для оболочки CommandList

resetAliases()source public static

resetAliases( )

Очистить любые установленные псевдонимы.

run()source public static

run( array $argv , array $extra [] )

Запустить диспетчер

Параметры

массив $argv

argv из PHP

массив $extra необязательно []

Дополнительные параметры

Возвращает

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

shiftArgs()source public

shiftArgs( )

Удаляет первый аргумент и сдвигает другие аргументы вверх

Возвращает

смешанное
Null, если нет аргументов, в противном случае сдвинутый аргумент

version()source public

version( )

Выводит текущую установленную версию CakePHP. Выполняет внутреннее распределение для оболочки CommandList

[]

[]